alloydbdata

package
v0.8.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 29, 2024 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Overview

Package alloydbdata provides AlloyDB for PostgreSQL type definitions for CloudEvent data payloads.

Supported CloudEvent Types

  • google.cloud.alloydb.cluster.v1.created
  • google.cloud.alloydb.cluster.v1.updated
  • google.cloud.alloydb.cluster.v1.deleted
  • google.cloud.alloydb.instance.v1.created
  • google.cloud.alloydb.instance.v1.updated
  • google.cloud.alloydb.instance.v1.deleted
  • google.cloud.alloydb.backup.v1.created
  • google.cloud.alloydb.backup.v1.updated
  • google.cloud.alloydb.backup.v1.deleted

Index

Constants

This section is empty.

Variables

View Source
var (
	DatabaseVersion_name = map[int32]string{
		0: "DATABASE_VERSION_UNSPECIFIED",
		1: "POSTGRES_13",
		2: "POSTGRES_14",
	}
	DatabaseVersion_value = map[string]int32{
		"DATABASE_VERSION_UNSPECIFIED": 0,
		"POSTGRES_13":                  1,
		"POSTGRES_14":                  2,
	}
)

Enum value maps for DatabaseVersion.

View Source
var (
	MigrationSource_MigrationSourceType_name = map[int32]string{
		0: "MIGRATION_SOURCE_TYPE_UNSPECIFIED",
		1: "DMS",
	}
	MigrationSource_MigrationSourceType_value = map[string]int32{
		"MIGRATION_SOURCE_TYPE_UNSPECIFIED": 0,
		"DMS":                               1,
	}
)

Enum value maps for MigrationSource_MigrationSourceType.

View Source
var (
	EncryptionInfo_Type_name = map[int32]string{
		0: "TYPE_UNSPECIFIED",
		1: "GOOGLE_DEFAULT_ENCRYPTION",
		2: "CUSTOMER_MANAGED_ENCRYPTION",
	}
	EncryptionInfo_Type_value = map[string]int32{
		"TYPE_UNSPECIFIED":            0,
		"GOOGLE_DEFAULT_ENCRYPTION":   1,
		"CUSTOMER_MANAGED_ENCRYPTION": 2,
	}
)

Enum value maps for EncryptionInfo_Type.

View Source
var (
	SslConfig_SslMode_name = map[int32]string{
		0: "SSL_MODE_UNSPECIFIED",
		1: "SSL_MODE_ALLOW",
		2: "SSL_MODE_REQUIRE",
		3: "SSL_MODE_VERIFY_CA",
	}
	SslConfig_SslMode_value = map[string]int32{
		"SSL_MODE_UNSPECIFIED": 0,
		"SSL_MODE_ALLOW":       1,
		"SSL_MODE_REQUIRE":     2,
		"SSL_MODE_VERIFY_CA":   3,
	}
)

Enum value maps for SslConfig_SslMode.

View Source
var (
	SslConfig_CaSource_name = map[int32]string{
		0: "CA_SOURCE_UNSPECIFIED",
		1: "CA_SOURCE_MANAGED",
	}
	SslConfig_CaSource_value = map[string]int32{
		"CA_SOURCE_UNSPECIFIED": 0,
		"CA_SOURCE_MANAGED":     1,
	}
)

Enum value maps for SslConfig_CaSource.

View Source
var (
	Cluster_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "READY",
		2: "STOPPED",
		3: "EMPTY",
		4: "CREATING",
		5: "DELETING",
		6: "FAILED",
		7: "BOOTSTRAPPING",
		8: "MAINTENANCE",
		9: "PROMOTING",
	}
	Cluster_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"READY":             1,
		"STOPPED":           2,
		"EMPTY":             3,
		"CREATING":          4,
		"DELETING":          5,
		"FAILED":            6,
		"BOOTSTRAPPING":     7,
		"MAINTENANCE":       8,
		"PROMOTING":         9,
	}
)

Enum value maps for Cluster_State.

View Source
var (
	Cluster_ClusterType_name = map[int32]string{
		0: "CLUSTER_TYPE_UNSPECIFIED",
		1: "PRIMARY",
		2: "SECONDARY",
	}
	Cluster_ClusterType_value = map[string]int32{
		"CLUSTER_TYPE_UNSPECIFIED": 0,
		"PRIMARY":                  1,
		"SECONDARY":                2,
	}
)

Enum value maps for Cluster_ClusterType.

View Source
var (
	Instance_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "READY",
		2: "STOPPED",
		3: "CREATING",
		4: "DELETING",
		5: "MAINTENANCE",
		6: "FAILED",
		8: "BOOTSTRAPPING",
		9: "PROMOTING",
	}
	Instance_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"READY":             1,
		"STOPPED":           2,
		"CREATING":          3,
		"DELETING":          4,
		"MAINTENANCE":       5,
		"FAILED":            6,
		"BOOTSTRAPPING":     8,
		"PROMOTING":         9,
	}
)

Enum value maps for Instance_State.

View Source
var (
	Instance_InstanceType_name = map[int32]string{
		0: "INSTANCE_TYPE_UNSPECIFIED",
		1: "PRIMARY",
		2: "READ_POOL",
		3: "SECONDARY",
	}
	Instance_InstanceType_value = map[string]int32{
		"INSTANCE_TYPE_UNSPECIFIED": 0,
		"PRIMARY":                   1,
		"READ_POOL":                 2,
		"SECONDARY":                 3,
	}
)

Enum value maps for Instance_InstanceType.

View Source
var (
	Instance_AvailabilityType_name = map[int32]string{
		0: "AVAILABILITY_TYPE_UNSPECIFIED",
		1: "ZONAL",
		2: "REGIONAL",
	}
	Instance_AvailabilityType_value = map[string]int32{
		"AVAILABILITY_TYPE_UNSPECIFIED": 0,
		"ZONAL":                         1,
		"REGIONAL":                      2,
	}
)

Enum value maps for Instance_AvailabilityType.

View Source
var (
	Backup_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "READY",
		2: "CREATING",
		3: "FAILED",
		4: "DELETING",
	}
	Backup_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"READY":             1,
		"CREATING":          2,
		"FAILED":            3,
		"DELETING":          4,
	}
)

Enum value maps for Backup_State.

View Source
var (
	Backup_Type_name = map[int32]string{
		0: "TYPE_UNSPECIFIED",
		1: "ON_DEMAND",
		2: "AUTOMATED",
		3: "CONTINUOUS",
	}
	Backup_Type_value = map[string]int32{
		"TYPE_UNSPECIFIED": 0,
		"ON_DEMAND":        1,
		"AUTOMATED":        2,
		"CONTINUOUS":       3,
	}
)

Enum value maps for Backup_Type.

View Source
var File_cloud_alloydb_v1_data_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type AutomatedBackupPolicy

type AutomatedBackupPolicy struct {

	// The schedule for this automated backup policy.
	//
	// A schedule specifies times at which to start a backup. If a backup
	// window is also provided, the backup is guaranteed to be started and
	// completed within the start time plus the backup window. If the backup is
	// not completed within the backup window it is marked as failed.
	//
	// If not set, the schedule defaults to a weekly schedule with one backup
	// per day and a start time chosen arbitrarily.
	//
	// Types that are assignable to Schedule:
	//
	//	*AutomatedBackupPolicy_WeeklySchedule_
	Schedule isAutomatedBackupPolicy_Schedule `protobuf_oneof:"schedule"`
	// The retention policy for automated backups.
	//
	// The retention policy for a backup is fixed at the time the backup is
	// created. Changes to this field only apply to new backups taken with the
	// policy; the retentions of existing backups remain unchanged.
	//
	// If no retention policy is set, a default of 14 days is used.
	//
	// Types that are assignable to Retention:
	//
	//	*AutomatedBackupPolicy_TimeBasedRetention_
	//	*AutomatedBackupPolicy_QuantityBasedRetention_
	Retention isAutomatedBackupPolicy_Retention `protobuf_oneof:"retention"`
	// Whether automated automated backups are enabled. If not set, defaults to
	// true.
	Enabled *bool `protobuf:"varint,1,opt,name=enabled,proto3,oneof" json:"enabled,omitempty"`
	// The length of the time window during which a backup can be
	// taken. If a backup does not succeed within this time window, it will be
	// canceled and considered failed.
	//
	// The backup window must be at least 5 minutes long. There is no upper bound
	// on the window. If not set, it defaults to 1 hour.
	BackupWindow *durationpb.Duration `protobuf:"bytes,3,opt,name=backup_window,json=backupWindow,proto3" json:"backup_window,omitempty"`
	// Optional. The encryption config can be specified to encrypt the
	// backups with a customer-managed encryption key (CMEK). When this field is
	// not specified, the backup will then use default encryption scheme to
	// protect the user data.
	EncryptionConfig *EncryptionConfig `protobuf:"bytes,8,opt,name=encryption_config,json=encryptionConfig,proto3" json:"encryption_config,omitempty"`
	// The location where the backup will be stored. Currently, the only supported
	// option is to store the backup in the same region as the cluster.
	//
	// If empty, defaults to the region of the cluster.
	Location string `protobuf:"bytes,6,opt,name=location,proto3" json:"location,omitempty"`
	// Labels to apply to backups created using this configuration.
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

Message describing the user-specified automated backup policy.

All fields in the automated backup policy are optional. Defaults for each field are provided if they are not set.

func (*AutomatedBackupPolicy) Descriptor deprecated

func (*AutomatedBackupPolicy) Descriptor() ([]byte, []int)

Deprecated: Use AutomatedBackupPolicy.ProtoReflect.Descriptor instead.

func (*AutomatedBackupPolicy) GetBackupWindow

func (x *AutomatedBackupPolicy) GetBackupWindow() *durationpb.Duration

func (*AutomatedBackupPolicy) GetEnabled

func (x *AutomatedBackupPolicy) GetEnabled() bool

func (*AutomatedBackupPolicy) GetEncryptionConfig

func (x *AutomatedBackupPolicy) GetEncryptionConfig() *EncryptionConfig

func (*AutomatedBackupPolicy) GetLabels

func (x *AutomatedBackupPolicy) GetLabels() map[string]string

func (*AutomatedBackupPolicy) GetLocation

func (x *AutomatedBackupPolicy) GetLocation() string

func (*AutomatedBackupPolicy) GetQuantityBasedRetention

func (*AutomatedBackupPolicy) GetRetention

func (m *AutomatedBackupPolicy) GetRetention() isAutomatedBackupPolicy_Retention

func (*AutomatedBackupPolicy) GetSchedule

func (m *AutomatedBackupPolicy) GetSchedule() isAutomatedBackupPolicy_Schedule

func (*AutomatedBackupPolicy) GetTimeBasedRetention

func (*AutomatedBackupPolicy) GetWeeklySchedule

func (*AutomatedBackupPolicy) ProtoMessage

func (*AutomatedBackupPolicy) ProtoMessage()

func (*AutomatedBackupPolicy) ProtoReflect

func (x *AutomatedBackupPolicy) ProtoReflect() protoreflect.Message

func (*AutomatedBackupPolicy) Reset

func (x *AutomatedBackupPolicy) Reset()

func (*AutomatedBackupPolicy) String

func (x *AutomatedBackupPolicy) String() string

type AutomatedBackupPolicy_QuantityBasedRetention

type AutomatedBackupPolicy_QuantityBasedRetention struct {

	// The number of backups to retain.
	Count int32 `protobuf:"varint,1,opt,name=count,proto3" json:"count,omitempty"`
	// contains filtered or unexported fields
}

A quantity based policy specifies that a certain number of the most recent successful backups should be retained.

func (*AutomatedBackupPolicy_QuantityBasedRetention) Descriptor deprecated

Deprecated: Use AutomatedBackupPolicy_QuantityBasedRetention.ProtoReflect.Descriptor instead.

func (*AutomatedBackupPolicy_QuantityBasedRetention) GetCount

func (*AutomatedBackupPolicy_QuantityBasedRetention) ProtoMessage

func (*AutomatedBackupPolicy_QuantityBasedRetention) ProtoReflect

func (*AutomatedBackupPolicy_QuantityBasedRetention) Reset

func (*AutomatedBackupPolicy_QuantityBasedRetention) String

type AutomatedBackupPolicy_QuantityBasedRetention_

type AutomatedBackupPolicy_QuantityBasedRetention_ struct {
	// Quantity-based Backup retention policy to retain recent backups.
	QuantityBasedRetention *AutomatedBackupPolicy_QuantityBasedRetention `protobuf:"bytes,5,opt,name=quantity_based_retention,json=quantityBasedRetention,proto3,oneof"`
}

type AutomatedBackupPolicy_TimeBasedRetention

type AutomatedBackupPolicy_TimeBasedRetention struct {

	// The retention period.
	RetentionPeriod *durationpb.Duration `protobuf:"bytes,1,opt,name=retention_period,json=retentionPeriod,proto3" json:"retention_period,omitempty"`
	// contains filtered or unexported fields
}

A time based retention policy specifies that all backups within a certain time period should be retained.

func (*AutomatedBackupPolicy_TimeBasedRetention) Descriptor deprecated

func (*AutomatedBackupPolicy_TimeBasedRetention) Descriptor() ([]byte, []int)

Deprecated: Use AutomatedBackupPolicy_TimeBasedRetention.ProtoReflect.Descriptor instead.

func (*AutomatedBackupPolicy_TimeBasedRetention) GetRetentionPeriod

func (*AutomatedBackupPolicy_TimeBasedRetention) ProtoMessage

func (*AutomatedBackupPolicy_TimeBasedRetention) ProtoReflect

func (*AutomatedBackupPolicy_TimeBasedRetention) Reset

func (*AutomatedBackupPolicy_TimeBasedRetention) String

type AutomatedBackupPolicy_TimeBasedRetention_

type AutomatedBackupPolicy_TimeBasedRetention_ struct {
	// Time-based Backup retention policy.
	TimeBasedRetention *AutomatedBackupPolicy_TimeBasedRetention `protobuf:"bytes,4,opt,name=time_based_retention,json=timeBasedRetention,proto3,oneof"`
}

type AutomatedBackupPolicy_WeeklySchedule

type AutomatedBackupPolicy_WeeklySchedule struct {

	// The times during the day to start a backup. The start times are assumed
	// to be in UTC and to be an exact hour (e.g., 04:00:00).
	//
	// If no start times are provided, a single fixed start time is chosen
	// arbitrarily.
	StartTimes []*timeofday.TimeOfDay `protobuf:"bytes,1,rep,name=start_times,json=startTimes,proto3" json:"start_times,omitempty"`
	// The days of the week to perform a backup.
	//
	// If this field is left empty, the default of every day of the week is
	// used.
	DaysOfWeek []dayofweek.DayOfWeek `` /* 128-byte string literal not displayed */
	// contains filtered or unexported fields
}

A weekly schedule starts a backup at prescribed start times within a day, for the specified days of the week.

The weekly schedule message is flexible and can be used to create many types of schedules. For example, to have a daily backup that starts at 22:00, configure the `start_times` field to have one element "22:00" and the `days_of_week` field to have all seven days of the week.

func (*AutomatedBackupPolicy_WeeklySchedule) Descriptor deprecated

func (*AutomatedBackupPolicy_WeeklySchedule) Descriptor() ([]byte, []int)

Deprecated: Use AutomatedBackupPolicy_WeeklySchedule.ProtoReflect.Descriptor instead.

func (*AutomatedBackupPolicy_WeeklySchedule) GetDaysOfWeek

func (*AutomatedBackupPolicy_WeeklySchedule) GetStartTimes

func (*AutomatedBackupPolicy_WeeklySchedule) ProtoMessage

func (*AutomatedBackupPolicy_WeeklySchedule) ProtoMessage()

func (*AutomatedBackupPolicy_WeeklySchedule) ProtoReflect

func (*AutomatedBackupPolicy_WeeklySchedule) Reset

func (*AutomatedBackupPolicy_WeeklySchedule) String

type AutomatedBackupPolicy_WeeklySchedule_

type AutomatedBackupPolicy_WeeklySchedule_ struct {
	// Weekly schedule for the Backup.
	WeeklySchedule *AutomatedBackupPolicy_WeeklySchedule `protobuf:"bytes,2,opt,name=weekly_schedule,json=weeklySchedule,proto3,oneof"`
}

type Backup

type Backup struct {

	// Output only. The name of the backup resource with the format:
	//   - projects/{project}/locations/{region}/backups/{backup_id}
	//
	// where the cluster and backup ID segments should satisfy the regex
	// expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of
	// lowercase letters, numbers, and dashes, starting with a letter, and ending
	// with a letter or number. For more details see https://google.aip.dev/122.
	// The prefix of the backup resource name is the name of the parent
	// resource:
	//   - projects/{project}/locations/{region}
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// User-settable and human-readable display name for the Backup.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Output only. The system-generated UID of the resource. The UID is assigned
	// when the resource is created, and it is retained until it is deleted.
	Uid string `protobuf:"bytes,3,opt,name=uid,proto3" json:"uid,omitempty"`
	// Output only. Create time stamp
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Update time stamp
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Output only. Delete time stamp
	DeleteTime *timestamppb.Timestamp `protobuf:"bytes,15,opt,name=delete_time,json=deleteTime,proto3" json:"delete_time,omitempty"`
	// Labels as key value pairs
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// Output only. The current state of the backup.
	State Backup_State `protobuf:"varint,7,opt,name=state,proto3,enum=google.events.cloud.alloydb.v1.Backup_State" json:"state,omitempty"`
	// The backup type, which suggests the trigger for the backup.
	Type Backup_Type `protobuf:"varint,8,opt,name=type,proto3,enum=google.events.cloud.alloydb.v1.Backup_Type" json:"type,omitempty"`
	// User-provided description of the backup.
	Description string `protobuf:"bytes,9,opt,name=description,proto3" json:"description,omitempty"`
	// Output only. The system-generated UID of the cluster which was used to
	// create this resource.
	ClusterUid string `protobuf:"bytes,18,opt,name=cluster_uid,json=clusterUid,proto3" json:"cluster_uid,omitempty"`
	// Required. The full resource name of the backup source cluster
	// (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}).
	ClusterName string `protobuf:"bytes,10,opt,name=cluster_name,json=clusterName,proto3" json:"cluster_name,omitempty"`
	// Output only. Reconciling (https://google.aip.dev/128#reconciliation), if
	// true, indicates that the service is actively updating the resource. This
	// can happen due to user-triggered updates or system actions like failover or
	// maintenance.
	Reconciling bool `protobuf:"varint,11,opt,name=reconciling,proto3" json:"reconciling,omitempty"`
	// Optional. The encryption config can be specified to encrypt the
	// backup with a customer-managed encryption key (CMEK). When this field is
	// not specified, the backup will then use default encryption scheme to
	// protect the user data.
	EncryptionConfig *EncryptionConfig `protobuf:"bytes,12,opt,name=encryption_config,json=encryptionConfig,proto3" json:"encryption_config,omitempty"`
	// Output only. The encryption information for the backup.
	EncryptionInfo *EncryptionInfo `protobuf:"bytes,13,opt,name=encryption_info,json=encryptionInfo,proto3" json:"encryption_info,omitempty"`
	// For Resource freshness validation (https://google.aip.dev/154)
	Etag string `protobuf:"bytes,14,opt,name=etag,proto3" json:"etag,omitempty"`
	// Annotations to allow client tools to store small amount of arbitrary data.
	// This is distinct from labels.
	// https://google.aip.dev/128
	Annotations map[string]string `` /* 164-byte string literal not displayed */
	// Output only. The size of the backup in bytes.
	SizeBytes int64 `protobuf:"varint,17,opt,name=size_bytes,json=sizeBytes,proto3" json:"size_bytes,omitempty"`
	// Output only. The time at which after the backup is eligible to be garbage
	// collected. It is the duration specified by the backup's retention policy,
	// added to the backup's create_time.
	ExpiryTime *timestamppb.Timestamp `protobuf:"bytes,19,opt,name=expiry_time,json=expiryTime,proto3" json:"expiry_time,omitempty"`
	// contains filtered or unexported fields
}

Message describing Backup object

func (*Backup) Descriptor deprecated

func (*Backup) Descriptor() ([]byte, []int)

Deprecated: Use Backup.ProtoReflect.Descriptor instead.

func (*Backup) GetAnnotations

func (x *Backup) GetAnnotations() map[string]string

func (*Backup) GetClusterName

func (x *Backup) GetClusterName() string

func (*Backup) GetClusterUid

func (x *Backup) GetClusterUid() string

func (*Backup) GetCreateTime

func (x *Backup) GetCreateTime() *timestamppb.Timestamp

func (*Backup) GetDeleteTime

func (x *Backup) GetDeleteTime() *timestamppb.Timestamp

func (*Backup) GetDescription

func (x *Backup) GetDescription() string

func (*Backup) GetDisplayName

func (x *Backup) GetDisplayName() string

func (*Backup) GetEncryptionConfig

func (x *Backup) GetEncryptionConfig() *EncryptionConfig

func (*Backup) GetEncryptionInfo

func (x *Backup) GetEncryptionInfo() *EncryptionInfo

func (*Backup) GetEtag

func (x *Backup) GetEtag() string

func (*Backup) GetExpiryTime

func (x *Backup) GetExpiryTime() *timestamppb.Timestamp

func (*Backup) GetLabels

func (x *Backup) GetLabels() map[string]string

func (*Backup) GetName

func (x *Backup) GetName() string

func (*Backup) GetReconciling

func (x *Backup) GetReconciling() bool

func (*Backup) GetSizeBytes

func (x *Backup) GetSizeBytes() int64

func (*Backup) GetState

func (x *Backup) GetState() Backup_State

func (*Backup) GetType

func (x *Backup) GetType() Backup_Type

func (*Backup) GetUid

func (x *Backup) GetUid() string

func (*Backup) GetUpdateTime

func (x *Backup) GetUpdateTime() *timestamppb.Timestamp

func (*Backup) ProtoMessage

func (*Backup) ProtoMessage()

func (*Backup) ProtoReflect

func (x *Backup) ProtoReflect() protoreflect.Message

func (*Backup) Reset

func (x *Backup) Reset()

func (*Backup) String

func (x *Backup) String() string

type BackupEventData

type BackupEventData struct {

	// Optional. The Backup event payload. Unset for deletion events.
	Payload *Backup `protobuf:"bytes,1,opt,name=payload,proto3,oneof" json:"payload,omitempty"`
	// contains filtered or unexported fields
}

The data within all Backup events.

func (*BackupEventData) Descriptor deprecated

func (*BackupEventData) Descriptor() ([]byte, []int)

Deprecated: Use BackupEventData.ProtoReflect.Descriptor instead.

func (*BackupEventData) GetPayload

func (x *BackupEventData) GetPayload() *Backup

func (*BackupEventData) ProtoMessage

func (*BackupEventData) ProtoMessage()

func (*BackupEventData) ProtoReflect

func (x *BackupEventData) ProtoReflect() protoreflect.Message

func (*BackupEventData) Reset

func (x *BackupEventData) Reset()

func (*BackupEventData) String

func (x *BackupEventData) String() string

type BackupSource

type BackupSource struct {

	// Output only. The system-generated UID of the backup which was used to
	// create this resource. The UID is generated when the backup is created, and
	// it is retained until the backup is deleted.
	BackupUid string `protobuf:"bytes,2,opt,name=backup_uid,json=backupUid,proto3" json:"backup_uid,omitempty"`
	// Required. The name of the backup resource with the format:
	//   - projects/{project}/locations/{region}/backups/{backup_id}
	BackupName string `protobuf:"bytes,1,opt,name=backup_name,json=backupName,proto3" json:"backup_name,omitempty"`
	// contains filtered or unexported fields
}

Message describing a BackupSource.

func (*BackupSource) Descriptor deprecated

func (*BackupSource) Descriptor() ([]byte, []int)

Deprecated: Use BackupSource.ProtoReflect.Descriptor instead.

func (*BackupSource) GetBackupName

func (x *BackupSource) GetBackupName() string

func (*BackupSource) GetBackupUid

func (x *BackupSource) GetBackupUid() string

func (*BackupSource) ProtoMessage

func (*BackupSource) ProtoMessage()

func (*BackupSource) ProtoReflect

func (x *BackupSource) ProtoReflect() protoreflect.Message

func (*BackupSource) Reset

func (x *BackupSource) Reset()

func (*BackupSource) String

func (x *BackupSource) String() string

type Backup_State

type Backup_State int32

Backup State

const (
	// The state of the backup is unknown.
	Backup_STATE_UNSPECIFIED Backup_State = 0
	// The backup is ready.
	Backup_READY Backup_State = 1
	// The backup is creating.
	Backup_CREATING Backup_State = 2
	// The backup failed.
	Backup_FAILED Backup_State = 3
	// The backup is being deleted.
	Backup_DELETING Backup_State = 4
)

func (Backup_State) Descriptor

func (Backup_State) Enum

func (x Backup_State) Enum() *Backup_State

func (Backup_State) EnumDescriptor deprecated

func (Backup_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use Backup_State.Descriptor instead.

func (Backup_State) Number

func (Backup_State) String

func (x Backup_State) String() string

func (Backup_State) Type

type Backup_Type

type Backup_Type int32

Backup Type

const (
	// Backup Type is unknown.
	Backup_TYPE_UNSPECIFIED Backup_Type = 0
	// ON_DEMAND backups that were triggered by the customer (e.g., not
	// AUTOMATED).
	Backup_ON_DEMAND Backup_Type = 1
	// AUTOMATED backups triggered by the automated backups scheduler pursuant
	// to an automated backup policy.
	Backup_AUTOMATED Backup_Type = 2
	// CONTINUOUS backups triggered by the automated backups scheduler
	// due to a continuous backup policy.
	Backup_CONTINUOUS Backup_Type = 3
)

func (Backup_Type) Descriptor

func (Backup_Type) Enum

func (x Backup_Type) Enum() *Backup_Type

func (Backup_Type) EnumDescriptor deprecated

func (Backup_Type) EnumDescriptor() ([]byte, []int)

Deprecated: Use Backup_Type.Descriptor instead.

func (Backup_Type) Number

func (x Backup_Type) Number() protoreflect.EnumNumber

func (Backup_Type) String

func (x Backup_Type) String() string

func (Backup_Type) Type

type Cluster

type Cluster struct {

	// In case of an imported cluster, this field contains information about the
	// source this cluster was imported from.
	//
	// Types that are assignable to Source:
	//
	//	*Cluster_BackupSource
	//	*Cluster_MigrationSource
	Source isCluster_Source `protobuf_oneof:"source"`
	// Output only. The name of the cluster resource with the format:
	//   - projects/{project}/locations/{region}/clusters/{cluster_id}
	//
	// where the cluster ID segment should satisfy the regex expression
	// `[a-z0-9-]+`. For more details see https://google.aip.dev/122.
	// The prefix of the cluster resource name is the name of the parent resource:
	//   - projects/{project}/locations/{region}
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// User-settable and human-readable display name for the Cluster.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Output only. The system-generated UID of the resource. The UID is assigned
	// when the resource is created, and it is retained until it is deleted.
	Uid string `protobuf:"bytes,3,opt,name=uid,proto3" json:"uid,omitempty"`
	// Output only. Create time stamp
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Update time stamp
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Output only. Delete time stamp
	DeleteTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=delete_time,json=deleteTime,proto3" json:"delete_time,omitempty"`
	// Labels as key value pairs
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// Output only. The current serving state of the cluster.
	State Cluster_State `protobuf:"varint,8,opt,name=state,proto3,enum=google.events.cloud.alloydb.v1.Cluster_State" json:"state,omitempty"`
	// Output only. The type of the cluster. This is an output-only field and it's
	// populated at the Cluster creation time or the Cluster promotion
	// time. The cluster type is determined by which RPC was used to create
	// the cluster (i.e. `CreateCluster` vs. `CreateSecondaryCluster`
	ClusterType Cluster_ClusterType `` /* 152-byte string literal not displayed */
	// Output only. The database engine major version. This is an output-only
	// field and it's populated at the Cluster creation time. This field cannot be
	// changed after cluster creation.
	DatabaseVersion DatabaseVersion `` /* 159-byte string literal not displayed */
	// Required. The resource link for the VPC network in which cluster resources
	// are created and from which they are accessible via Private IP. The network
	// must belong to the same project as the cluster. It is specified in the
	// form: "projects/{project_number}/global/networks/{network_id}". This is
	// required to create a cluster. It can be updated, but it cannot be removed.
	Network string `protobuf:"bytes,10,opt,name=network,proto3" json:"network,omitempty"`
	// For Resource freshness validation (https://google.aip.dev/154)
	Etag string `protobuf:"bytes,11,opt,name=etag,proto3" json:"etag,omitempty"`
	// Annotations to allow client tools to store small amount of arbitrary data.
	// This is distinct from labels.
	// https://google.aip.dev/128
	Annotations map[string]string `` /* 164-byte string literal not displayed */
	// Output only. Reconciling (https://google.aip.dev/128#reconciliation).
	// Set to true if the current state of Cluster does not match the user's
	// intended state, and the service is actively updating the resource to
	// reconcile them. This can happen due to user-triggered updates or
	// system actions like failover or maintenance.
	Reconciling bool `protobuf:"varint,13,opt,name=reconciling,proto3" json:"reconciling,omitempty"`
	// The automated backup policy for this cluster.
	//
	// If no policy is provided then the default policy will be used. If backups
	// are supported for the cluster, the default policy takes one backup a day,
	// has a backup window of 1 hour, and retains backups for 14 days.
	// For more information on the defaults, consult the
	// documentation for the message type.
	AutomatedBackupPolicy *AutomatedBackupPolicy `` /* 127-byte string literal not displayed */
	// SSL configuration for this AlloyDB Cluster.
	SslConfig *SslConfig `protobuf:"bytes,18,opt,name=ssl_config,json=sslConfig,proto3" json:"ssl_config,omitempty"`
	// Optional. The encryption config can be specified to encrypt the data disks
	// and other persistent data resources of a cluster with a
	// customer-managed encryption key (CMEK). When this field is not
	// specified, the cluster will then use default encryption scheme to
	// protect the user data.
	EncryptionConfig *EncryptionConfig `protobuf:"bytes,19,opt,name=encryption_config,json=encryptionConfig,proto3" json:"encryption_config,omitempty"`
	// Output only. The encryption information for the cluster.
	EncryptionInfo *EncryptionInfo `protobuf:"bytes,20,opt,name=encryption_info,json=encryptionInfo,proto3" json:"encryption_info,omitempty"`
	// Cross Region replication config specific to SECONDARY cluster.
	SecondaryConfig *Cluster_SecondaryConfig `protobuf:"bytes,22,opt,name=secondary_config,json=secondaryConfig,proto3" json:"secondary_config,omitempty"`
	// Output only. Cross Region replication config specific to PRIMARY cluster.
	PrimaryConfig *Cluster_PrimaryConfig `protobuf:"bytes,23,opt,name=primary_config,json=primaryConfig,proto3" json:"primary_config,omitempty"`
	// contains filtered or unexported fields
}

A cluster is a collection of regional AlloyDB resources. It can include a primary instance and one or more read pool instances. All cluster resources share a storage layer, which scales as needed.

func (*Cluster) Descriptor deprecated

func (*Cluster) Descriptor() ([]byte, []int)

Deprecated: Use Cluster.ProtoReflect.Descriptor instead.

func (*Cluster) GetAnnotations

func (x *Cluster) GetAnnotations() map[string]string

func (*Cluster) GetAutomatedBackupPolicy

func (x *Cluster) GetAutomatedBackupPolicy() *AutomatedBackupPolicy

func (*Cluster) GetBackupSource

func (x *Cluster) GetBackupSource() *BackupSource

func (*Cluster) GetClusterType

func (x *Cluster) GetClusterType() Cluster_ClusterType

func (*Cluster) GetCreateTime

func (x *Cluster) GetCreateTime() *timestamppb.Timestamp

func (*Cluster) GetDatabaseVersion

func (x *Cluster) GetDatabaseVersion() DatabaseVersion

func (*Cluster) GetDeleteTime

func (x *Cluster) GetDeleteTime() *timestamppb.Timestamp

func (*Cluster) GetDisplayName

func (x *Cluster) GetDisplayName() string

func (*Cluster) GetEncryptionConfig

func (x *Cluster) GetEncryptionConfig() *EncryptionConfig

func (*Cluster) GetEncryptionInfo

func (x *Cluster) GetEncryptionInfo() *EncryptionInfo

func (*Cluster) GetEtag

func (x *Cluster) GetEtag() string

func (*Cluster) GetLabels

func (x *Cluster) GetLabels() map[string]string

func (*Cluster) GetMigrationSource

func (x *Cluster) GetMigrationSource() *MigrationSource

func (*Cluster) GetName

func (x *Cluster) GetName() string

func (*Cluster) GetNetwork

func (x *Cluster) GetNetwork() string

func (*Cluster) GetPrimaryConfig

func (x *Cluster) GetPrimaryConfig() *Cluster_PrimaryConfig

func (*Cluster) GetReconciling

func (x *Cluster) GetReconciling() bool

func (*Cluster) GetSecondaryConfig

func (x *Cluster) GetSecondaryConfig() *Cluster_SecondaryConfig

func (*Cluster) GetSource

func (m *Cluster) GetSource() isCluster_Source

func (*Cluster) GetSslConfig

func (x *Cluster) GetSslConfig() *SslConfig

func (*Cluster) GetState

func (x *Cluster) GetState() Cluster_State

func (*Cluster) GetUid

func (x *Cluster) GetUid() string

func (*Cluster) GetUpdateTime

func (x *Cluster) GetUpdateTime() *timestamppb.Timestamp

func (*Cluster) ProtoMessage

func (*Cluster) ProtoMessage()

func (*Cluster) ProtoReflect

func (x *Cluster) ProtoReflect() protoreflect.Message

func (*Cluster) Reset

func (x *Cluster) Reset()

func (*Cluster) String

func (x *Cluster) String() string

type ClusterEventData

type ClusterEventData struct {

	// Optional. The Cluster event payload. Unset for deletion events.
	Payload *Cluster `protobuf:"bytes,1,opt,name=payload,proto3,oneof" json:"payload,omitempty"`
	// contains filtered or unexported fields
}

The data within all Cluster events.

func (*ClusterEventData) Descriptor deprecated

func (*ClusterEventData) Descriptor() ([]byte, []int)

Deprecated: Use ClusterEventData.ProtoReflect.Descriptor instead.

func (*ClusterEventData) GetPayload

func (x *ClusterEventData) GetPayload() *Cluster

func (*ClusterEventData) ProtoMessage

func (*ClusterEventData) ProtoMessage()

func (*ClusterEventData) ProtoReflect

func (x *ClusterEventData) ProtoReflect() protoreflect.Message

func (*ClusterEventData) Reset

func (x *ClusterEventData) Reset()

func (*ClusterEventData) String

func (x *ClusterEventData) String() string

type Cluster_BackupSource

type Cluster_BackupSource struct {
	// Output only. Cluster created from backup.
	BackupSource *BackupSource `protobuf:"bytes,15,opt,name=backup_source,json=backupSource,proto3,oneof"`
}

type Cluster_ClusterType

type Cluster_ClusterType int32

Type of Cluster

const (
	// The type of the cluster is unknown.
	Cluster_CLUSTER_TYPE_UNSPECIFIED Cluster_ClusterType = 0
	// Primary cluster that support read and write operations.
	Cluster_PRIMARY Cluster_ClusterType = 1
	// Secondary cluster that is replicating from another region.
	// This only supports read.
	Cluster_SECONDARY Cluster_ClusterType = 2
)

func (Cluster_ClusterType) Descriptor

func (Cluster_ClusterType) Enum

func (Cluster_ClusterType) EnumDescriptor deprecated

func (Cluster_ClusterType) EnumDescriptor() ([]byte, []int)

Deprecated: Use Cluster_ClusterType.Descriptor instead.

func (Cluster_ClusterType) Number

func (Cluster_ClusterType) String

func (x Cluster_ClusterType) String() string

func (Cluster_ClusterType) Type

type Cluster_MigrationSource

type Cluster_MigrationSource struct {
	// Output only. Cluster created via DMS migration.
	MigrationSource *MigrationSource `protobuf:"bytes,16,opt,name=migration_source,json=migrationSource,proto3,oneof"`
}

type Cluster_PrimaryConfig

type Cluster_PrimaryConfig struct {

	// Output only. Names of the clusters that are replicating from this
	// cluster.
	SecondaryClusterNames []string `` /* 126-byte string literal not displayed */
	// contains filtered or unexported fields
}

Configuration for the primary cluster. It has the list of clusters that are replicating from this cluster. This should be set if and only if the cluster is of type PRIMARY.

func (*Cluster_PrimaryConfig) Descriptor deprecated

func (*Cluster_PrimaryConfig) Descriptor() ([]byte, []int)

Deprecated: Use Cluster_PrimaryConfig.ProtoReflect.Descriptor instead.

func (*Cluster_PrimaryConfig) GetSecondaryClusterNames

func (x *Cluster_PrimaryConfig) GetSecondaryClusterNames() []string

func (*Cluster_PrimaryConfig) ProtoMessage

func (*Cluster_PrimaryConfig) ProtoMessage()

func (*Cluster_PrimaryConfig) ProtoReflect

func (x *Cluster_PrimaryConfig) ProtoReflect() protoreflect.Message

func (*Cluster_PrimaryConfig) Reset

func (x *Cluster_PrimaryConfig) Reset()

func (*Cluster_PrimaryConfig) String

func (x *Cluster_PrimaryConfig) String() string

type Cluster_SecondaryConfig

type Cluster_SecondaryConfig struct {

	// The name of the primary cluster name with the format:
	// * projects/{project}/locations/{region}/clusters/{cluster_id}
	PrimaryClusterName string `protobuf:"bytes,1,opt,name=primary_cluster_name,json=primaryClusterName,proto3" json:"primary_cluster_name,omitempty"`
	// contains filtered or unexported fields
}

Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY.

func (*Cluster_SecondaryConfig) Descriptor deprecated

func (*Cluster_SecondaryConfig) Descriptor() ([]byte, []int)

Deprecated: Use Cluster_SecondaryConfig.ProtoReflect.Descriptor instead.

func (*Cluster_SecondaryConfig) GetPrimaryClusterName

func (x *Cluster_SecondaryConfig) GetPrimaryClusterName() string

func (*Cluster_SecondaryConfig) ProtoMessage

func (*Cluster_SecondaryConfig) ProtoMessage()

func (*Cluster_SecondaryConfig) ProtoReflect

func (x *Cluster_SecondaryConfig) ProtoReflect() protoreflect.Message

func (*Cluster_SecondaryConfig) Reset

func (x *Cluster_SecondaryConfig) Reset()

func (*Cluster_SecondaryConfig) String

func (x *Cluster_SecondaryConfig) String() string

type Cluster_State

type Cluster_State int32

Cluster State

const (
	// The state of the cluster is unknown.
	Cluster_STATE_UNSPECIFIED Cluster_State = 0
	// The cluster is active and running.
	Cluster_READY Cluster_State = 1
	// The cluster is stopped. All instances in the cluster are stopped.
	// Customers can start a stopped cluster at any point and all their
	// instances will come back to life with same names and IP resources. In
	// this state, customer pays for storage.
	// Associated backups could also be present in a stopped cluster.
	Cluster_STOPPED Cluster_State = 2
	// The cluster is empty and has no associated resources.
	// All instances, associated storage and backups have been deleted.
	Cluster_EMPTY Cluster_State = 3
	// The cluster is being created.
	Cluster_CREATING Cluster_State = 4
	// The cluster is being deleted.
	Cluster_DELETING Cluster_State = 5
	// The creation of the cluster failed.
	Cluster_FAILED Cluster_State = 6
	// The cluster is bootstrapping with data from some other source.
	// Direct mutations to the cluster (e.g. adding read pool) are not allowed.
	Cluster_BOOTSTRAPPING Cluster_State = 7
	// The cluster is under maintenance. AlloyDB regularly performs maintenance
	// and upgrades on customer clusters. Updates on the cluster are
	// not allowed while the cluster is in this state.
	Cluster_MAINTENANCE Cluster_State = 8
	// The cluster is being promoted.
	Cluster_PROMOTING Cluster_State = 9
)

func (Cluster_State) Descriptor

func (Cluster_State) Enum

func (x Cluster_State) Enum() *Cluster_State

func (Cluster_State) EnumDescriptor deprecated

func (Cluster_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use Cluster_State.Descriptor instead.

func (Cluster_State) Number

func (Cluster_State) String

func (x Cluster_State) String() string

func (Cluster_State) Type

type DatabaseVersion

type DatabaseVersion int32

The supported database engine versions.

const (
	// This is an unknown database version.
	DatabaseVersion_DATABASE_VERSION_UNSPECIFIED DatabaseVersion = 0
	// DEPRECATED - The database version is Postgres 13.
	DatabaseVersion_POSTGRES_13 DatabaseVersion = 1
	// The database version is Postgres 14.
	DatabaseVersion_POSTGRES_14 DatabaseVersion = 2
)

func (DatabaseVersion) Descriptor

func (DatabaseVersion) Enum

func (x DatabaseVersion) Enum() *DatabaseVersion

func (DatabaseVersion) EnumDescriptor deprecated

func (DatabaseVersion) EnumDescriptor() ([]byte, []int)

Deprecated: Use DatabaseVersion.Descriptor instead.

func (DatabaseVersion) Number

func (DatabaseVersion) String

func (x DatabaseVersion) String() string

func (DatabaseVersion) Type

type EncryptionConfig

type EncryptionConfig struct {

	// The fully-qualified resource name of the KMS key.
	// Each Cloud KMS key is regionalized and has the following format:
	// projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
	KmsKeyName string `protobuf:"bytes,1,opt,name=kms_key_name,json=kmsKeyName,proto3" json:"kms_key_name,omitempty"`
	// contains filtered or unexported fields
}

EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key).

func (*EncryptionConfig) Descriptor deprecated

func (*EncryptionConfig) Descriptor() ([]byte, []int)

Deprecated: Use EncryptionConfig.ProtoReflect.Descriptor instead.

func (*EncryptionConfig) GetKmsKeyName

func (x *EncryptionConfig) GetKmsKeyName() string

func (*EncryptionConfig) ProtoMessage

func (*EncryptionConfig) ProtoMessage()

func (*EncryptionConfig) ProtoReflect

func (x *EncryptionConfig) ProtoReflect() protoreflect.Message

func (*EncryptionConfig) Reset

func (x *EncryptionConfig) Reset()

func (*EncryptionConfig) String

func (x *EncryptionConfig) String() string

type EncryptionInfo

type EncryptionInfo struct {

	// Output only. Type of encryption.
	EncryptionType EncryptionInfo_Type `` /* 160-byte string literal not displayed */
	// Output only. Cloud KMS key versions that are being used to protect the
	// database or the backup.
	KmsKeyVersions []string `protobuf:"bytes,2,rep,name=kms_key_versions,json=kmsKeyVersions,proto3" json:"kms_key_versions,omitempty"`
	// contains filtered or unexported fields
}

EncryptionInfo describes the encryption information of a cluster or a backup.

func (*EncryptionInfo) Descriptor deprecated

func (*EncryptionInfo) Descriptor() ([]byte, []int)

Deprecated: Use EncryptionInfo.ProtoReflect.Descriptor instead.

func (*EncryptionInfo) GetEncryptionType

func (x *EncryptionInfo) GetEncryptionType() EncryptionInfo_Type

func (*EncryptionInfo) GetKmsKeyVersions

func (x *EncryptionInfo) GetKmsKeyVersions() []string

func (*EncryptionInfo) ProtoMessage

func (*EncryptionInfo) ProtoMessage()

func (*EncryptionInfo) ProtoReflect

func (x *EncryptionInfo) ProtoReflect() protoreflect.Message

func (*EncryptionInfo) Reset

func (x *EncryptionInfo) Reset()

func (*EncryptionInfo) String

func (x *EncryptionInfo) String() string

type EncryptionInfo_Type

type EncryptionInfo_Type int32

Possible encryption types.

const (
	// Encryption type not specified. Defaults to GOOGLE_DEFAULT_ENCRYPTION.
	EncryptionInfo_TYPE_UNSPECIFIED EncryptionInfo_Type = 0
	// The data is encrypted at rest with a key that is fully managed by Google.
	// No key version will be populated. This is the default state.
	EncryptionInfo_GOOGLE_DEFAULT_ENCRYPTION EncryptionInfo_Type = 1
	// The data is encrypted at rest with a key that is managed by the customer.
	// KMS key versions will be populated.
	EncryptionInfo_CUSTOMER_MANAGED_ENCRYPTION EncryptionInfo_Type = 2
)

func (EncryptionInfo_Type) Descriptor

func (EncryptionInfo_Type) Enum

func (EncryptionInfo_Type) EnumDescriptor deprecated

func (EncryptionInfo_Type) EnumDescriptor() ([]byte, []int)

Deprecated: Use EncryptionInfo_Type.Descriptor instead.

func (EncryptionInfo_Type) Number

func (EncryptionInfo_Type) String

func (x EncryptionInfo_Type) String() string

func (EncryptionInfo_Type) Type

type Instance

type Instance struct {

	// Output only. The name of the instance resource with the format:
	//   - projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id}
	//
	// where the cluster and instance ID segments should satisfy the regex
	// expression `[a-z]([a-z0-9-]{0,61}[a-z0-9])?`, e.g. 1-63 characters of
	// lowercase letters, numbers, and dashes, starting with a letter, and ending
	// with a letter or number. For more details see https://google.aip.dev/122.
	// The prefix of the instance resource name is the name of the parent
	// resource:
	//   - projects/{project}/locations/{region}/clusters/{cluster_id}
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// User-settable and human-readable display name for the Instance.
	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// Output only. The system-generated UID of the resource. The UID is assigned
	// when the resource is created, and it is retained until it is deleted.
	Uid string `protobuf:"bytes,3,opt,name=uid,proto3" json:"uid,omitempty"`
	// Output only. Create time stamp
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. Update time stamp
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// Output only. Delete time stamp
	DeleteTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=delete_time,json=deleteTime,proto3" json:"delete_time,omitempty"`
	// Labels as key value pairs
	Labels map[string]string `` /* 153-byte string literal not displayed */
	// Output only. The current serving state of the instance.
	State Instance_State `protobuf:"varint,8,opt,name=state,proto3,enum=google.events.cloud.alloydb.v1.Instance_State" json:"state,omitempty"`
	// Required. The type of the instance. Specified at creation time.
	InstanceType Instance_InstanceType `` /* 156-byte string literal not displayed */
	// Configurations for the machines that host the underlying
	// database engine.
	MachineConfig *Instance_MachineConfig `protobuf:"bytes,10,opt,name=machine_config,json=machineConfig,proto3" json:"machine_config,omitempty"`
	// Availability type of an Instance.
	// If empty, defaults to REGIONAL for primary instances.
	// For read pools, availability_type is always UNSPECIFIED. Instances in the
	// read pools are evenly distributed across available zones within the region
	// (i.e. read pools with more than one node will have a node in at
	// least two zones).
	AvailabilityType Instance_AvailabilityType `` /* 173-byte string literal not displayed */
	// The Compute Engine zone that the instance should serve from, per
	// https://cloud.google.com/compute/docs/regions-zones
	// This can ONLY be specified for ZONAL instances.
	// If present for a REGIONAL instance, an error will be thrown.
	// If this is absent for a ZONAL instance, instance is created in a random
	// zone with available capacity.
	GceZone string `protobuf:"bytes,12,opt,name=gce_zone,json=gceZone,proto3" json:"gce_zone,omitempty"`
	// Database flags. Set at instance level.
	//   - They are copied from primary instance on read instance creation.
	//   - Read instances can set new or override existing flags that are relevant
	//     for reads, e.g. for enabling columnar cache on a read instance. Flags
	//     set on read instance may or may not be present on primary.
	//
	// This is a list of "key": "value" pairs.
	// "key": The name of the flag. These flags are passed at instance setup time,
	// so include both server options and system variables for Postgres. Flags are
	// specified with underscores, not hyphens.
	// "value": The value of the flag. Booleans are set to **on** for true
	// and **off** for false. This field must be omitted if the flag
	// doesn't take a value.
	DatabaseFlags map[string]string `` /* 189-byte string literal not displayed */
	// Output only. This is set for the read-write VM of the PRIMARY instance
	// only.
	WritableNode *Instance_Node `protobuf:"bytes,19,opt,name=writable_node,json=writableNode,proto3" json:"writable_node,omitempty"`
	// Output only. List of available read-only VMs in this instance, including
	// the standby for a PRIMARY instance.
	Nodes []*Instance_Node `protobuf:"bytes,20,rep,name=nodes,proto3" json:"nodes,omitempty"`
	// Configuration for query insights.
	QueryInsightsConfig *Instance_QueryInsightsInstanceConfig `protobuf:"bytes,21,opt,name=query_insights_config,json=queryInsightsConfig,proto3" json:"query_insights_config,omitempty"`
	// Read pool specific config.
	ReadPoolConfig *Instance_ReadPoolConfig `protobuf:"bytes,14,opt,name=read_pool_config,json=readPoolConfig,proto3" json:"read_pool_config,omitempty"`
	// Output only. The IP address for the Instance.
	// This is the connection endpoint for an end-user application.
	IpAddress string `protobuf:"bytes,15,opt,name=ip_address,json=ipAddress,proto3" json:"ip_address,omitempty"`
	// Output only. Reconciling (https://google.aip.dev/128#reconciliation).
	// Set to true if the current state of Instance does not match the user's
	// intended state, and the service is actively updating the resource to
	// reconcile them. This can happen due to user-triggered updates or
	// system actions like failover or maintenance.
	Reconciling bool `protobuf:"varint,16,opt,name=reconciling,proto3" json:"reconciling,omitempty"`
	// For Resource freshness validation (https://google.aip.dev/154)
	Etag string `protobuf:"bytes,17,opt,name=etag,proto3" json:"etag,omitempty"`
	// Annotations to allow client tools to store small amount of arbitrary data.
	// This is distinct from labels.
	// https://google.aip.dev/128
	Annotations map[string]string `` /* 164-byte string literal not displayed */
	// contains filtered or unexported fields
}

An Instance is a computing unit that an end customer can connect to. It's the main unit of computing resources in AlloyDB.

func (*Instance) Descriptor deprecated

func (*Instance) Descriptor() ([]byte, []int)

Deprecated: Use Instance.ProtoReflect.Descriptor instead.

func (*Instance) GetAnnotations

func (x *Instance) GetAnnotations() map[string]string

func (*Instance) GetAvailabilityType

func (x *Instance) GetAvailabilityType() Instance_AvailabilityType

func (*Instance) GetCreateTime

func (x *Instance) GetCreateTime() *timestamppb.Timestamp

func (*Instance) GetDatabaseFlags

func (x *Instance) GetDatabaseFlags() map[string]string

func (*Instance) GetDeleteTime

func (x *Instance) GetDeleteTime() *timestamppb.Timestamp

func (*Instance) GetDisplayName

func (x *Instance) GetDisplayName() string

func (*Instance) GetEtag

func (x *Instance) GetEtag() string

func (*Instance) GetGceZone

func (x *Instance) GetGceZone() string

func (*Instance) GetInstanceType

func (x *Instance) GetInstanceType() Instance_InstanceType

func (*Instance) GetIpAddress

func (x *Instance) GetIpAddress() string

func (*Instance) GetLabels

func (x *Instance) GetLabels() map[string]string

func (*Instance) GetMachineConfig

func (x *Instance) GetMachineConfig() *Instance_MachineConfig

func (*Instance) GetName

func (x *Instance) GetName() string

func (*Instance) GetNodes

func (x *Instance) GetNodes() []*Instance_Node

func (*Instance) GetQueryInsightsConfig

func (x *Instance) GetQueryInsightsConfig() *Instance_QueryInsightsInstanceConfig

func (*Instance) GetReadPoolConfig

func (x *Instance) GetReadPoolConfig() *Instance_ReadPoolConfig

func (*Instance) GetReconciling

func (x *Instance) GetReconciling() bool

func (*Instance) GetState

func (x *Instance) GetState() Instance_State

func (*Instance) GetUid

func (x *Instance) GetUid() string

func (*Instance) GetUpdateTime

func (x *Instance) GetUpdateTime() *timestamppb.Timestamp

func (*Instance) GetWritableNode

func (x *Instance) GetWritableNode() *Instance_Node

func (*Instance) ProtoMessage

func (*Instance) ProtoMessage()

func (*Instance) ProtoReflect

func (x *Instance) ProtoReflect() protoreflect.Message

func (*Instance) Reset

func (x *Instance) Reset()

func (*Instance) String

func (x *Instance) String() string

type InstanceEventData

type InstanceEventData struct {

	// Optional. The Instance event payload. Unset for deletion events.
	Payload *Instance `protobuf:"bytes,1,opt,name=payload,proto3,oneof" json:"payload,omitempty"`
	// contains filtered or unexported fields
}

The data within all Instance events.

func (*InstanceEventData) Descriptor deprecated

func (*InstanceEventData) Descriptor() ([]byte, []int)

Deprecated: Use InstanceEventData.ProtoReflect.Descriptor instead.

func (*InstanceEventData) GetPayload

func (x *InstanceEventData) GetPayload() *Instance

func (*InstanceEventData) ProtoMessage

func (*InstanceEventData) ProtoMessage()

func (*InstanceEventData) ProtoReflect

func (x *InstanceEventData) ProtoReflect() protoreflect.Message

func (*InstanceEventData) Reset

func (x *InstanceEventData) Reset()

func (*InstanceEventData) String

func (x *InstanceEventData) String() string

type Instance_AvailabilityType

type Instance_AvailabilityType int32

The Availability type of an instance. Potential values: - ZONAL: The instance serves data from only one zone. Outages in that zone affect instance availability. - REGIONAL: The instance can serve data from more than one zone in a region (it is highly available).

const (
	// This is an unknown Availability type.
	Instance_AVAILABILITY_TYPE_UNSPECIFIED Instance_AvailabilityType = 0
	// Zonal available instance.
	Instance_ZONAL Instance_AvailabilityType = 1
	// Regional (or Highly) available instance.
	Instance_REGIONAL Instance_AvailabilityType = 2
)

func (Instance_AvailabilityType) Descriptor

func (Instance_AvailabilityType) Enum

func (Instance_AvailabilityType) EnumDescriptor deprecated

func (Instance_AvailabilityType) EnumDescriptor() ([]byte, []int)

Deprecated: Use Instance_AvailabilityType.Descriptor instead.

func (Instance_AvailabilityType) Number

func (Instance_AvailabilityType) String

func (x Instance_AvailabilityType) String() string

func (Instance_AvailabilityType) Type

type Instance_InstanceType

type Instance_InstanceType int32

Type of an Instance

const (
	// The type of the instance is unknown.
	Instance_INSTANCE_TYPE_UNSPECIFIED Instance_InstanceType = 0
	// PRIMARY instances support read and write operations.
	Instance_PRIMARY Instance_InstanceType = 1
	// READ POOL instances support read operations only. Each read pool instance
	// consists of one or more homogeneous nodes.
	//   - Read pool of size 1 can only have zonal availability.
	//   - Read pools with node count of 2 or more can have regional
	//     availability (nodes are present in 2 or more zones in a region).
	Instance_READ_POOL Instance_InstanceType = 2
	// SECONDARY instances support read operations only. SECONDARY instance
	// is a cross-region read replica
	Instance_SECONDARY Instance_InstanceType = 3
)

func (Instance_InstanceType) Descriptor

func (Instance_InstanceType) Enum

func (Instance_InstanceType) EnumDescriptor deprecated

func (Instance_InstanceType) EnumDescriptor() ([]byte, []int)

Deprecated: Use Instance_InstanceType.Descriptor instead.

func (Instance_InstanceType) Number

func (Instance_InstanceType) String

func (x Instance_InstanceType) String() string

func (Instance_InstanceType) Type

type Instance_MachineConfig

type Instance_MachineConfig struct {

	// The number of CPU's in the VM instance.
	CpuCount int32 `protobuf:"varint,1,opt,name=cpu_count,json=cpuCount,proto3" json:"cpu_count,omitempty"`
	// contains filtered or unexported fields
}

MachineConfig describes the configuration of a machine.

func (*Instance_MachineConfig) Descriptor deprecated

func (*Instance_MachineConfig) Descriptor() ([]byte, []int)

Deprecated: Use Instance_MachineConfig.ProtoReflect.Descriptor instead.

func (*Instance_MachineConfig) GetCpuCount

func (x *Instance_MachineConfig) GetCpuCount() int32

func (*Instance_MachineConfig) ProtoMessage

func (*Instance_MachineConfig) ProtoMessage()

func (*Instance_MachineConfig) ProtoReflect

func (x *Instance_MachineConfig) ProtoReflect() protoreflect.Message

func (*Instance_MachineConfig) Reset

func (x *Instance_MachineConfig) Reset()

func (*Instance_MachineConfig) String

func (x *Instance_MachineConfig) String() string

type Instance_Node

type Instance_Node struct {

	// The Compute Engine zone of the VM e.g. "us-central1-b".
	ZoneId string `protobuf:"bytes,1,opt,name=zone_id,json=zoneId,proto3" json:"zone_id,omitempty"`
	// The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
	Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
	// The private IP address of the VM e.g. "10.57.0.34".
	Ip string `protobuf:"bytes,3,opt,name=ip,proto3" json:"ip,omitempty"`
	// Determined by state of the compute VM and postgres-service health.
	// Compute VM state can have values listed in
	// https://cloud.google.com/compute/docs/instances/instance-life-cycle and
	// postgres-service health can have values: HEALTHY and UNHEALTHY.
	State string `protobuf:"bytes,4,opt,name=state,proto3" json:"state,omitempty"`
	// contains filtered or unexported fields
}

Details of a single node in the instance. Nodes in an AlloyDB instance are ephemereal, they can change during update, failover, autohealing and resize operations.

func (*Instance_Node) Descriptor deprecated

func (*Instance_Node) Descriptor() ([]byte, []int)

Deprecated: Use Instance_Node.ProtoReflect.Descriptor instead.

func (*Instance_Node) GetId

func (x *Instance_Node) GetId() string

func (*Instance_Node) GetIp

func (x *Instance_Node) GetIp() string

func (*Instance_Node) GetState

func (x *Instance_Node) GetState() string

func (*Instance_Node) GetZoneId

func (x *Instance_Node) GetZoneId() string

func (*Instance_Node) ProtoMessage

func (*Instance_Node) ProtoMessage()

func (*Instance_Node) ProtoReflect

func (x *Instance_Node) ProtoReflect() protoreflect.Message

func (*Instance_Node) Reset

func (x *Instance_Node) Reset()

func (*Instance_Node) String

func (x *Instance_Node) String() string

type Instance_QueryInsightsInstanceConfig

type Instance_QueryInsightsInstanceConfig struct {

	// Record application tags for an instance.
	// This flag is turned "on" by default.
	RecordApplicationTags *bool `` /* 133-byte string literal not displayed */
	// Record client address for an instance. Client address is PII information.
	// This flag is turned "on" by default.
	RecordClientAddress *bool `` /* 127-byte string literal not displayed */
	// Query string length. The default value is 1024.
	// Any integer between 256 and 4500 is considered valid.
	QueryStringLength uint32 `protobuf:"varint,4,opt,name=query_string_length,json=queryStringLength,proto3" json:"query_string_length,omitempty"`
	// Number of query execution plans captured by Insights per minute
	// for all queries combined. The default value is 5.
	// Any integer between 0 and 20 is considered valid.
	QueryPlansPerMinute *uint32 `` /* 129-byte string literal not displayed */
	// contains filtered or unexported fields
}

QueryInsights Instance specific configuration.

func (*Instance_QueryInsightsInstanceConfig) Descriptor deprecated

func (*Instance_QueryInsightsInstanceConfig) Descriptor() ([]byte, []int)

Deprecated: Use Instance_QueryInsightsInstanceConfig.ProtoReflect.Descriptor instead.

func (*Instance_QueryInsightsInstanceConfig) GetQueryPlansPerMinute

func (x *Instance_QueryInsightsInstanceConfig) GetQueryPlansPerMinute() uint32

func (*Instance_QueryInsightsInstanceConfig) GetQueryStringLength

func (x *Instance_QueryInsightsInstanceConfig) GetQueryStringLength() uint32

func (*Instance_QueryInsightsInstanceConfig) GetRecordApplicationTags

func (x *Instance_QueryInsightsInstanceConfig) GetRecordApplicationTags() bool

func (*Instance_QueryInsightsInstanceConfig) GetRecordClientAddress

func (x *Instance_QueryInsightsInstanceConfig) GetRecordClientAddress() bool

func (*Instance_QueryInsightsInstanceConfig) ProtoMessage

func (*Instance_QueryInsightsInstanceConfig) ProtoMessage()

func (*Instance_QueryInsightsInstanceConfig) ProtoReflect

func (*Instance_QueryInsightsInstanceConfig) Reset

func (*Instance_QueryInsightsInstanceConfig) String

type Instance_ReadPoolConfig

type Instance_ReadPoolConfig struct {

	// Read capacity, i.e. number of nodes in a read pool instance.
	NodeCount int32 `protobuf:"varint,1,opt,name=node_count,json=nodeCount,proto3" json:"node_count,omitempty"`
	// contains filtered or unexported fields
}

Configuration for a read pool instance.

func (*Instance_ReadPoolConfig) Descriptor deprecated

func (*Instance_ReadPoolConfig) Descriptor() ([]byte, []int)

Deprecated: Use Instance_ReadPoolConfig.ProtoReflect.Descriptor instead.

func (*Instance_ReadPoolConfig) GetNodeCount

func (x *Instance_ReadPoolConfig) GetNodeCount() int32

func (*Instance_ReadPoolConfig) ProtoMessage

func (*Instance_ReadPoolConfig) ProtoMessage()

func (*Instance_ReadPoolConfig) ProtoReflect

func (x *Instance_ReadPoolConfig) ProtoReflect() protoreflect.Message

func (*Instance_ReadPoolConfig) Reset

func (x *Instance_ReadPoolConfig) Reset()

func (*Instance_ReadPoolConfig) String

func (x *Instance_ReadPoolConfig) String() string

type Instance_State

type Instance_State int32

Instance State

const (
	// The state of the instance is unknown.
	Instance_STATE_UNSPECIFIED Instance_State = 0
	// The instance is active and running.
	Instance_READY Instance_State = 1
	// The instance is stopped. Instance name and IP resources are preserved.
	Instance_STOPPED Instance_State = 2
	// The instance is being created.
	Instance_CREATING Instance_State = 3
	// The instance is being deleted.
	Instance_DELETING Instance_State = 4
	// The instance is down for maintenance.
	Instance_MAINTENANCE Instance_State = 5
	// The creation of the instance failed or a fatal error occurred during
	// an operation on the instance.
	// Note: Instances in this state would tried to be auto-repaired. And
	// Customers should be able to restart, update or delete these instances.
	Instance_FAILED Instance_State = 6
	// Index 7 is used in the producer apis for ROLLED_BACK state. Keeping that
	// index unused in case that state also needs to exposed via consumer apis
	// in future.
	// The instance has been configured to sync data from some other source.
	Instance_BOOTSTRAPPING Instance_State = 8
	// The instance is being promoted.
	Instance_PROMOTING Instance_State = 9
)

func (Instance_State) Descriptor

func (Instance_State) Enum

func (x Instance_State) Enum() *Instance_State

func (Instance_State) EnumDescriptor deprecated

func (Instance_State) EnumDescriptor() ([]byte, []int)

Deprecated: Use Instance_State.Descriptor instead.

func (Instance_State) Number

func (Instance_State) String

func (x Instance_State) String() string

func (Instance_State) Type

type MigrationSource

type MigrationSource struct {

	// Output only. The host and port of the on-premises instance in host:port
	// format
	HostPort string `protobuf:"bytes,1,opt,name=host_port,json=hostPort,proto3" json:"host_port,omitempty"`
	// Output only. Place holder for the external source identifier(e.g DMS job
	// name) that created the cluster.
	ReferenceId string `protobuf:"bytes,2,opt,name=reference_id,json=referenceId,proto3" json:"reference_id,omitempty"`
	// Output only. Type of migration source.
	SourceType MigrationSource_MigrationSourceType `` /* 164-byte string literal not displayed */
	// contains filtered or unexported fields
}

Subset of the source instance configuration that is available when reading the cluster resource.

func (*MigrationSource) Descriptor deprecated

func (*MigrationSource) Descriptor() ([]byte, []int)

Deprecated: Use MigrationSource.ProtoReflect.Descriptor instead.

func (*MigrationSource) GetHostPort

func (x *MigrationSource) GetHostPort() string

func (*MigrationSource) GetReferenceId

func (x *MigrationSource) GetReferenceId() string

func (*MigrationSource) GetSourceType

func (*MigrationSource) ProtoMessage

func (*MigrationSource) ProtoMessage()

func (*MigrationSource) ProtoReflect

func (x *MigrationSource) ProtoReflect() protoreflect.Message

func (*MigrationSource) Reset

func (x *MigrationSource) Reset()

func (*MigrationSource) String

func (x *MigrationSource) String() string

type MigrationSource_MigrationSourceType

type MigrationSource_MigrationSourceType int32

Denote the type of migration source that created this cluster.

const (
	// Migration source is unknown.
	MigrationSource_MIGRATION_SOURCE_TYPE_UNSPECIFIED MigrationSource_MigrationSourceType = 0
	// DMS source means the cluster was created via DMS migration job.
	MigrationSource_DMS MigrationSource_MigrationSourceType = 1
)

func (MigrationSource_MigrationSourceType) Descriptor

func (MigrationSource_MigrationSourceType) Enum

func (MigrationSource_MigrationSourceType) EnumDescriptor deprecated

func (MigrationSource_MigrationSourceType) EnumDescriptor() ([]byte, []int)

Deprecated: Use MigrationSource_MigrationSourceType.Descriptor instead.

func (MigrationSource_MigrationSourceType) Number

func (MigrationSource_MigrationSourceType) String

func (MigrationSource_MigrationSourceType) Type

type SslConfig

type SslConfig struct {

	// Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.
	SslMode SslConfig_SslMode `` /* 137-byte string literal not displayed */
	// Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is
	// supported currently, and is the default value.
	CaSource SslConfig_CaSource `` /* 141-byte string literal not displayed */
	// contains filtered or unexported fields
}

SSL configuration for an AlloyDB Cluster.

func (*SslConfig) Descriptor deprecated

func (*SslConfig) Descriptor() ([]byte, []int)

Deprecated: Use SslConfig.ProtoReflect.Descriptor instead.

func (*SslConfig) GetCaSource

func (x *SslConfig) GetCaSource() SslConfig_CaSource

func (*SslConfig) GetSslMode

func (x *SslConfig) GetSslMode() SslConfig_SslMode

func (*SslConfig) ProtoMessage

func (*SslConfig) ProtoMessage()

func (*SslConfig) ProtoReflect

func (x *SslConfig) ProtoReflect() protoreflect.Message

func (*SslConfig) Reset

func (x *SslConfig) Reset()

func (*SslConfig) String

func (x *SslConfig) String() string

type SslConfig_CaSource

type SslConfig_CaSource int32

Certificate Authority (CA) source for SSL/TLS certificates.

const (
	// Certificate Authority (CA) source not specified. Defaults to
	// CA_SOURCE_MANAGED.
	SslConfig_CA_SOURCE_UNSPECIFIED SslConfig_CaSource = 0
	// Certificate Authority (CA) managed by the AlloyDB Cluster.
	SslConfig_CA_SOURCE_MANAGED SslConfig_CaSource = 1
)

func (SslConfig_CaSource) Descriptor

func (SslConfig_CaSource) Enum

func (SslConfig_CaSource) EnumDescriptor deprecated

func (SslConfig_CaSource) EnumDescriptor() ([]byte, []int)

Deprecated: Use SslConfig_CaSource.Descriptor instead.

func (SslConfig_CaSource) Number

func (SslConfig_CaSource) String

func (x SslConfig_CaSource) String() string

func (SslConfig_CaSource) Type

type SslConfig_SslMode

type SslConfig_SslMode int32

SSL mode options.

const (
	// SSL mode not specified. Defaults to SSL_MODE_ALLOW.
	SslConfig_SSL_MODE_UNSPECIFIED SslConfig_SslMode = 0
	// SSL connections are optional. CA verification not enforced.
	SslConfig_SSL_MODE_ALLOW SslConfig_SslMode = 1
	// SSL connections are required. CA verification not enforced.
	// Clients may use locally self-signed certificates (default psql client
	// behavior).
	SslConfig_SSL_MODE_REQUIRE SslConfig_SslMode = 2
	// SSL connections are required. CA verification enforced.
	// Clients must have certificates signed by a Cluster CA, e.g. via
	// GenerateClientCertificate.
	SslConfig_SSL_MODE_VERIFY_CA SslConfig_SslMode = 3
)

func (SslConfig_SslMode) Descriptor

func (SslConfig_SslMode) Enum

func (SslConfig_SslMode) EnumDescriptor deprecated

func (SslConfig_SslMode) EnumDescriptor() ([]byte, []int)

Deprecated: Use SslConfig_SslMode.Descriptor instead.

func (SslConfig_SslMode) Number

func (SslConfig_SslMode) String

func (x SslConfig_SslMode) String() string

func (SslConfig_SslMode) Type

type UserPassword

type UserPassword struct {

	// The database username.
	User string `protobuf:"bytes,1,opt,name=user,proto3" json:"user,omitempty"`
	// The initial password for the user.
	Password string `protobuf:"bytes,2,opt,name=password,proto3" json:"password,omitempty"`
	// contains filtered or unexported fields
}

The username/password for a database user. Used for specifying initial users at cluster creation time.

func (*UserPassword) Descriptor deprecated

func (*UserPassword) Descriptor() ([]byte, []int)

Deprecated: Use UserPassword.ProtoReflect.Descriptor instead.

func (*UserPassword) GetPassword

func (x *UserPassword) GetPassword() string

func (*UserPassword) GetUser

func (x *UserPassword) GetUser() string

func (*UserPassword) ProtoMessage

func (*UserPassword) ProtoMessage()

func (*UserPassword) ProtoReflect

func (x *UserPassword) ProtoReflect() protoreflect.Message

func (*UserPassword) Reset

func (x *UserPassword) Reset()

func (*UserPassword) String

func (x *UserPassword) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL