Package cloud.google.com/go/alloydb/apiv1beta/alloydbpb (v0.2.1)

Version 0.2.1

• 1.12.1 (latest)
• 1.12.0
• 1.11.0
• 1.10.7
• 1.9.0
• 1.8.1
• 1.7.0
• 1.6.3
• 1.4.0
• 1.3.0
• 1.2.1
• 1.1.0
• 1.0.1
• 0.2.1
• 0.1.0

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Note: To get more information about this package, such as access to older versions, view this package on pkg.go.dev.

Variables

DatabaseVersion_name, DatabaseVersion_value

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.

InstanceView_name, InstanceView_value

var (
	InstanceView_name = map[int32]string{
		0: "INSTANCE_VIEW_UNSPECIFIED",
		1: "INSTANCE_VIEW_BASIC",
		2: "INSTANCE_VIEW_FULL",
	}
	InstanceView_value = map[string]int32{
		"INSTANCE_VIEW_UNSPECIFIED": 0,
		"INSTANCE_VIEW_BASIC":       1,
		"INSTANCE_VIEW_FULL":        2,
	}
)

Enum value maps for InstanceView.

MigrationSource_MigrationSourceType_name, MigrationSource_MigrationSourceType_value

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.

EncryptionInfo_Type_name, EncryptionInfo_Type_value

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.

SslConfig_SslMode_name, SslConfig_SslMode_value

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.

SslConfig_CaSource_name, SslConfig_CaSource_value

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.

Cluster_State_name, Cluster_State_value

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.

Cluster_ClusterType_name, Cluster_ClusterType_value

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.

Instance_State_name, Instance_State_value

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.

Instance_InstanceType_name, Instance_InstanceType_value

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.

Instance_AvailabilityType_name, Instance_AvailabilityType_value

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.

Backup_State_name, Backup_State_value

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.

Backup_Type_name, Backup_Type_value

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.

SupportedDatabaseFlag_ValueType_name, SupportedDatabaseFlag_ValueType_value

var (
	SupportedDatabaseFlag_ValueType_name = map[int32]string{
		0: "VALUE_TYPE_UNSPECIFIED",
		1: "STRING",
		2: "INTEGER",
		3: "FLOAT",
		4: "NONE",
	}
	SupportedDatabaseFlag_ValueType_value = map[string]int32{
		"VALUE_TYPE_UNSPECIFIED": 0,
		"STRING":                 1,
		"INTEGER":                2,
		"FLOAT":                  3,
		"NONE":                   4,
	}
)

Enum value maps for SupportedDatabaseFlag_ValueType.

BatchCreateInstanceStatus_State_name, BatchCreateInstanceStatus_State_value

var (
	BatchCreateInstanceStatus_State_name = map[int32]string{
		0: "STATE_UNSPECIFIED",
		1: "PENDING_CREATE",
		2: "READY",
		3: "CREATING",
		4: "DELETING",
		5: "FAILED",
		6: "ROLLED_BACK",
	}
	BatchCreateInstanceStatus_State_value = map[string]int32{
		"STATE_UNSPECIFIED": 0,
		"PENDING_CREATE":    1,
		"READY":             2,
		"CREATING":          3,
		"DELETING":          4,
		"FAILED":            5,
		"ROLLED_BACK":       6,
	}
)

Enum value maps for BatchCreateInstanceStatus_State.

File_google_cloud_alloydb_v1beta_resources_proto

var File_google_cloud_alloydb_v1beta_resources_proto protoreflect.FileDescriptor

File_google_cloud_alloydb_v1beta_service_proto

var File_google_cloud_alloydb_v1beta_service_proto protoreflect.FileDescriptor

Functions

func RegisterAlloyDBAdminServer

func RegisterAlloyDBAdminServer(s *grpc.Server, srv AlloyDBAdminServer)

AlloyDBAdminClient

type AlloyDBAdminClient interface {
	// Lists Clusters in a given project and location.
	ListClusters(ctx context.Context, in *ListClustersRequest, opts ...grpc.CallOption) (*ListClustersResponse, error)
	// Gets details of a single Cluster.
	GetCluster(ctx context.Context, in *GetClusterRequest, opts ...grpc.CallOption) (*Cluster, error)
	// Creates a new Cluster in a given project and location.
	CreateCluster(ctx context.Context, in *CreateClusterRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Updates the parameters of a single Cluster.
	UpdateCluster(ctx context.Context, in *UpdateClusterRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Deletes a single Cluster.
	DeleteCluster(ctx context.Context, in *DeleteClusterRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Promotes a SECONDARY cluster. This turns down replication
	// from the PRIMARY cluster and promotes a secondary cluster
	// into its own standalone cluster.
	// Imperative only.
	PromoteCluster(ctx context.Context, in *PromoteClusterRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Creates a new Cluster in a given project and location, with a volume
	// restored from the provided source, either a backup ID or a point-in-time
	// and a source cluster.
	RestoreCluster(ctx context.Context, in *RestoreClusterRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Creates a cluster of type SECONDARY in the given location using
	// the primary cluster as the source.
	CreateSecondaryCluster(ctx context.Context, in *CreateSecondaryClusterRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Lists Instances in a given project and location.
	ListInstances(ctx context.Context, in *ListInstancesRequest, opts ...grpc.CallOption) (*ListInstancesResponse, error)
	// Gets details of a single Instance.
	GetInstance(ctx context.Context, in *GetInstanceRequest, opts ...grpc.CallOption) (*Instance, error)
	// Creates a new Instance in a given project and location.
	CreateInstance(ctx context.Context, in *CreateInstanceRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Creates a new SECONDARY Instance in a given project and location.
	CreateSecondaryInstance(ctx context.Context, in *CreateSecondaryInstanceRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Creates new instances under the given project, location and cluster.
	// There can be only one primary instance in a cluster. If the primary
	// instance exists in the cluster as well as this request, then API will
	// throw an error.
	// The primary instance should exist before any read pool instance is
	// created. If the primary instance is a part of the request payload, then
	// the API will take care of creating instances in the correct order.
	// This method is here to support Google-internal use cases, and is not meant
	// for external customers to consume. Please do not start relying on it; its
	// behavior is subject to change without notice.
	BatchCreateInstances(ctx context.Context, in *BatchCreateInstancesRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Updates the parameters of a single Instance.
	UpdateInstance(ctx context.Context, in *UpdateInstanceRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Deletes a single Instance.
	DeleteInstance(ctx context.Context, in *DeleteInstanceRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Forces a Failover for a highly available instance.
	// Failover promotes the HA standby instance as the new primary.
	// Imperative only.
	FailoverInstance(ctx context.Context, in *FailoverInstanceRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Restart an Instance in a cluster.
	// Imperative only.
	RestartInstance(ctx context.Context, in *RestartInstanceRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Lists Backups in a given project and location.
	ListBackups(ctx context.Context, in *ListBackupsRequest, opts ...grpc.CallOption) (*ListBackupsResponse, error)
	// Gets details of a single Backup.
	GetBackup(ctx context.Context, in *GetBackupRequest, opts ...grpc.CallOption) (*Backup, error)
	// Creates a new Backup in a given project and location.
	CreateBackup(ctx context.Context, in *CreateBackupRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Updates the parameters of a single Backup.
	UpdateBackup(ctx context.Context, in *UpdateBackupRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Deletes a single Backup.
	DeleteBackup(ctx context.Context, in *DeleteBackupRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
	// Lists SupportedDatabaseFlags for a given project and location.
	ListSupportedDatabaseFlags(ctx context.Context, in *ListSupportedDatabaseFlagsRequest, opts ...grpc.CallOption) (*ListSupportedDatabaseFlagsResponse, error)
	// Generate a client certificate signed by a Cluster CA.
	// The sole purpose of this endpoint is to support the Auth Proxy client and
	// the endpoint's behavior is subject to change without notice, so do not rely
	// on its behavior remaining constant. Future changes will not break the Auth
	// Proxy client.
	GenerateClientCertificate(ctx context.Context, in *GenerateClientCertificateRequest, opts ...grpc.CallOption) (*GenerateClientCertificateResponse, error)
	// Get instance metadata used for a connection.
	GetConnectionInfo(ctx context.Context, in *GetConnectionInfoRequest, opts ...grpc.CallOption) (*ConnectionInfo, error)
}

AlloyDBAdminClient is the client API for AlloyDBAdmin service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewAlloyDBAdminClient

func NewAlloyDBAdminClient(cc grpc.ClientConnInterface) AlloyDBAdminClient

AlloyDBAdminServer

type AlloyDBAdminServer interface {
	// Lists Clusters in a given project and location.
	ListClusters(context.Context, *ListClustersRequest) (*ListClustersResponse, error)
	// Gets details of a single Cluster.
	GetCluster(context.Context, *GetClusterRequest) (*Cluster, error)
	// Creates a new Cluster in a given project and location.
	CreateCluster(context.Context, *CreateClusterRequest) (*longrunningpb.Operation, error)
	// Updates the parameters of a single Cluster.
	UpdateCluster(context.Context, *UpdateClusterRequest) (*longrunningpb.Operation, error)
	// Deletes a single Cluster.
	DeleteCluster(context.Context, *DeleteClusterRequest) (*longrunningpb.Operation, error)
	// Promotes a SECONDARY cluster. This turns down replication
	// from the PRIMARY cluster and promotes a secondary cluster
	// into its own standalone cluster.
	// Imperative only.
	PromoteCluster(context.Context, *PromoteClusterRequest) (*longrunningpb.Operation, error)
	// Creates a new Cluster in a given project and location, with a volume
	// restored from the provided source, either a backup ID or a point-in-time
	// and a source cluster.
	RestoreCluster(context.Context, *RestoreClusterRequest) (*longrunningpb.Operation, error)
	// Creates a cluster of type SECONDARY in the given location using
	// the primary cluster as the source.
	CreateSecondaryCluster(context.Context, *CreateSecondaryClusterRequest) (*longrunningpb.Operation, error)
	// Lists Instances in a given project and location.
	ListInstances(context.Context, *ListInstancesRequest) (*ListInstancesResponse, error)
	// Gets details of a single Instance.
	GetInstance(context.Context, *GetInstanceRequest) (*Instance, error)
	// Creates a new Instance in a given project and location.
	CreateInstance(context.Context, *CreateInstanceRequest) (*longrunningpb.Operation, error)
	// Creates a new SECONDARY Instance in a given project and location.
	CreateSecondaryInstance(context.Context, *CreateSecondaryInstanceRequest) (*longrunningpb.Operation, error)
	// Creates new instances under the given project, location and cluster.
	// There can be only one primary instance in a cluster. If the primary
	// instance exists in the cluster as well as this request, then API will
	// throw an error.
	// The primary instance should exist before any read pool instance is
	// created. If the primary instance is a part of the request payload, then
	// the API will take care of creating instances in the correct order.
	// This method is here to support Google-internal use cases, and is not meant
	// for external customers to consume. Please do not start relying on it; its
	// behavior is subject to change without notice.
	BatchCreateInstances(context.Context, *BatchCreateInstancesRequest) (*longrunningpb.Operation, error)
	// Updates the parameters of a single Instance.
	UpdateInstance(context.Context, *UpdateInstanceRequest) (*longrunningpb.Operation, error)
	// Deletes a single Instance.
	DeleteInstance(context.Context, *DeleteInstanceRequest) (*longrunningpb.Operation, error)
	// Forces a Failover for a highly available instance.
	// Failover promotes the HA standby instance as the new primary.
	// Imperative only.
	FailoverInstance(context.Context, *FailoverInstanceRequest) (*longrunningpb.Operation, error)
	// Restart an Instance in a cluster.
	// Imperative only.
	RestartInstance(context.Context, *RestartInstanceRequest) (*longrunningpb.Operation, error)
	// Lists Backups in a given project and location.
	ListBackups(context.Context, *ListBackupsRequest) (*ListBackupsResponse, error)
	// Gets details of a single Backup.
	GetBackup(context.Context, *GetBackupRequest) (*Backup, error)
	// Creates a new Backup in a given project and location.
	CreateBackup(context.Context, *CreateBackupRequest) (*longrunningpb.Operation, error)
	// Updates the parameters of a single Backup.
	UpdateBackup(context.Context, *UpdateBackupRequest) (*longrunningpb.Operation, error)
	// Deletes a single Backup.
	DeleteBackup(context.Context, *DeleteBackupRequest) (*longrunningpb.Operation, error)
	// Lists SupportedDatabaseFlags for a given project and location.
	ListSupportedDatabaseFlags(context.Context, *ListSupportedDatabaseFlagsRequest) (*ListSupportedDatabaseFlagsResponse, error)
	// Generate a client certificate signed by a Cluster CA.
	// The sole purpose of this endpoint is to support the Auth Proxy client and
	// the endpoint's behavior is subject to change without notice, so do not rely
	// on its behavior remaining constant. Future changes will not break the Auth
	// Proxy client.
	GenerateClientCertificate(context.Context, *GenerateClientCertificateRequest) (*GenerateClientCertificateResponse, error)
	// Get instance metadata used for a connection.
	GetConnectionInfo(context.Context, *GetConnectionInfoRequest) (*ConnectionInfo, error)
}

AlloyDBAdminServer is the server API for AlloyDBAdmin service.

AutomatedBackupPolicy

type AutomatedBackupPolicy struct {
	Schedule isAutomatedBackupPolicy_Schedule `protobuf_oneof:"schedule"`

	Retention isAutomatedBackupPolicy_Retention `protobuf_oneof:"retention"`

	Enabled *bool `protobuf:"varint,1,opt,name=enabled,proto3,oneof" json:"enabled,omitempty"`

	BackupWindow *durationpb.Duration `protobuf:"bytes,3,opt,name=backup_window,json=backupWindow,proto3" json:"backup_window,omitempty"`

	EncryptionConfig *EncryptionConfig `protobuf:"bytes,8,opt,name=encryption_config,json=encryptionConfig,proto3" json:"encryption_config,omitempty"`

	Location string `protobuf:"bytes,6,opt,name=location,proto3" json:"location,omitempty"`

	Labels map[string]string "" /* 153 byte string literal not displayed */

}

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

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 (x *AutomatedBackupPolicy) GetQuantityBasedRetention() *AutomatedBackupPolicy_QuantityBasedRetention

func (*AutomatedBackupPolicy) GetRetention

func (m *AutomatedBackupPolicy) GetRetention() isAutomatedBackupPolicy_Retention

func (*AutomatedBackupPolicy) GetSchedule

func (m *AutomatedBackupPolicy) GetSchedule() isAutomatedBackupPolicy_Schedule

func (*AutomatedBackupPolicy) GetTimeBasedRetention

func (x *AutomatedBackupPolicy) GetTimeBasedRetention() *AutomatedBackupPolicy_TimeBasedRetention

func (*AutomatedBackupPolicy) GetWeeklySchedule

func (x *AutomatedBackupPolicy) GetWeeklySchedule() *AutomatedBackupPolicy_WeeklySchedule

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

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

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

Deprecated: Use AutomatedBackupPolicy_QuantityBasedRetention.ProtoReflect.Descriptor instead.

func (*AutomatedBackupPolicy_QuantityBasedRetention) GetCount

func (x *AutomatedBackupPolicy_QuantityBasedRetention) GetCount() int32

func (*AutomatedBackupPolicy_QuantityBasedRetention) ProtoMessage

func (*AutomatedBackupPolicy_QuantityBasedRetention) ProtoMessage()

func (*AutomatedBackupPolicy_QuantityBasedRetention) ProtoReflect

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

func (*AutomatedBackupPolicy_QuantityBasedRetention) Reset

func (x *AutomatedBackupPolicy_QuantityBasedRetention) Reset()

func (*AutomatedBackupPolicy_QuantityBasedRetention) String

func (x *AutomatedBackupPolicy_QuantityBasedRetention) String() string

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"`
}

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

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

Deprecated: Use AutomatedBackupPolicy_TimeBasedRetention.ProtoReflect.Descriptor instead.

func (*AutomatedBackupPolicy_TimeBasedRetention) GetRetentionPeriod

func (x *AutomatedBackupPolicy_TimeBasedRetention) GetRetentionPeriod() *durationpb.Duration

func (*AutomatedBackupPolicy_TimeBasedRetention) ProtoMessage

func (*AutomatedBackupPolicy_TimeBasedRetention) ProtoMessage()

func (*AutomatedBackupPolicy_TimeBasedRetention) ProtoReflect

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

func (*AutomatedBackupPolicy_TimeBasedRetention) Reset

func (x *AutomatedBackupPolicy_TimeBasedRetention) Reset()

func (*AutomatedBackupPolicy_TimeBasedRetention) String

func (x *AutomatedBackupPolicy_TimeBasedRetention) String() string

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"`
}

AutomatedBackupPolicy_WeeklySchedule

type AutomatedBackupPolicy_WeeklySchedule struct {
	StartTimes []*timeofday.TimeOfDay `protobuf:"bytes,1,rep,name=start_times,json=startTimes,proto3" json:"start_times,omitempty"`

	DaysOfWeek []dayofweek.DayOfWeek "" /* 128 byte string literal not displayed */

}

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

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

Deprecated: Use AutomatedBackupPolicy_WeeklySchedule.ProtoReflect.Descriptor instead.

func (*AutomatedBackupPolicy_WeeklySchedule) GetDaysOfWeek

func (x *AutomatedBackupPolicy_WeeklySchedule) GetDaysOfWeek() []dayofweek.DayOfWeek

func (*AutomatedBackupPolicy_WeeklySchedule) GetStartTimes

func (x *AutomatedBackupPolicy_WeeklySchedule) GetStartTimes() []*timeofday.TimeOfDay

func (*AutomatedBackupPolicy_WeeklySchedule) ProtoMessage

func (*AutomatedBackupPolicy_WeeklySchedule) ProtoMessage()

func (*AutomatedBackupPolicy_WeeklySchedule) ProtoReflect

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

func (*AutomatedBackupPolicy_WeeklySchedule) Reset

func (x *AutomatedBackupPolicy_WeeklySchedule) Reset()

func (*AutomatedBackupPolicy_WeeklySchedule) String

func (x *AutomatedBackupPolicy_WeeklySchedule) String() string

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"`
}

Backup

type Backup struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`

	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`

	Uid string `protobuf:"bytes,3,opt,name=uid,proto3" json:"uid,omitempty"`

	CreateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`

	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`

	DeleteTime *timestamppb.Timestamp `protobuf:"bytes,15,opt,name=delete_time,json=deleteTime,proto3" json:"delete_time,omitempty"`

	Labels map[string]string "" /* 153 byte string literal not displayed */

	State Backup_State `protobuf:"varint,7,opt,name=state,proto3,enum=google.cloud.alloydb.v1beta.Backup_State" json:"state,omitempty"`

	Type Backup_Type `protobuf:"varint,8,opt,name=type,proto3,enum=google.cloud.alloydb.v1beta.Backup_Type" json:"type,omitempty"`

	Description string `protobuf:"bytes,9,opt,name=description,proto3" json:"description,omitempty"`

	ClusterUid string `protobuf:"bytes,18,opt,name=cluster_uid,json=clusterUid,proto3" json:"cluster_uid,omitempty"`

	ClusterName string `protobuf:"bytes,10,opt,name=cluster_name,json=clusterName,proto3" json:"cluster_name,omitempty"`

	Reconciling bool `protobuf:"varint,11,opt,name=reconciling,proto3" json:"reconciling,omitempty"`

	EncryptionConfig *EncryptionConfig `protobuf:"bytes,12,opt,name=encryption_config,json=encryptionConfig,proto3" json:"encryption_config,omitempty"`

	EncryptionInfo *EncryptionInfo `protobuf:"bytes,13,opt,name=encryption_info,json=encryptionInfo,proto3" json:"encryption_info,omitempty"`

	Etag string `protobuf:"bytes,14,opt,name=etag,proto3" json:"etag,omitempty"`

	Annotations map[string]string "" /* 164 byte string literal not displayed */

	SizeBytes int64 `protobuf:"varint,17,opt,name=size_bytes,json=sizeBytes,proto3" json:"size_bytes,omitempty"`

	ExpiryTime *timestamppb.Timestamp `protobuf:"bytes,19,opt,name=expiry_time,json=expiryTime,proto3" json:"expiry_time,omitempty"`

}

Message describing Backup object

func (*Backup) Descriptor

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

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

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

Backup_State

type Backup_State int32

Backup State

Backup_STATE_UNSPECIFIED, Backup_READY, Backup_CREATING, Backup_FAILED, Backup_DELETING

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) Descriptor() protoreflect.EnumDescriptor

func (Backup_State) Enum

func (x Backup_State) Enum() *Backup_State

func (Backup_State) EnumDescriptor

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

Deprecated: Use Backup_State.Descriptor instead.

func (Backup_State) Number

func (x Backup_State) Number() protoreflect.EnumNumber

func (Backup_State) String

func (x Backup_State) String() string

func (Backup_State) Type

func (Backup_State) Type() protoreflect.EnumType

Backup_Type

type Backup_Type int32

Backup Type

Backup_TYPE_UNSPECIFIED, Backup_ON_DEMAND, Backup_AUTOMATED, Backup_CONTINUOUS

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) Descriptor() protoreflect.EnumDescriptor

func (Backup_Type) Enum

func (x Backup_Type) Enum() *Backup_Type

func (Backup_Type) EnumDescriptor

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

func (Backup_Type) Type() protoreflect.EnumType

BatchCreateInstanceStatus

type BatchCreateInstanceStatus struct {
	State BatchCreateInstanceStatus_State "" /* 129 byte string literal not displayed */

	ErrorMsg string `protobuf:"bytes,2,opt,name=error_msg,json=errorMsg,proto3" json:"error_msg,omitempty"`

	Error *status.Status        `protobuf:"bytes,4,opt,name=error,proto3" json:"error,omitempty"`
	Type  Instance_InstanceType `protobuf:"varint,3,opt,name=type,proto3,enum=google.cloud.alloydb.v1beta.Instance_InstanceType" json:"type,omitempty"`

}

Message for current status of an instance in the BatchCreateInstances operation. For example, lets say a BatchCreateInstances workflow has 4 instances, Instance1 through Instance4. Lets also assume that 2 instances succeeded but the third failed to create and the 4th was never picked up for creation because of failure of the previous one. Then, resulting states would look something like:

1. Instance1 = ROLLED_BACK
2. Instance2 = ROLLED_BACK
3. Instance3 = FAILED
4. Instance4 = FAILED

However, while the operation is running, the instance might be in other states including PENDING_CREATE, ACTIVE, DELETING and CREATING. The states / do not get further updated once the operation is done.

func (*BatchCreateInstanceStatus) Descriptor

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

Deprecated: Use BatchCreateInstanceStatus.ProtoReflect.Descriptor instead.

func (*BatchCreateInstanceStatus) GetError

func (x *BatchCreateInstanceStatus) GetError() *status.Status

func (*BatchCreateInstanceStatus) GetErrorMsg

func (x *BatchCreateInstanceStatus) GetErrorMsg() string

func (*BatchCreateInstanceStatus) GetState

func (x *BatchCreateInstanceStatus) GetState() BatchCreateInstanceStatus_State

func (*BatchCreateInstanceStatus) GetType

func (x *BatchCreateInstanceStatus) GetType() Instance_InstanceType

func (*BatchCreateInstanceStatus) ProtoMessage

func (*BatchCreateInstanceStatus) ProtoMessage()

func (*BatchCreateInstanceStatus) ProtoReflect

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

func (*BatchCreateInstanceStatus) Reset

func (x *BatchCreateInstanceStatus) Reset()

func (*BatchCreateInstanceStatus) String

func (x *BatchCreateInstanceStatus) String() string

BatchCreateInstanceStatus_State

type BatchCreateInstanceStatus_State int32

State contains all valid instance states for the BatchCreateInstances operation. This is mainly used for status reporting through the LRO metadata.

BatchCreateInstanceStatus_STATE_UNSPECIFIED, BatchCreateInstanceStatus_PENDING_CREATE, BatchCreateInstanceStatus_READY, BatchCreateInstanceStatus_CREATING, BatchCreateInstanceStatus_DELETING, BatchCreateInstanceStatus_FAILED, BatchCreateInstanceStatus_ROLLED_BACK

const (
	// The state of the instance is unknown.
	BatchCreateInstanceStatus_STATE_UNSPECIFIED BatchCreateInstanceStatus_State = 0
	// Instance is pending creation and has not yet been picked up for
	// processsing in the backend.
	BatchCreateInstanceStatus_PENDING_CREATE BatchCreateInstanceStatus_State = 1
	// The instance is active and running.
	BatchCreateInstanceStatus_READY BatchCreateInstanceStatus_State = 2
	// The instance is being created.
	BatchCreateInstanceStatus_CREATING BatchCreateInstanceStatus_State = 3
	// The instance is being deleted.
	BatchCreateInstanceStatus_DELETING BatchCreateInstanceStatus_State = 4
	// The creation of the instance failed or a fatal error occurred during
	// an operation on the instance or a batch of instances.
	BatchCreateInstanceStatus_FAILED BatchCreateInstanceStatus_State = 5
	// The instance was created successfully, but was rolled back and deleted
	// due to some other failure during BatchCreateInstances operation.
	BatchCreateInstanceStatus_ROLLED_BACK BatchCreateInstanceStatus_State = 6
)

func (BatchCreateInstanceStatus_State) Descriptor

func (BatchCreateInstanceStatus_State) Descriptor() protoreflect.EnumDescriptor

func (BatchCreateInstanceStatus_State) Enum

func (x BatchCreateInstanceStatus_State) Enum() *BatchCreateInstanceStatus_State

func (BatchCreateInstanceStatus_State) EnumDescriptor

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

Deprecated: Use BatchCreateInstanceStatus_State.Descriptor instead.

func (BatchCreateInstanceStatus_State) Number

func (x BatchCreateInstanceStatus_State) Number() protoreflect.EnumNumber

func (BatchCreateInstanceStatus_State) String

func (x BatchCreateInstanceStatus_State) String() string

func (BatchCreateInstanceStatus_State) Type

func (BatchCreateInstanceStatus_State) Type() protoreflect.EnumType

BatchCreateInstancesMetadata

type BatchCreateInstancesMetadata struct {
	InstanceTargets []string `protobuf:"bytes,1,rep,name=instance_targets,json=instanceTargets,proto3" json:"instance_targets,omitempty"`

	InstanceStatuses map[string]*BatchCreateInstanceStatus "" /* 197 byte string literal not displayed */

}

Message for metadata that is specific to BatchCreateInstances API.

func (*BatchCreateInstancesMetadata) Descriptor

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

Deprecated: Use BatchCreateInstancesMetadata.ProtoReflect.Descriptor instead.

func (*BatchCreateInstancesMetadata) GetInstanceStatuses

func (x *BatchCreateInstancesMetadata) GetInstanceStatuses() map[string]*BatchCreateInstanceStatus

func (*BatchCreateInstancesMetadata) GetInstanceTargets

func (x *BatchCreateInstancesMetadata) GetInstanceTargets() []string

func (*BatchCreateInstancesMetadata) ProtoMessage

func (*BatchCreateInstancesMetadata) ProtoMessage()

func (*BatchCreateInstancesMetadata) ProtoReflect

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

func (*BatchCreateInstancesMetadata) Reset

func (x *BatchCreateInstancesMetadata) Reset()

func (*BatchCreateInstancesMetadata) String

func (x *BatchCreateInstancesMetadata) String() string

BatchCreateInstancesRequest

type BatchCreateInstancesRequest struct {

	// Required. The name of the parent resource.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. Resources being created.
	Requests *CreateInstanceRequests `protobuf:"bytes,2,opt,name=requests,proto3" json:"requests,omitempty"`
	// Optional. An optional request ID to identify requests. Specify a unique
	// request ID so that if you must retry your request, the server will know to
	// ignore the request if it has already been completed. The server will
	// guarantee that for at least 60 minutes since the first request.
	//
	// For example, consider a situation where you make an initial request and
	// the request times out. If you make the request again with the same request
	// ID, the server can check if original operation with the same request ID
	// was received, and if so, will ignore the second request. This prevents
	// clients from accidentally creating duplicate commitments.
	//
	// The request ID must be a valid UUID with the exception that zero UUID is
	// not supported (00000000-0000-0000-0000-000000000000).
	RequestId string `protobuf:"bytes,3,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// contains filtered or unexported fields
}

Message for creating a batch of instances under the specified cluster.

func (*BatchCreateInstancesRequest) Descriptor

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

Deprecated: Use BatchCreateInstancesRequest.ProtoReflect.Descriptor instead.

func (*BatchCreateInstancesRequest) GetParent

func (x *BatchCreateInstancesRequest) GetParent() string

func (*BatchCreateInstancesRequest) GetRequestId

func (x *BatchCreateInstancesRequest) GetRequestId() string

func (*BatchCreateInstancesRequest) GetRequests

func (x *BatchCreateInstancesRequest) GetRequests() *CreateInstanceRequests

func (*BatchCreateInstancesRequest) ProtoMessage

func (*BatchCreateInstancesRequest) ProtoMessage()

func (*BatchCreateInstancesRequest) ProtoReflect

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

func (*BatchCreateInstancesRequest) Reset

func (x *BatchCreateInstancesRequest) Reset()

func (*BatchCreateInstancesRequest) String

func (x *BatchCreateInstancesRequest) String() string

BatchCreateInstancesResponse

type BatchCreateInstancesResponse struct {

	// Created instances.
	Instances []*Instance `protobuf:"bytes,1,rep,name=instances,proto3" json:"instances,omitempty"`
	// contains filtered or unexported fields
}

Message for creating batches of instances in a cluster.

func (*BatchCreateInstancesResponse) Descriptor

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

Deprecated: Use BatchCreateInstancesResponse.ProtoReflect.Descriptor instead.

func (*BatchCreateInstancesResponse) GetInstances

func (x *BatchCreateInstancesResponse) GetInstances() []*Instance

func (*BatchCreateInstancesResponse) ProtoMessage

func (*BatchCreateInstancesResponse) ProtoMessage()

func (*BatchCreateInstancesResponse) ProtoReflect

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

func (*BatchCreateInstancesResponse) Reset

func (x *BatchCreateInstancesResponse) Reset()

func (*BatchCreateInstancesResponse) String

func (x *BatchCreateInstancesResponse) String() string

Cluster

type Cluster struct {
	Source isCluster_Source `protobuf_oneof:"source"`

	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`

	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`

	Uid string `protobuf:"bytes,3,opt,name=uid,proto3" json:"uid,omitempty"`

	CreateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`

	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`

	DeleteTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=delete_time,json=deleteTime,proto3" json:"delete_time,omitempty"`

	Labels map[string]string "" /* 153 byte string literal not displayed */

	State Cluster_State `protobuf:"varint,8,opt,name=state,proto3,enum=google.cloud.alloydb.v1beta.Cluster_State" json:"state,omitempty"`

	ClusterType Cluster_ClusterType "" /* 149 byte string literal not displayed */

	DatabaseVersion DatabaseVersion "" /* 156 byte string literal not displayed */

	Network string `protobuf:"bytes,10,opt,name=network,proto3" json:"network,omitempty"`

	Etag string `protobuf:"bytes,11,opt,name=etag,proto3" json:"etag,omitempty"`

	Annotations map[string]string "" /* 164 byte string literal not displayed */

	Reconciling bool `protobuf:"varint,13,opt,name=reconciling,proto3" json:"reconciling,omitempty"`

	InitialUser *UserPassword `protobuf:"bytes,14,opt,name=initial_user,json=initialUser,proto3" json:"initial_user,omitempty"`

	AutomatedBackupPolicy *AutomatedBackupPolicy "" /* 127 byte string literal not displayed */

	SslConfig *SslConfig `protobuf:"bytes,18,opt,name=ssl_config,json=sslConfig,proto3" json:"ssl_config,omitempty"`

	EncryptionConfig *EncryptionConfig `protobuf:"bytes,19,opt,name=encryption_config,json=encryptionConfig,proto3" json:"encryption_config,omitempty"`

	EncryptionInfo *EncryptionInfo `protobuf:"bytes,20,opt,name=encryption_info,json=encryptionInfo,proto3" json:"encryption_info,omitempty"`

	ContinuousBackupConfig *ContinuousBackupConfig "" /* 130 byte string literal not displayed */

	ContinuousBackupInfo *ContinuousBackupInfo `protobuf:"bytes,28,opt,name=continuous_backup_info,json=continuousBackupInfo,proto3" json:"continuous_backup_info,omitempty"`

	SecondaryConfig *Cluster_SecondaryConfig `protobuf:"bytes,22,opt,name=secondary_config,json=secondaryConfig,proto3" json:"secondary_config,omitempty"`

	PrimaryConfig *Cluster_PrimaryConfig `protobuf:"bytes,23,opt,name=primary_config,json=primaryConfig,proto3" json:"primary_config,omitempty"`

}

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

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) GetContinuousBackupConfig

func (x *Cluster) GetContinuousBackupConfig() *ContinuousBackupConfig

func (*Cluster) GetContinuousBackupInfo

func (x *Cluster) GetContinuousBackupInfo() *ContinuousBackupInfo

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) GetInitialUser

func (x *Cluster) GetInitialUser() *UserPassword

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

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"`
}

Cluster_ClusterType

type Cluster_ClusterType int32

Type of Cluster

Cluster_CLUSTER_TYPE_UNSPECIFIED, Cluster_PRIMARY, Cluster_SECONDARY

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) Descriptor() protoreflect.EnumDescriptor

func (Cluster_ClusterType) Enum

func (x Cluster_ClusterType) Enum() *Cluster_ClusterType

func (Cluster_ClusterType) EnumDescriptor

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

Deprecated: Use Cluster_ClusterType.Descriptor instead.

func (Cluster_ClusterType) Number

func (x Cluster_ClusterType) Number() protoreflect.EnumNumber

func (Cluster_ClusterType) String

func (x Cluster_ClusterType) String() string

func (Cluster_ClusterType) Type

func (Cluster_ClusterType) Type() protoreflect.EnumType

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"`
}

Cluster_PrimaryConfig

type Cluster_PrimaryConfig struct {

	// Output only. Names of the clusters that are replicating from this
	// cluster.
	SecondaryClusterNames []string `protobuf:"bytes,1,rep,name=secondary_cluster_names,json=secondaryClusterNames,proto3" json:"secondary_cluster_names,omitempty"`
	// 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

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

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

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

Cluster_State

type Cluster_State int32

Cluster State

Cluster_STATE_UNSPECIFIED, Cluster_READY, Cluster_STOPPED, Cluster_EMPTY, Cluster_CREATING, Cluster_DELETING, Cluster_FAILED, Cluster_BOOTSTRAPPING, Cluster_MAINTENANCE, Cluster_PROMOTING

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) Descriptor() protoreflect.EnumDescriptor

func (Cluster_State) Enum

func (x Cluster_State) Enum() *Cluster_State

func (Cluster_State) EnumDescriptor

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

Deprecated: Use Cluster_State.Descriptor instead.

func (Cluster_State) Number

func (x Cluster_State) Number() protoreflect.EnumNumber

func (Cluster_State) String

func (x Cluster_State) String() string

func (Cluster_State) Type

func (Cluster_State) Type() protoreflect.EnumType

ConnectionInfo

type ConnectionInfo struct {

	// The name of the ConnectionInfo singleton resource, e.g.:
	// projects/{project}/locations/{location}/clusters/*/instances/*/connectionInfo
	// This field currently has no semantic meaning.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Output only. The IP address for the Instance.
	// This is the connection endpoint for an end-user application.
	IpAddress string `protobuf:"bytes,2,opt,name=ip_address,json=ipAddress,proto3" json:"ip_address,omitempty"`
	// Output only. The pem-encoded chain that may be used to verify the X.509
	// certificate. Expected to be in issuer-to-root order according to RFC 5246.
	PemCertificateChain []string `protobuf:"bytes,3,rep,name=pem_certificate_chain,json=pemCertificateChain,proto3" json:"pem_certificate_chain,omitempty"`
	// Output only. The unique ID of the Instance.
	InstanceUid string `protobuf:"bytes,4,opt,name=instance_uid,json=instanceUid,proto3" json:"instance_uid,omitempty"`
	// contains filtered or unexported fields
}

ConnectionInfo singleton resource. https://google.aip.dev/156

func (*ConnectionInfo) Descriptor

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

Deprecated: Use ConnectionInfo.ProtoReflect.Descriptor instead.

func (*ConnectionInfo) GetInstanceUid

func (x *ConnectionInfo) GetInstanceUid() string

func (*ConnectionInfo) GetIpAddress

func (x *ConnectionInfo) GetIpAddress() string

func (*ConnectionInfo) GetName

func (x *ConnectionInfo) GetName() string

func (*ConnectionInfo) GetPemCertificateChain

func (x *ConnectionInfo) GetPemCertificateChain() []string

func (*ConnectionInfo) ProtoMessage

func (*ConnectionInfo) ProtoMessage()

func (*ConnectionInfo) ProtoReflect

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

func (*ConnectionInfo) Reset

func (x *ConnectionInfo) Reset()

func (*ConnectionInfo) String

func (x *ConnectionInfo) String() string

ContinuousBackupConfig

type ContinuousBackupConfig struct {

	// Whether ContinuousBackup is enabled.
	Enabled *bool `protobuf:"varint,1,opt,name=enabled,proto3,oneof" json:"enabled,omitempty"`
	// The number of days backups and logs will be retained, which determines the
	// window of time that data is recoverable for. If not set, it defaults to 14
	// days.
	RecoveryWindowDays int32 `protobuf:"varint,4,opt,name=recovery_window_days,json=recoveryWindowDays,proto3" json:"recovery_window_days,omitempty"`
	// 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,3,opt,name=encryption_config,json=encryptionConfig,proto3" json:"encryption_config,omitempty"`
	// contains filtered or unexported fields
}

ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster.

func (*ContinuousBackupConfig) Descriptor

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

Deprecated: Use ContinuousBackupConfig.ProtoReflect.Descriptor instead.

func (*ContinuousBackupConfig) GetEnabled

func (x *ContinuousBackupConfig) GetEnabled() bool

func (*ContinuousBackupConfig) GetEncryptionConfig

func (x *ContinuousBackupConfig) GetEncryptionConfig() *EncryptionConfig

func (*ContinuousBackupConfig) GetRecoveryWindowDays

func (x *ContinuousBackupConfig) GetRecoveryWindowDays() int32

func (*ContinuousBackupConfig) ProtoMessage

func (*ContinuousBackupConfig) ProtoMessage()

func (*ContinuousBackupConfig) ProtoReflect

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

func (*ContinuousBackupConfig) Reset

func (x *ContinuousBackupConfig) Reset()

func (*ContinuousBackupConfig) String

func (x *ContinuousBackupConfig) String() string

ContinuousBackupInfo

type ContinuousBackupInfo struct {

	// Output only. The encryption information for the WALs and backups required
	// for ContinuousBackup.
	EncryptionInfo *EncryptionInfo `protobuf:"bytes,1,opt,name=encryption_info,json=encryptionInfo,proto3" json:"encryption_info,omitempty"`
	// Output only. When ContinuousBackup was most recently enabled. Set to null
	// if ContinuousBackup is not enabled.
	EnabledTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=enabled_time,json=enabledTime,proto3" json:"enabled_time,omitempty"`
	// Output only. Days of the week on which a continuous backup is taken. Output
	// only field. Ignored if passed into the request.
	Schedule []dayofweek.DayOfWeek `protobuf:"varint,3,rep,packed,name=schedule,proto3,enum=google.type.DayOfWeek" json:"schedule,omitempty"`
	// contains filtered or unexported fields
}

ContinuousBackupInfo describes the continuous backup properties of a cluster.

func (*ContinuousBackupInfo) Descriptor

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

Deprecated: Use ContinuousBackupInfo.ProtoReflect.Descriptor instead.

func (*ContinuousBackupInfo) GetEnabledTime

func (x *ContinuousBackupInfo) GetEnabledTime() *timestamppb.Timestamp

func (*ContinuousBackupInfo) GetEncryptionInfo

func (x *ContinuousBackupInfo) GetEncryptionInfo() *EncryptionInfo

func (*ContinuousBackupInfo) GetSchedule

func (x *ContinuousBackupInfo) GetSchedule() []dayofweek.DayOfWeek

func (*ContinuousBackupInfo) ProtoMessage

func (*ContinuousBackupInfo) ProtoMessage()

func (*ContinuousBackupInfo) ProtoReflect

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

func (*ContinuousBackupInfo) Reset

func (x *ContinuousBackupInfo) Reset()

func (*ContinuousBackupInfo) String

func (x *ContinuousBackupInfo) String() string

ContinuousBackupSource

type ContinuousBackupSource struct {

	// Required. The source cluster from which to restore. This cluster must have
	// continuous backup enabled for this operation to succeed. For the required
	// format, see the comment on the Cluster.name field.
	Cluster string `protobuf:"bytes,1,opt,name=cluster,proto3" json:"cluster,omitempty"`
	// Required. The point in time to restore to.
	PointInTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=point_in_time,json=pointInTime,proto3" json:"point_in_time,omitempty"`
	// contains filtered or unexported fields
}

Message describing a ContinuousBackupSource.

func (*ContinuousBackupSource) Descriptor

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

Deprecated: Use ContinuousBackupSource.ProtoReflect.Descriptor instead.

func (*ContinuousBackupSource) GetCluster

func (x *ContinuousBackupSource) GetCluster() string

func (*ContinuousBackupSource) GetPointInTime

func (x *ContinuousBackupSource) GetPointInTime() *timestamppb.Timestamp

func (*ContinuousBackupSource) ProtoMessage

func (*ContinuousBackupSource) ProtoMessage()

func (*ContinuousBackupSource) ProtoReflect

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

func (*ContinuousBackupSource) Reset

func (x *ContinuousBackupSource) Reset()

func (*ContinuousBackupSource) String

func (x *ContinuousBackupSource) String() string

CreateBackupRequest

type CreateBackupRequest struct {

	// Required. Value for parent.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. ID of the requesting object.
	BackupId string `protobuf:"bytes,2,opt,name=backup_id,json=backupId,proto3" json:"backup_id,omitempty"`
	// Required. The resource being created
	Backup *Backup `protobuf:"bytes,3,opt,name=backup,proto3" json:"backup,omitempty"`
	// Optional. An optional request ID to identify requests. Specify a unique
	// request ID so that if you must retry your request, the server will know to
	// ignore the request if it has already been completed. The server will
	// guarantee that for at least 60 minutes since the first request.
	//
	// For example, consider a situation where you make an initial request and
	// the request times out. If you make the request again with the same request
	// ID, the server can check if original operation with the same request ID
	// was received, and if so, will ignore the second request. This prevents
	// clients from accidentally creating duplicate commitments.
	//
	// The request ID must be a valid UUID with the exception that zero UUID is
	// not supported (00000000-0000-0000-0000-000000000000).
	RequestId string `protobuf:"bytes,4,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// Optional. If set, the backend validates the request, but doesn't actually
	// execute it.
	ValidateOnly bool `protobuf:"varint,5,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
	// contains filtered or unexported fields
}

Message for creating a Backup

func (*CreateBackupRequest) Descriptor

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

Deprecated: Use CreateBackupRequest.ProtoReflect.Descriptor instead.

func (*CreateBackupRequest) GetBackup

func (x *CreateBackupRequest) GetBackup() *Backup

func (*CreateBackupRequest) GetBackupId

func (x *CreateBackupRequest) GetBackupId() string

func (*CreateBackupRequest) GetParent

func (x *CreateBackupRequest) GetParent() string

func (*CreateBackupRequest) GetRequestId

func (x *CreateBackupRequest) GetRequestId() string

func (*CreateBackupRequest) GetValidateOnly

func (x *CreateBackupRequest) GetValidateOnly() bool

func (*CreateBackupRequest) ProtoMessage

func (*CreateBackupRequest) ProtoMessage()

func (*CreateBackupRequest) ProtoReflect

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

func (*CreateBackupRequest) Reset

func (x *CreateBackupRequest) Reset()

func (*CreateBackupRequest) String

func (x *CreateBackupRequest) String() string

CreateClusterRequest

type CreateClusterRequest struct {

	// Required. The name of the parent resource. For the required format, see the
	// comment on the Cluster.name field.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. ID of the requesting object.
	ClusterId string `protobuf:"bytes,2,opt,name=cluster_id,json=clusterId,proto3" json:"cluster_id,omitempty"`
	// Required. The resource being created
	Cluster *Cluster `protobuf:"bytes,3,opt,name=cluster,proto3" json:"cluster,omitempty"`
	// Optional. An optional request ID to identify requests. Specify a unique
	// request ID so that if you must retry your request, the server will know to
	// ignore the request if it has already been completed. The server will
	// guarantee that for at least 60 minutes since the first request.
	//
	// For example, consider a situation where you make an initial request and
	// the request times out. If you make the request again with the same request
	// ID, the server can check if original operation with the same request ID
	// was received, and if so, will ignore the second request. This prevents
	// clients from accidentally creating duplicate commitments.
	//
	// The request ID must be a valid UUID with the exception that zero UUID is
	// not supported (00000000-0000-0000-0000-000000000000).
	RequestId string `protobuf:"bytes,4,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// Optional. If set, performs request validation (e.g. permission checks and
	// any other type of validation), but do not actually execute the create
	// request.
	ValidateOnly bool `protobuf:"varint,5,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
	// contains filtered or unexported fields
}

Message for creating a Cluster

func (*CreateClusterRequest) Descriptor

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

Deprecated: Use CreateClusterRequest.ProtoReflect.Descriptor instead.

func (*CreateClusterRequest) GetCluster

func (x *CreateClusterRequest) GetCluster() *Cluster

func (*CreateClusterRequest) GetClusterId

func (x *CreateClusterRequest) GetClusterId() string

func (*CreateClusterRequest) GetParent

func (x *CreateClusterRequest) GetParent() string

func (*CreateClusterRequest) GetRequestId

func (x *CreateClusterRequest) GetRequestId() string

func (*CreateClusterRequest) GetValidateOnly

func (x *CreateClusterRequest) GetValidateOnly() bool

func (*CreateClusterRequest) ProtoMessage

func (*CreateClusterRequest) ProtoMessage()

func (*CreateClusterRequest) ProtoReflect

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

func (*CreateClusterRequest) Reset

func (x *CreateClusterRequest) Reset()

func (*CreateClusterRequest) String

func (x *CreateClusterRequest) String() string

CreateInstanceRequest

type CreateInstanceRequest struct {

	// Required. The name of the parent resource. For the required format, see the
	// comment on the Instance.name field.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. ID of the requesting object.
	InstanceId string `protobuf:"bytes,2,opt,name=instance_id,json=instanceId,proto3" json:"instance_id,omitempty"`
	// Required. The resource being created
	Instance *Instance `protobuf:"bytes,3,opt,name=instance,proto3" json:"instance,omitempty"`
	// Optional. An optional request ID to identify requests. Specify a unique
	// request ID so that if you must retry your request, the server will know to
	// ignore the request if it has already been completed. The server will
	// guarantee that for at least 60 minutes since the first request.
	//
	// For example, consider a situation where you make an initial request and
	// the request times out. If you make the request again with the same request
	// ID, the server can check if original operation with the same request ID
	// was received, and if so, will ignore the second request. This prevents
	// clients from accidentally creating duplicate commitments.
	//
	// The request ID must be a valid UUID with the exception that zero UUID is
	// not supported (00000000-0000-0000-0000-000000000000).
	RequestId string `protobuf:"bytes,4,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// Optional. If set, performs request validation (e.g. permission checks and
	// any other type of validation), but do not actually execute the create
	// request.
	ValidateOnly bool `protobuf:"varint,5,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
	// contains filtered or unexported fields
}

Message for creating a Instance

func (*CreateInstanceRequest) Descriptor

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

Deprecated: Use CreateInstanceRequest.ProtoReflect.Descriptor instead.

func (*CreateInstanceRequest) GetInstance

func (x *CreateInstanceRequest) GetInstance() *Instance

func (*CreateInstanceRequest) GetInstanceId

func (x *CreateInstanceRequest) GetInstanceId() string

func (*CreateInstanceRequest) GetParent

func (x *CreateInstanceRequest) GetParent() string

func (*CreateInstanceRequest) GetRequestId

func (x *CreateInstanceRequest) GetRequestId() string

func (*CreateInstanceRequest) GetValidateOnly

func (x *CreateInstanceRequest) GetValidateOnly() bool

func (*CreateInstanceRequest) ProtoMessage

func (*CreateInstanceRequest) ProtoMessage()

func (*CreateInstanceRequest) ProtoReflect

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

func (*CreateInstanceRequest) Reset

func (x *CreateInstanceRequest) Reset()

func (*CreateInstanceRequest) String

func (x *CreateInstanceRequest) String() string

CreateInstanceRequests

type CreateInstanceRequests struct {
	CreateInstanceRequests []*CreateInstanceRequest "" /* 129 byte string literal not displayed */

}

See usage below for notes.

func (*CreateInstanceRequests) Descriptor

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

Deprecated: Use CreateInstanceRequests.ProtoReflect.Descriptor instead.

func (*CreateInstanceRequests) GetCreateInstanceRequests

func (x *CreateInstanceRequests) GetCreateInstanceRequests() []*CreateInstanceRequest

func (*CreateInstanceRequests) ProtoMessage

func (*CreateInstanceRequests) ProtoMessage()

func (*CreateInstanceRequests) ProtoReflect

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

func (*CreateInstanceRequests) Reset

func (x *CreateInstanceRequests) Reset()

func (*CreateInstanceRequests) String

func (x *CreateInstanceRequests) String() string

CreateSecondaryClusterRequest

type CreateSecondaryClusterRequest struct {

	// Required. The name of the parent resource (the primary cluster). For the
	// required format, see the comment on the Cluster.name field.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. ID of the requesting object (the secondary cluster).
	ClusterId string `protobuf:"bytes,2,opt,name=cluster_id,json=clusterId,proto3" json:"cluster_id,omitempty"`
	// Required. Configuration of the requesting object (the secondary cluster).
	Cluster *Cluster `protobuf:"bytes,3,opt,name=cluster,proto3" json:"cluster,omitempty"`
	// Optional. An optional request ID to identify requests. Specify a unique
	// request ID so that if you must retry your request, the server will know to
	// ignore the request if it has already been completed. The server will
	// guarantee that for at least 60 minutes since the first request.
	//
	// For example, consider a situation where you make an initial request and
	// the request times out. If you make the request again with the same request
	// ID, the server can check if original operation with the same request ID
	// was received, and if so, will ignore the second request. This prevents
	// clients from accidentally creating duplicate commitments.
	//
	// The request ID must be a valid UUID with the exception that zero UUID is
	// not supported (00000000-0000-0000-0000-000000000000).
	RequestId string `protobuf:"bytes,5,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// Optional. If set, performs request validation (e.g. permission checks and
	// any other type of validation), but do not actually execute the create
	// request.
	ValidateOnly bool `protobuf:"varint,6,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateSecondaryClusterRequest) Descriptor

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

Deprecated: Use CreateSecondaryClusterRequest.ProtoReflect.Descriptor instead.

func (*CreateSecondaryClusterRequest) GetCluster

func (x *CreateSecondaryClusterRequest) GetCluster() *Cluster

func (*CreateSecondaryClusterRequest) GetClusterId

func (x *CreateSecondaryClusterRequest) GetClusterId() string

func (*CreateSecondaryClusterRequest) GetParent

func (x *CreateSecondaryClusterRequest) GetParent() string

func (*CreateSecondaryClusterRequest) GetRequestId

func (x *CreateSecondaryClusterRequest) GetRequestId() string

func (*CreateSecondaryClusterRequest) GetValidateOnly

func (x *CreateSecondaryClusterRequest) GetValidateOnly() bool

func (*CreateSecondaryClusterRequest) ProtoMessage

func (*CreateSecondaryClusterRequest) ProtoMessage()

func (*CreateSecondaryClusterRequest) ProtoReflect

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

func (*CreateSecondaryClusterRequest) Reset

func (x *CreateSecondaryClusterRequest) Reset()

func (*CreateSecondaryClusterRequest) String

func (x *CreateSecondaryClusterRequest) String() string

CreateSecondaryInstanceRequest

type CreateSecondaryInstanceRequest struct {

	// Required. The name of the parent resource. For the required format, see the
	// comment on the Instance.name field.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. ID of the requesting object.
	InstanceId string `protobuf:"bytes,2,opt,name=instance_id,json=instanceId,proto3" json:"instance_id,omitempty"`
	// Required. The resource being created
	Instance *Instance `protobuf:"bytes,3,opt,name=instance,proto3" json:"instance,omitempty"`
	// Optional. An optional request ID to identify requests. Specify a unique
	// request ID so that if you must retry your request, the server will know to
	// ignore the request if it has already been completed. The server will
	// guarantee that for at least 60 minutes since the first request.
	//
	// For example, consider a situation where you make an initial request and
	// the request times out. If you make the request again with the same request
	// ID, the server can check if original operation with the same request ID
	// was received, and if so, will ignore the second request. This prevents
	// clients from accidentally creating duplicate commitments.
	//
	// The request ID must be a valid UUID with the exception that zero UUID is
	// not supported (00000000-0000-0000-0000-000000000000).
	RequestId string `protobuf:"bytes,4,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// Optional. If set, performs request validation (e.g. permission checks and
	// any other type of validation), but do not actually execute the create
	// request.
	ValidateOnly bool `protobuf:"varint,5,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
	// contains filtered or unexported fields
}

Message for creating a Secondary Instance

func (*CreateSecondaryInstanceRequest) Descriptor

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

Deprecated: Use CreateSecondaryInstanceRequest.ProtoReflect.Descriptor instead.

func (*CreateSecondaryInstanceRequest) GetInstance

func (x *CreateSecondaryInstanceRequest) GetInstance() *Instance

func (*CreateSecondaryInstanceRequest) GetInstanceId

func (x *CreateSecondaryInstanceRequest) GetInstanceId() string

func (*CreateSecondaryInstanceRequest) GetParent

func (x *CreateSecondaryInstanceRequest) GetParent() string

func (*CreateSecondaryInstanceRequest) GetRequestId

func (x *CreateSecondaryInstanceRequest) GetRequestId() string

func (*CreateSecondaryInstanceRequest) GetValidateOnly

func (x *CreateSecondaryInstanceRequest) GetValidateOnly() bool

func (*CreateSecondaryInstanceRequest) ProtoMessage

func (*CreateSecondaryInstanceRequest) ProtoMessage()

func (*CreateSecondaryInstanceRequest) ProtoReflect

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

func (*CreateSecondaryInstanceRequest) Reset

func (x *CreateSecondaryInstanceRequest) Reset()

func (*CreateSecondaryInstanceRequest) String

func (x *CreateSecondaryInstanceRequest) String() string

DatabaseVersion

type DatabaseVersion int32

The supported database engine versions.

DatabaseVersion_DATABASE_VERSION_UNSPECIFIED, DatabaseVersion_POSTGRES_13, DatabaseVersion_POSTGRES_14

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

func (DatabaseVersion) Descriptor

func (DatabaseVersion) Descriptor() protoreflect.EnumDescriptor

func (DatabaseVersion) Enum

func (x DatabaseVersion) Enum() *DatabaseVersion

func (DatabaseVersion) EnumDescriptor

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

Deprecated: Use DatabaseVersion.Descriptor instead.

func (DatabaseVersion) Number

func (x DatabaseVersion) Number() protoreflect.EnumNumber

func (DatabaseVersion) String

func (x DatabaseVersion) String() string

func (DatabaseVersion) Type

func (DatabaseVersion) Type() protoreflect.EnumType

DeleteBackupRequest

type DeleteBackupRequest struct {

	// Required. Name of the resource. For the required format, see the comment on
	// the Backup.name field.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. An optional request ID to identify requests. Specify a unique
	// request ID so that if you must retry your request, the server will know to
	// ignore the request if it has already been completed. The server will
	// guarantee that for at least 60 minutes after the first request.
	//
	// For example, consider a situation where you make an initial request and
	// the request times out. If you make the request again with the same request
	// ID, the server can check if original operation with the same request ID
	// was received, and if so, will ignore the second request. This prevents
	// clients from accidentally creating duplicate commitments.
	//
	// The request ID must be a valid UUID with the exception that zero UUID is
	// not supported (00000000-0000-0000-0000-000000000000).
	RequestId string `protobuf:"bytes,2,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// Optional. If set, the backend validates the request, but doesn't actually
	// execute it.
	ValidateOnly bool `protobuf:"varint,3,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
	// Optional. The current etag of the Backup.
	// If an etag is provided and does not match the current etag of the Backup,
	// deletion will be blocked and an ABORTED error will be returned.
	Etag string `protobuf:"bytes,4,opt,name=etag,proto3" json:"etag,omitempty"`
	// contains filtered or unexported fields
}

Message for deleting a Backup

func (*DeleteBackupRequest) Descriptor

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

Deprecated: Use DeleteBackupRequest.ProtoReflect.Descriptor instead.

func (*DeleteBackupRequest) GetEtag

func (x *DeleteBackupRequest) GetEtag() string

func (*DeleteBackupRequest) GetName

func (x *DeleteBackupRequest) GetName() string

func (*DeleteBackupRequest) GetRequestId

func (x *DeleteBackupRequest) GetRequestId() string

func (*DeleteBackupRequest) GetValidateOnly

func (x *DeleteBackupRequest) GetValidateOnly() bool

func (*DeleteBackupRequest) ProtoMessage

func (*DeleteBackupRequest) ProtoMessage()

func (*DeleteBackupRequest) ProtoReflect

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

func (*DeleteBackupRequest) Reset

func (x *DeleteBackupRequest) Reset()

func (*DeleteBackupRequest) String

func (x *DeleteBackupRequest) String() string

DeleteClusterRequest

type DeleteClusterRequest struct {

	// Required. The name of the resource. For the required format, see the
	// comment on the Cluster.name field.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. An optional request ID to identify requests. Specify a unique
	// request ID so that if you must retry your request, the server will know to
	// ignore the request if it has already been completed. The server will
	// guarantee that for at least 60 minutes after the first request.
	//
	// For example, consider a situation where you make an initial request and
	// the request times out. If you make the request again with the same request
	// ID, the server can check if original operation with the same request ID
	// was received, and if so, will ignore the second request. This prevents
	// clients from accidentally creating duplicate commitments.
	//
	// The request ID must be a valid UUID with the exception that zero UUID is
	// not supported (00000000-0000-0000-0000-000000000000).
	RequestId string `protobuf:"bytes,2,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// Optional. The current etag of the Cluster.
	// If an etag is provided and does not match the current etag of the Cluster,
	// deletion will be blocked and an ABORTED error will be returned.
	Etag string `protobuf:"bytes,3,opt,name=etag,proto3" json:"etag,omitempty"`
	// Optional. If set, performs request validation (e.g. permission checks and
	// any other type of validation), but do not actually execute the delete.
	ValidateOnly bool `protobuf:"varint,4,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
	// Optional. Whether to cascade delete child instances for given cluster.
	Force bool `protobuf:"varint,5,opt,name=force,proto3" json:"force,omitempty"`
	// contains filtered or unexported fields
}

Message for deleting a Cluster

func (*DeleteClusterRequest) Descriptor

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

Deprecated: Use DeleteClusterRequest.ProtoReflect.Descriptor instead.

func (*DeleteClusterRequest) GetEtag

func (x *DeleteClusterRequest) GetEtag() string

func (*DeleteClusterRequest) GetForce

func (x *DeleteClusterRequest) GetForce() bool

func (*DeleteClusterRequest) GetName

func (x *DeleteClusterRequest) GetName() string

func (*DeleteClusterRequest) GetRequestId

func (x *DeleteClusterRequest) GetRequestId() string

func (*DeleteClusterRequest) GetValidateOnly

func (x *DeleteClusterRequest) GetValidateOnly() bool

func (*DeleteClusterRequest) ProtoMessage

func (*DeleteClusterRequest) ProtoMessage()

func (*DeleteClusterRequest) ProtoReflect

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

func (*DeleteClusterRequest) Reset

func (x *DeleteClusterRequest) Reset()

func (*DeleteClusterRequest) String

func (x *DeleteClusterRequest) String() string

DeleteInstanceRequest

type DeleteInstanceRequest struct {

	// Required. The name of the resource. For the required format, see the
	// comment on the Instance.name field.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. An optional request ID to identify requests. Specify a unique
	// request ID so that if you must retry your request, the server will know to
	// ignore the request if it has already been completed. The server will
	// guarantee that for at least 60 minutes after the first request.
	//
	// For example, consider a situation where you make an initial request and
	// the request times out. If you make the request again with the same request
	// ID, the server can check if original operation with the same request ID
	// was received, and if so, will ignore the second request. This prevents
	// clients from accidentally creating duplicate commitments.
	//
	// The request ID must be a valid UUID with the exception that zero UUID is
	// not supported (00000000-0000-0000-0000-000000000000).
	RequestId string `protobuf:"bytes,2,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// Optional. The current etag of the Instance.
	// If an etag is provided and does not match the current etag of the Instance,
	// deletion will be blocked and an ABORTED error will be returned.
	Etag string `protobuf:"bytes,3,opt,name=etag,proto3" json:"etag,omitempty"`
	// Optional. If set, performs request validation (e.g. permission checks and
	// any other type of validation), but do not actually execute the delete.
	ValidateOnly bool `protobuf:"varint,4,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
	// contains filtered or unexported fields
}

Message for deleting a Instance

func (*DeleteInstanceRequest) Descriptor

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

Deprecated: Use DeleteInstanceRequest.ProtoReflect.Descriptor instead.

func (*DeleteInstanceRequest) GetEtag

func (x *DeleteInstanceRequest) GetEtag() string

func (*DeleteInstanceRequest) GetName

func (x *DeleteInstanceRequest) GetName() string

func (*DeleteInstanceRequest) GetRequestId

func (x *DeleteInstanceRequest) GetRequestId() string

func (*DeleteInstanceRequest) GetValidateOnly

func (x *DeleteInstanceRequest) GetValidateOnly() bool

func (*DeleteInstanceRequest) ProtoMessage

func (*DeleteInstanceRequest) ProtoMessage()

func (*DeleteInstanceRequest) ProtoReflect

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

func (*DeleteInstanceRequest) Reset

func (x *DeleteInstanceRequest) Reset()

func (*DeleteInstanceRequest) String

func (x *DeleteInstanceRequest) String() string

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

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

EncryptionInfo

type EncryptionInfo struct {
	EncryptionType EncryptionInfo_Type "" /* 157 byte string literal not displayed */

	KmsKeyVersions []string `protobuf:"bytes,2,rep,name=kms_key_versions,json=kmsKeyVersions,proto3" json:"kms_key_versions,omitempty"`

}

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

func (*EncryptionInfo) Descriptor

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

EncryptionInfo_Type

type EncryptionInfo_Type int32

Possible encryption types.

EncryptionInfo_TYPE_UNSPECIFIED, EncryptionInfo_GOOGLE_DEFAULT_ENCRYPTION, EncryptionInfo_CUSTOMER_MANAGED_ENCRYPTION

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) Descriptor() protoreflect.EnumDescriptor

func (EncryptionInfo_Type) Enum

func (x EncryptionInfo_Type) Enum() *EncryptionInfo_Type

func (EncryptionInfo_Type) EnumDescriptor

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

Deprecated: Use EncryptionInfo_Type.Descriptor instead.

func (EncryptionInfo_Type) Number

func (x EncryptionInfo_Type) Number() protoreflect.EnumNumber

func (EncryptionInfo_Type) String

func (x EncryptionInfo_Type) String() string

func (EncryptionInfo_Type) Type

func (EncryptionInfo_Type) Type() protoreflect.EnumType

FailoverInstanceRequest

type FailoverInstanceRequest struct {

	// Required. The name of the resource. For the required format, see the
	// comment on the Instance.name field.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. An optional request ID to identify requests. Specify a unique
	// request ID so that if you must retry your request, the server will know to
	// ignore the request if it has already been completed. The server will
	// guarantee that for at least 60 minutes after the first request.
	//
	// For example, consider a situation where you make an initial request and
	// the request times out. If you make the request again with the same request
	// ID, the server can check if original operation with the same request ID
	// was received, and if so, will ignore the second request. This prevents
	// clients from accidentally creating duplicate commitments.
	//
	// The request ID must be a valid UUID with the exception that zero UUID is
	// not supported (00000000-0000-0000-0000-000000000000).
	RequestId string `protobuf:"bytes,2,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// Optional. If set, performs request validation (e.g. permission checks and
	// any other type of validation), but do not actually execute the failover.
	ValidateOnly bool `protobuf:"varint,3,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
	// contains filtered or unexported fields
}

Message for triggering failover on an Instance

func (*FailoverInstanceRequest) Descriptor

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

Deprecated: Use FailoverInstanceRequest.ProtoReflect.Descriptor instead.

func (*FailoverInstanceRequest) GetName

func (x *FailoverInstanceRequest) GetName() string

func (*FailoverInstanceRequest) GetRequestId

func (x *FailoverInstanceRequest) GetRequestId() string

func (*FailoverInstanceRequest) GetValidateOnly

func (x *FailoverInstanceRequest) GetValidateOnly() bool

func (*FailoverInstanceRequest) ProtoMessage

func (*FailoverInstanceRequest) ProtoMessage()

func (*FailoverInstanceRequest) ProtoReflect

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

func (*FailoverInstanceRequest) Reset

func (x *FailoverInstanceRequest) Reset()

func (*FailoverInstanceRequest) String

func (x *FailoverInstanceRequest) String() string

GenerateClientCertificateRequest

type GenerateClientCertificateRequest struct {

	// Required. The name of the parent resource. The required format is:
	//   - projects/{project}/locations/{location}/clusters/{cluster}
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. An optional request ID to identify requests. Specify a unique
	// request ID so that if you must retry your request, the server will know to
	// ignore the request if it has already been completed. The server will
	// guarantee that for at least 60 minutes after the first request.
	//
	// For example, consider a situation where you make an initial request and
	// the request times out. If you make the request again with the same request
	// ID, the server can check if original operation with the same request ID
	// was received, and if so, will ignore the second request. This prevents
	// clients from accidentally creating duplicate commitments.
	//
	// The request ID must be a valid UUID with the exception that zero UUID is
	// not supported (00000000-0000-0000-0000-000000000000).
	RequestId string `protobuf:"bytes,2,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// Optional. A pem-encoded X.509 certificate signing request (CSR).
	PemCsr string `protobuf:"bytes,3,opt,name=pem_csr,json=pemCsr,proto3" json:"pem_csr,omitempty"`
	// Optional. An optional hint to the endpoint to generate the client
	// certificate with the requested duration. The duration can be from 1 hour to
	// 24 hours. The endpoint may or may not honor the hint. If the hint is left
	// unspecified or is not honored, then the endpoint will pick an appropriate
	// default duration.
	CertDuration *durationpb.Duration `protobuf:"bytes,4,opt,name=cert_duration,json=certDuration,proto3" json:"cert_duration,omitempty"`
	// contains filtered or unexported fields
}

Message for requests to generate a client certificate signed by the Cluster CA.

func (*GenerateClientCertificateRequest) Descriptor

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

Deprecated: Use GenerateClientCertificateRequest.ProtoReflect.Descriptor instead.

func (*GenerateClientCertificateRequest) GetCertDuration

func (x *GenerateClientCertificateRequest) GetCertDuration() *durationpb.Duration

func (*GenerateClientCertificateRequest) GetParent

func (x *GenerateClientCertificateRequest) GetParent() string

func (*GenerateClientCertificateRequest) GetPemCsr

func (x *GenerateClientCertificateRequest) GetPemCsr() string

func (*GenerateClientCertificateRequest) GetRequestId

func (x *GenerateClientCertificateRequest) GetRequestId() string

func (*GenerateClientCertificateRequest) ProtoMessage

func (*GenerateClientCertificateRequest) ProtoMessage()

func (*GenerateClientCertificateRequest) ProtoReflect

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

func (*GenerateClientCertificateRequest) Reset

func (x *GenerateClientCertificateRequest) Reset()

func (*GenerateClientCertificateRequest) String

func (x *GenerateClientCertificateRequest) String() string

GenerateClientCertificateResponse

type GenerateClientCertificateResponse struct {

	// Output only. The pem-encoded, signed X.509 certificate.
	PemCertificate string `protobuf:"bytes,1,opt,name=pem_certificate,json=pemCertificate,proto3" json:"pem_certificate,omitempty"`
	// Output only. The pem-encoded chain that may be used to verify the X.509
	// certificate. Expected to be in issuer-to-root order according to RFC 5246.
	PemCertificateChain []string `protobuf:"bytes,2,rep,name=pem_certificate_chain,json=pemCertificateChain,proto3" json:"pem_certificate_chain,omitempty"`
	// contains filtered or unexported fields
}

Message returned by a GenerateClientCertificate operation.

func (*GenerateClientCertificateResponse) Descriptor

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

Deprecated: Use GenerateClientCertificateResponse.ProtoReflect.Descriptor instead.

func (*GenerateClientCertificateResponse) GetPemCertificate

func (x *GenerateClientCertificateResponse) GetPemCertificate() string

func (*GenerateClientCertificateResponse) GetPemCertificateChain

func (x *GenerateClientCertificateResponse) GetPemCertificateChain() []string

func (*GenerateClientCertificateResponse) ProtoMessage

func (*GenerateClientCertificateResponse) ProtoMessage()

func (*GenerateClientCertificateResponse) ProtoReflect

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

func (*GenerateClientCertificateResponse) Reset

func (x *GenerateClientCertificateResponse) Reset()

func (*GenerateClientCertificateResponse) String

func (x *GenerateClientCertificateResponse) String() string

GetBackupRequest

type GetBackupRequest struct {

	// Required. Name of the resource
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Message for getting a Backup

func (*GetBackupRequest) Descriptor

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

Deprecated: Use GetBackupRequest.ProtoReflect.Descriptor instead.

func (*GetBackupRequest) GetName

func (x *GetBackupRequest) GetName() string

func (*GetBackupRequest) ProtoMessage

func (*GetBackupRequest) ProtoMessage()

func (*GetBackupRequest) ProtoReflect

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

func (*GetBackupRequest) Reset

func (x *GetBackupRequest) Reset()

func (*GetBackupRequest) String

func (x *GetBackupRequest) String() string

GetClusterRequest

type GetClusterRequest struct {

	// Required. The name of the resource. For the required format, see the
	// comment on the Cluster.name field.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Message for getting a Cluster

func (*GetClusterRequest) Descriptor

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

Deprecated: Use GetClusterRequest.ProtoReflect.Descriptor instead.

func (*GetClusterRequest) GetName

func (x *GetClusterRequest) GetName() string

func (*GetClusterRequest) ProtoMessage

func (*GetClusterRequest) ProtoMessage()

func (*GetClusterRequest) ProtoReflect

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

func (*GetClusterRequest) Reset

func (x *GetClusterRequest) Reset()

func (*GetClusterRequest) String

func (x *GetClusterRequest) String() string

GetConnectionInfoRequest

type GetConnectionInfoRequest struct {

	// Required. The name of the parent resource. The required format is:
	// projects/{project}/locations/{location}/clusters/{cluster}/instances/{instance}
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. An optional request ID to identify requests. Specify a unique
	// request ID so that if you must retry your request, the server will know to
	// ignore the request if it has already been completed. The server will
	// guarantee that for at least 60 minutes after the first request.
	//
	// For example, consider a situation where you make an initial request and
	// the request times out. If you make the request again with the same request
	// ID, the server can check if original operation with the same request ID
	// was received, and if so, will ignore the second request. This prevents
	// clients from accidentally creating duplicate commitments.
	//
	// The request ID must be a valid UUID with the exception that zero UUID is
	// not supported (00000000-0000-0000-0000-000000000000).
	RequestId string `protobuf:"bytes,2,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
	// contains filtered or unexported fields
}

Request message for GetConnectionInfo.

func (*GetConnectionInfoRequest) Descriptor

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

Deprecated: Use GetConnectionInfoRequest.ProtoReflect.Descriptor instead.

func (*GetConnectionInfoRequest) GetParent

func (x *GetConnectionInfoRequest) GetParent() string

func (*GetConnectionInfoRequest) GetRequestId

func (x *GetConnectionInfoRequest) GetRequestId() string

func (*GetConnectionInfoRequest) ProtoMessage

func (*GetConnectionInfoRequest) ProtoMessage()

func (*GetConnectionInfoRequest) ProtoReflect

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

func (*GetConnectionInfoRequest) Reset

func (x *GetConnectionInfoRequest) Reset()

func (*GetConnectionInfoRequest) String

func (x *GetConnectionInfoRequest) String() string

GetInstanceRequest

type GetInstanceRequest struct {

	// Required. The name of the resource. For the required format, see the
	// comment on the Instance.name field.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The view of the instance to return.
	View InstanceView `protobuf:"varint,2,opt,name=view,proto3,enum=google.cloud.alloydb.v1beta.InstanceView" json:"view,omitempty"`
	// contains filtered or unexported fields
}

Message for getting a Instance

func (*GetInstanceRequest) Descriptor

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

Deprecated: Use GetInstanceRequest.ProtoReflect.Descriptor instead.

func (*GetInstanceRequest) GetName

func (x *GetInstanceRequest) GetName() string

func (*GetInstanceRequest) GetView

func (x *GetInstanceRequest) GetView() InstanceView

func (*GetInstanceRequest) ProtoMessage

func (*GetInstanceRequest) ProtoMessage()

func (*GetInstanceRequest) ProtoReflect

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

func (*GetInstanceRequest) Reset

func (x *GetInstanceRequest) Reset()

func (*GetInstanceRequest) String

func (x *GetInstanceRequest) String() string

Instance

type Instance struct {
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`

	DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`

	Uid string `protobuf:"bytes,3,opt,name=uid,proto3" json:"uid,omitempty"`

	CreateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`

	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`

	DeleteTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=delete_time,json=deleteTime,proto3" json:"delete_time,omitempty"`

	Labels map[string]string "" /* 153 byte string literal not displayed */

	State Instance_State `protobuf:"varint,8,opt,name=state,proto3,enum=google.cloud.alloydb.v1beta.Instance_State" json:"state,omitempty"`

	InstanceType Instance_InstanceType "" /* 153 byte string literal not displayed */

	MachineConfig *Instance_MachineConfig `protobuf:"bytes,10,opt,name=machine_config,json=machineConfig,proto3" json:"machine_config,omitempty"`

	AvailabilityType Instance_AvailabilityType "" /* 170 byte string literal not displayed */

	GceZone string `protobuf:"bytes,12,opt,name=gce_zone,json=gceZone,proto3" json:"gce_zone,omitempty"`

	DatabaseFlags map[string]string "" /* 189 byte string literal not displayed */

	WritableNode *Instance_Node `protobuf:"bytes,19,opt,name=writable_node,json=writableNode,proto3" json:"writable_node,omitempty"`

	Nodes []*Instance_Node `protobuf:"bytes,20,rep,name=nodes,proto3" json:"nodes,omitempty"`

	QueryInsightsConfig *Instance_QueryInsightsInstanceConfig `protobuf:"bytes,21,opt,name=query_insights_config,json=queryInsightsConfig,proto3" json:"query_insights_config,omitempty"`

	ReadPoolConfig *Instance_ReadPoolConfig `protobuf:"bytes,14,opt,name=read_pool_config,json=readPoolConfig,proto3" json:"read_pool_config,omitempty"`

	IpAddress string `protobuf:"bytes,15,opt,name=ip_address,json=ipAddress,proto3" json:"ip_address,omitempty"`

	Reconciling bool `protobuf:"varint,16,opt,name=reconciling,proto3" json:"reconciling,omitempty"`

	Etag string `protobuf:"bytes,17,opt,name=etag,proto3" json:"etag,omitempty"`

	Annotations map[string]string "" /* 164 byte string literal not displayed */

}

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

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()