alloydbpb

package
v1.10.1 Latest Latest
Warning

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

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

Documentation

Index

Constants

This section is empty.

Variables

View Source
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.

View Source
var (
	ClusterView_name = map[int32]string{
		0: "CLUSTER_VIEW_UNSPECIFIED",
		1: "CLUSTER_VIEW_BASIC",
		2: "CLUSTER_VIEW_CONTINUOUS_BACKUP",
	}
	ClusterView_value = map[string]int32{
		"CLUSTER_VIEW_UNSPECIFIED":       0,
		"CLUSTER_VIEW_BASIC":             1,
		"CLUSTER_VIEW_CONTINUOUS_BACKUP": 2,
	}
)

Enum value maps for ClusterView.

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

Enum value maps for DatabaseVersion.

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

Enum value maps for MigrationSource_MigrationSourceType.

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

Enum value maps for EncryptionInfo_Type.

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

Enum value maps for SslConfig_SslMode.

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

Enum value maps for SslConfig_CaSource.

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

Enum value maps for Cluster_State.

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

Enum value maps for Cluster_ClusterType.

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

Enum value maps for Instance_State.

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

Enum value maps for Instance_InstanceType.

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

Enum value maps for Instance_AvailabilityType.

View Source
var (
	Instance_UpdatePolicy_Mode_name = map[int32]string{
		0: "MODE_UNSPECIFIED",
		1: "DEFAULT",
		2: "FORCE_APPLY",
	}
	Instance_UpdatePolicy_Mode_value = map[string]int32{
		"MODE_UNSPECIFIED": 0,
		"DEFAULT":          1,
		"FORCE_APPLY":      2,
	}
)

Enum value maps for Instance_UpdatePolicy_Mode.

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

Enum value maps for Backup_State.

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

Enum value maps for Backup_Type.

View Source
var (
	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.

View Source
var (
	User_UserType_name = map[int32]string{
		0: "USER_TYPE_UNSPECIFIED",
		1: "ALLOYDB_BUILT_IN",
		2: "ALLOYDB_IAM_USER",
	}
	User_UserType_value = map[string]int32{
		"USER_TYPE_UNSPECIFIED": 0,
		"ALLOYDB_BUILT_IN":      1,
		"ALLOYDB_IAM_USER":      2,
	}
)

Enum value maps for User_UserType.

View Source
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.

View Source
var (
	InjectFaultRequest_FaultType_name = map[int32]string{
		0: "FAULT_TYPE_UNSPECIFIED",
		1: "STOP_VM",
	}
	InjectFaultRequest_FaultType_value = map[string]int32{
		"FAULT_TYPE_UNSPECIFIED": 0,
		"STOP_VM":                1,
	}
)

Enum value maps for InjectFaultRequest_FaultType.

View Source
var File_google_cloud_alloydb_v1beta_resources_proto protoreflect.FileDescriptor
View Source
var File_google_cloud_alloydb_v1beta_service_proto protoreflect.FileDescriptor

Functions

func RegisterAlloyDBAdminServer

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

Types

type 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)
	// Injects fault in an instance.
	// Imperative only.
	InjectFault(ctx context.Context, in *InjectFaultRequest, 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 AlloyDB connectors and the
	// Auth Proxy client. The endpoint's behavior is subject to change without
	// notice, so do not rely on its behavior remaining constant. Future changes
	// will not break AlloyDB connectors or 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)
	// Lists Users in a given project and location.
	ListUsers(ctx context.Context, in *ListUsersRequest, opts ...grpc.CallOption) (*ListUsersResponse, error)
	// Gets details of a single User.
	GetUser(ctx context.Context, in *GetUserRequest, opts ...grpc.CallOption) (*User, error)
	// Creates a new User in a given project, location, and cluster.
	CreateUser(ctx context.Context, in *CreateUserRequest, opts ...grpc.CallOption) (*User, error)
	// Updates the parameters of a single User.
	UpdateUser(ctx context.Context, in *UpdateUserRequest, opts ...grpc.CallOption) (*User, error)
	// Deletes a single User.
	DeleteUser(ctx context.Context, in *DeleteUserRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	// Lists Databases in a given project and location.
	ListDatabases(ctx context.Context, in *ListDatabasesRequest, opts ...grpc.CallOption) (*ListDatabasesResponse, 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.

type 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)
	// Injects fault in an instance.
	// Imperative only.
	InjectFault(context.Context, *InjectFaultRequest) (*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 AlloyDB connectors and the
	// Auth Proxy client. The endpoint's behavior is subject to change without
	// notice, so do not rely on its behavior remaining constant. Future changes
	// will not break AlloyDB connectors or the Auth Proxy client.
	GenerateClientCertificate(context.Context, *GenerateClientCertificateRequest) (*GenerateClientCertificateResponse, error)
	// Get instance metadata used for a connection.
	GetConnectionInfo(context.Context, *GetConnectionInfoRequest) (*ConnectionInfo, error)
	// Lists Users in a given project and location.
	ListUsers(context.Context, *ListUsersRequest) (*ListUsersResponse, error)
	// Gets details of a single User.
	GetUser(context.Context, *GetUserRequest) (*User, error)
	// Creates a new User in a given project, location, and cluster.
	CreateUser(context.Context, *CreateUserRequest) (*User, error)
	// Updates the parameters of a single User.
	UpdateUser(context.Context, *UpdateUserRequest) (*User, error)
	// Deletes a single User.
	DeleteUser(context.Context, *DeleteUserRequest) (*emptypb.Empty, error)
	// Lists Databases in a given project and location.
	ListDatabases(context.Context, *ListDatabasesRequest) (*ListDatabasesResponse, error)
}

AlloyDBAdminServer is the server API for AlloyDBAdmin service.

type AutomatedBackupPolicy

type AutomatedBackupPolicy struct {

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

Message describing the user-specified automated backup policy.

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

func (*AutomatedBackupPolicy) Descriptor deprecated

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

Deprecated: Use AutomatedBackupPolicy.ProtoReflect.Descriptor instead.

func (*AutomatedBackupPolicy) GetBackupWindow

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

func (*AutomatedBackupPolicy) GetEnabled

func (x *AutomatedBackupPolicy) GetEnabled() bool

func (*AutomatedBackupPolicy) GetEncryptionConfig

func (x *AutomatedBackupPolicy) GetEncryptionConfig() *EncryptionConfig

func (*AutomatedBackupPolicy) GetLabels

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

func (*AutomatedBackupPolicy) GetLocation

func (x *AutomatedBackupPolicy) GetLocation() string

func (*AutomatedBackupPolicy) GetQuantityBasedRetention

func (*AutomatedBackupPolicy) GetRetention

func (m *AutomatedBackupPolicy) GetRetention() isAutomatedBackupPolicy_Retention

func (*AutomatedBackupPolicy) GetSchedule

func (m *AutomatedBackupPolicy) GetSchedule() isAutomatedBackupPolicy_Schedule

func (*AutomatedBackupPolicy) GetTimeBasedRetention

func (*AutomatedBackupPolicy) GetWeeklySchedule

func (*AutomatedBackupPolicy) ProtoMessage

func (*AutomatedBackupPolicy) ProtoMessage()

func (*AutomatedBackupPolicy) ProtoReflect

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

func (*AutomatedBackupPolicy) Reset

func (x *AutomatedBackupPolicy) Reset()

func (*AutomatedBackupPolicy) String

func (x *AutomatedBackupPolicy) String() string

type AutomatedBackupPolicy_QuantityBasedRetention

type AutomatedBackupPolicy_QuantityBasedRetention struct {

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

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

func (*AutomatedBackupPolicy_QuantityBasedRetention) Descriptor deprecated

Deprecated: Use AutomatedBackupPolicy_QuantityBasedRetention.ProtoReflect.Descriptor instead.

func (*AutomatedBackupPolicy_QuantityBasedRetention) GetCount

func (*AutomatedBackupPolicy_QuantityBasedRetention) ProtoMessage

func (*AutomatedBackupPolicy_QuantityBasedRetention) ProtoReflect

func (*AutomatedBackupPolicy_QuantityBasedRetention) Reset

func (*AutomatedBackupPolicy_QuantityBasedRetention) String

type AutomatedBackupPolicy_QuantityBasedRetention_

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

type AutomatedBackupPolicy_TimeBasedRetention

type AutomatedBackupPolicy_TimeBasedRetention struct {

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

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

func (*AutomatedBackupPolicy_TimeBasedRetention) Descriptor deprecated

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

Deprecated: Use AutomatedBackupPolicy_TimeBasedRetention.ProtoReflect.Descriptor instead.

func (*AutomatedBackupPolicy_TimeBasedRetention) GetRetentionPeriod

func (*AutomatedBackupPolicy_TimeBasedRetention) ProtoMessage

func (*AutomatedBackupPolicy_TimeBasedRetention) ProtoReflect

func (*AutomatedBackupPolicy_TimeBasedRetention) Reset

func (*AutomatedBackupPolicy_TimeBasedRetention) String

type AutomatedBackupPolicy_TimeBasedRetention_

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

type AutomatedBackupPolicy_WeeklySchedule

type AutomatedBackupPolicy_WeeklySchedule struct {

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

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

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

func (*AutomatedBackupPolicy_WeeklySchedule) Descriptor deprecated

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

Deprecated: Use AutomatedBackupPolicy_WeeklySchedule.ProtoReflect.Descriptor instead.

func (*AutomatedBackupPolicy_WeeklySchedule) GetDaysOfWeek

func (*AutomatedBackupPolicy_WeeklySchedule) GetStartTimes

func (*AutomatedBackupPolicy_WeeklySchedule) ProtoMessage

func (*AutomatedBackupPolicy_WeeklySchedule) ProtoMessage()

func (*AutomatedBackupPolicy_WeeklySchedule) ProtoReflect

func (*AutomatedBackupPolicy_WeeklySchedule) Reset

func (*AutomatedBackupPolicy_WeeklySchedule) String

type AutomatedBackupPolicy_WeeklySchedule_

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

type Backup

type Backup struct {

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

Message describing Backup object

func (*Backup) Descriptor deprecated

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

Deprecated: Use Backup.ProtoReflect.Descriptor instead.

func (*Backup) GetAnnotations

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

func (*Backup) GetClusterName

func (x *Backup) GetClusterName() string

func (*Backup) GetClusterUid

func (x *Backup) GetClusterUid() string

func (*Backup) GetCreateTime

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

func (*Backup) GetDatabaseVersion added in v1.5.0

func (x *Backup) GetDatabaseVersion() DatabaseVersion

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) GetExpiryQuantity added in v1.5.0

func (x *Backup) GetExpiryQuantity() *Backup_QuantityBasedExpiry

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) GetSatisfiesPzs added in v1.10.0

func (x *Backup) GetSatisfiesPzs() bool

func (*Backup) GetSizeBytes

func (x *Backup) GetSizeBytes() int64

func (*Backup) GetState

func (x *Backup) GetState() Backup_State

func (*Backup) GetType

func (x *Backup) GetType() Backup_Type

func (*Backup) GetUid

func (x *Backup) GetUid() string

func (*Backup) GetUpdateTime

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

func (*Backup) ProtoMessage

func (*Backup) ProtoMessage()

func (*Backup) ProtoReflect

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

func (*Backup) Reset

func (x *Backup) Reset()

func (*Backup) String

func (x *Backup) String() string

type BackupSource

type BackupSource struct {

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

Message describing a BackupSource.

func (*BackupSource) Descriptor deprecated

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

Deprecated: Use BackupSource.ProtoReflect.Descriptor instead.

func (*BackupSource) GetBackupName

func (x *BackupSource) GetBackupName() string

func (*BackupSource) GetBackupUid

func (x *BackupSource) GetBackupUid() string

func (*BackupSource) ProtoMessage

func (*BackupSource) ProtoMessage()

func (*BackupSource) ProtoReflect

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

func (*BackupSource) Reset

func (x *BackupSource) Reset()

func (*BackupSource) String

func (x *BackupSource) String() string

type Backup_QuantityBasedExpiry added in v1.5.0

type Backup_QuantityBasedExpiry struct {

	// Output only. The backup's position among its backups with the same source
	// cluster and type, by descending chronological order create time(i.e.
	// newest first).
	RetentionCount int32 `protobuf:"varint,1,opt,name=retention_count,json=retentionCount,proto3" json:"retention_count,omitempty"`
	// Output only. The length of the quantity-based queue, specified by the
	// backup's retention policy.
	TotalRetentionCount int32 `protobuf:"varint,2,opt,name=total_retention_count,json=totalRetentionCount,proto3" json:"total_retention_count,omitempty"`
	// contains filtered or unexported fields
}

A backup's position in a quantity-based retention queue, of backups with the same source cluster and type, with length, retention, specified by the backup's retention policy. Once the position is greater than the retention, the backup is eligible to be garbage collected.

Example: 5 backups from the same source cluster and type with a quantity-based retention of 3 and denoted by backup_id (position, retention).

Safe: backup_5 (1, 3), backup_4, (2, 3), backup_3 (3, 3). Awaiting garbage collection: backup_2 (4, 3), backup_1 (5, 3)

func (*Backup_QuantityBasedExpiry) Descriptor deprecated added in v1.5.0

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

Deprecated: Use Backup_QuantityBasedExpiry.ProtoReflect.Descriptor instead.

func (*Backup_QuantityBasedExpiry) GetRetentionCount added in v1.5.0

func (x *Backup_QuantityBasedExpiry) GetRetentionCount() int32

func (*Backup_QuantityBasedExpiry) GetTotalRetentionCount added in v1.5.0

func (x *Backup_QuantityBasedExpiry) GetTotalRetentionCount() int32

func (*Backup_QuantityBasedExpiry) ProtoMessage added in v1.5.0

func (*Backup_QuantityBasedExpiry) ProtoMessage()

func (*Backup_QuantityBasedExpiry) ProtoReflect added in v1.5.0

func (*Backup_QuantityBasedExpiry) Reset added in v1.5.0

func (x *Backup_QuantityBasedExpiry) Reset()

func (*Backup_QuantityBasedExpiry) String added in v1.5.0

func (x *Backup_QuantityBasedExpiry) String() string

type Backup_State

type Backup_State int32

Backup State

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

func (Backup_State) Descriptor

func (Backup_State) Enum

func (x Backup_State) Enum() *Backup_State

func (Backup_State) EnumDescriptor deprecated

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

Deprecated: Use Backup_State.Descriptor instead.

func (Backup_State) Number

func (Backup_State) String

func (x Backup_State) String() string

func (Backup_State) Type

type Backup_Type

type Backup_Type int32

Backup Type

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

func (Backup_Type) Descriptor

func (Backup_Type) Enum

func (x Backup_Type) Enum() *Backup_Type

func (Backup_Type) EnumDescriptor deprecated

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

Deprecated: Use Backup_Type.Descriptor instead.

func (Backup_Type) Number

func (x Backup_Type) Number() protoreflect.EnumNumber

func (Backup_Type) String

func (x Backup_Type) String() string

func (Backup_Type) Type

type BatchCreateInstanceStatus

type BatchCreateInstanceStatus struct {

	// The current state of an instance involved in the batch create operation.
	// Once the operation is complete, the final state of the instances in the
	// LRO can be one of:
	//  1. ACTIVE, indicating that instances were created successfully
	//  2. FAILED, indicating that a particular instance failed creation
	//  3. ROLLED_BACK indicating that although the instance was created
	//     successfully, it had to be rolled back and deleted due to failure in
	//     other steps of the workflow.
	State BatchCreateInstanceStatus_State `` /* 129-byte string literal not displayed */
	// DEPRECATED - Use the error field instead.
	// Error, if any error occurred and is available, during instance creation.
	ErrorMsg string `protobuf:"bytes,2,opt,name=error_msg,json=errorMsg,proto3" json:"error_msg,omitempty"`
	// The RPC status of the instance creation operation. This field will be
	// present if an error happened during the instance creation.
	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"`
	// contains filtered or unexported fields
}

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 deprecated

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 (*BatchCreateInstanceStatus) GetType

func (*BatchCreateInstanceStatus) ProtoMessage

func (*BatchCreateInstanceStatus) ProtoMessage()

func (*BatchCreateInstanceStatus) ProtoReflect

func (*BatchCreateInstanceStatus) Reset

func (x *BatchCreateInstanceStatus) Reset()

func (*BatchCreateInstanceStatus) String

func (x *BatchCreateInstanceStatus) String() string

type 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.

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

func (BatchCreateInstanceStatus_State) EnumDescriptor deprecated

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

Deprecated: Use BatchCreateInstanceStatus_State.Descriptor instead.

func (BatchCreateInstanceStatus_State) Number

func (BatchCreateInstanceStatus_State) String

func (BatchCreateInstanceStatus_State) Type

type BatchCreateInstancesMetadata

type BatchCreateInstancesMetadata struct {

	// The instances being created in the API call. Each string in this list
	// is the server defined resource path for target instances in the request
	// and for the format of each string, see the comment on the Instance.name
	// field.
	InstanceTargets []string `protobuf:"bytes,1,rep,name=instance_targets,json=instanceTargets,proto3" json:"instance_targets,omitempty"`
	// A map representing state of the instances involved in the
	// BatchCreateInstances operation during the operation execution.
	// The instance state will be in STATE_UNSPECIFIED state if the instance has
	// not yet been picked up for processing.
	// The key of the map is the name of the instance resource.
	// For the format, see the comment on the Instance.name field.
	InstanceStatuses map[string]*BatchCreateInstanceStatus `` /* 197-byte string literal not displayed */
	// contains filtered or unexported fields
}

Message for metadata that is specific to BatchCreateInstances API. NEXT_ID: 3

func (*BatchCreateInstancesMetadata) Descriptor deprecated

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 (*BatchCreateInstancesMetadata) Reset

func (x *BatchCreateInstancesMetadata) Reset()

func (*BatchCreateInstancesMetadata) String

type 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 deprecated

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 (*BatchCreateInstancesRequest) ProtoMessage

func (*BatchCreateInstancesRequest) ProtoMessage()

func (*BatchCreateInstancesRequest) ProtoReflect

func (*BatchCreateInstancesRequest) Reset

func (x *BatchCreateInstancesRequest) Reset()

func (*BatchCreateInstancesRequest) String

func (x *BatchCreateInstancesRequest) String() string

type 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 deprecated

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 (*BatchCreateInstancesResponse) Reset

func (x *BatchCreateInstancesResponse) Reset()

func (*BatchCreateInstancesResponse) String

type Cluster

type Cluster struct {

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

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

func (*Cluster) Descriptor deprecated

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

Deprecated: Use Cluster.ProtoReflect.Descriptor instead.

func (*Cluster) GetAnnotations

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

func (*Cluster) GetAutomatedBackupPolicy

func (x *Cluster) GetAutomatedBackupPolicy() *AutomatedBackupPolicy

func (*Cluster) GetBackupSource

func (x *Cluster) GetBackupSource() *BackupSource

func (*Cluster) GetClusterType

func (x *Cluster) GetClusterType() Cluster_ClusterType

func (*Cluster) 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 deprecated

func (x *Cluster) GetNetwork() string

Deprecated: Marked as deprecated in google/cloud/alloydb/v1beta/resources.proto.

func (*Cluster) GetNetworkConfig added in v1.2.0

func (x *Cluster) GetNetworkConfig() *Cluster_NetworkConfig

func (*Cluster) GetPrimaryConfig

func (x *Cluster) GetPrimaryConfig() *Cluster_PrimaryConfig

func (*Cluster) GetReconciling

func (x *Cluster) GetReconciling() bool

func (*Cluster) GetSatisfiesPzs added in v1.10.0

func (x *Cluster) GetSatisfiesPzs() bool

func (*Cluster) GetSecondaryConfig

func (x *Cluster) GetSecondaryConfig() *Cluster_SecondaryConfig

func (*Cluster) GetSource

func (m *Cluster) GetSource() isCluster_Source

func (*Cluster) GetSslConfig deprecated

func (x *Cluster) GetSslConfig() *SslConfig

Deprecated: Marked as deprecated in google/cloud/alloydb/v1beta/resources.proto.

func (*Cluster) GetState

func (x *Cluster) GetState() Cluster_State

func (*Cluster) GetUid

func (x *Cluster) GetUid() string

func (*Cluster) GetUpdateTime

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

func (*Cluster) ProtoMessage

func (*Cluster) ProtoMessage()

func (*Cluster) ProtoReflect

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

func (*Cluster) Reset

func (x *Cluster) Reset()

func (*Cluster) String

func (x *Cluster) String() string

type ClusterView added in v1.2.0

type ClusterView int32

View on Cluster. Pass this enum to rpcs that returns a cluster message to control which subsets of fields to get.

const (
	// CLUSTER_VIEW_UNSPECIFIED Not specified, equivalent to BASIC.
	ClusterView_CLUSTER_VIEW_UNSPECIFIED ClusterView = 0
	// BASIC server responses include all the relevant cluster details, excluding
	// Cluster.ContinuousBackupInfo.EarliestRestorableTime and other view-specific
	// fields. The default value.
	ClusterView_CLUSTER_VIEW_BASIC ClusterView = 1
	// CONTINUOUS_BACKUP response returns all the fields from BASIC plus
	// the earliest restorable time if continuous backups are enabled.
	// May increase latency.
	ClusterView_CLUSTER_VIEW_CONTINUOUS_BACKUP ClusterView = 2
)

func (ClusterView) Descriptor added in v1.2.0

func (ClusterView) Enum added in v1.2.0

func (x ClusterView) Enum() *ClusterView

func (ClusterView) EnumDescriptor deprecated added in v1.2.0

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

Deprecated: Use ClusterView.Descriptor instead.

func (ClusterView) Number added in v1.2.0

func (x ClusterView) Number() protoreflect.EnumNumber

func (ClusterView) String added in v1.2.0

func (x ClusterView) String() string

func (ClusterView) Type added in v1.2.0

type Cluster_BackupSource

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

type Cluster_ClusterType

type Cluster_ClusterType int32

Type of Cluster

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

func (Cluster_ClusterType) Descriptor

func (Cluster_ClusterType) Enum

func (Cluster_ClusterType) EnumDescriptor deprecated

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

Deprecated: Use Cluster_ClusterType.Descriptor instead.

func (Cluster_ClusterType) Number

func (Cluster_ClusterType) String

func (x Cluster_ClusterType) String() string

func (Cluster_ClusterType) Type

type Cluster_MigrationSource

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

type Cluster_NetworkConfig added in v1.2.0

type Cluster_NetworkConfig struct {

	// Optional. The resource link for the VPC network in which cluster
	// resources are created and from which they are accessible via Private IP.
	// The network must belong to the same project as the cluster. It is
	// specified in the form:
	// "projects/{project_number}/global/networks/{network_id}". This is
	// required to create a cluster.
	Network string `protobuf:"bytes,1,opt,name=network,proto3" json:"network,omitempty"`
	// Optional. Name of the allocated IP range for the private IP AlloyDB
	// cluster, for example: "google-managed-services-default". If set, the
	// instance IPs for this cluster will be created in the allocated range. The
	// range name must comply with RFC 1035. Specifically, the name must be 1-63
	// characters long and match the regular expression
	// `[a-z]([-a-z0-9]*[a-z0-9])?`.
	// Field name is intended to be consistent with Cloud SQL.
	AllocatedIpRange string `protobuf:"bytes,2,opt,name=allocated_ip_range,json=allocatedIpRange,proto3" json:"allocated_ip_range,omitempty"`
	// contains filtered or unexported fields
}

Metadata related to network configuration.

func (*Cluster_NetworkConfig) Descriptor deprecated added in v1.2.0

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

Deprecated: Use Cluster_NetworkConfig.ProtoReflect.Descriptor instead.

func (*Cluster_NetworkConfig) GetAllocatedIpRange added in v1.2.0

func (x *Cluster_NetworkConfig) GetAllocatedIpRange() string

func (*Cluster_NetworkConfig) GetNetwork added in v1.2.0

func (x *Cluster_NetworkConfig) GetNetwork() string

func (*Cluster_NetworkConfig) ProtoMessage added in v1.2.0

func (*Cluster_NetworkConfig) ProtoMessage()

func (*Cluster_NetworkConfig) ProtoReflect added in v1.2.0

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

func (*Cluster_NetworkConfig) Reset added in v1.2.0

func (x *Cluster_NetworkConfig) Reset()

func (*Cluster_NetworkConfig) String added in v1.2.0

func (x *Cluster_NetworkConfig) String() string

type Cluster_PrimaryConfig

type Cluster_PrimaryConfig struct {

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

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

func (*Cluster_PrimaryConfig) Descriptor deprecated

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

Deprecated: Use Cluster_PrimaryConfig.ProtoReflect.Descriptor instead.

func (*Cluster_PrimaryConfig) GetSecondaryClusterNames

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

func (*Cluster_PrimaryConfig) ProtoMessage

func (*Cluster_PrimaryConfig) ProtoMessage()

func (*Cluster_PrimaryConfig) ProtoReflect

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

func (*Cluster_PrimaryConfig) Reset

func (x *Cluster_PrimaryConfig) Reset()

func (*Cluster_PrimaryConfig) String

func (x *Cluster_PrimaryConfig) String() string

type Cluster_SecondaryConfig

type Cluster_SecondaryConfig struct {

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

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

func (*Cluster_SecondaryConfig) Descriptor deprecated

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

Deprecated: Use Cluster_SecondaryConfig.ProtoReflect.Descriptor instead.

func (*Cluster_SecondaryConfig) GetPrimaryClusterName

func (x *Cluster_SecondaryConfig) GetPrimaryClusterName() string

func (*Cluster_SecondaryConfig) ProtoMessage

func (*Cluster_SecondaryConfig) ProtoMessage()

func (*Cluster_SecondaryConfig) ProtoReflect

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

func (*Cluster_SecondaryConfig) Reset

func (x *Cluster_SecondaryConfig) Reset()

func (*Cluster_SecondaryConfig) String

func (x *Cluster_SecondaryConfig) String() string

type Cluster_State

type Cluster_State int32

Cluster State

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

func (Cluster_State) Descriptor

func (Cluster_State) Enum

func (x Cluster_State) Enum() *Cluster_State

func (Cluster_State) EnumDescriptor deprecated

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

Deprecated: Use Cluster_State.Descriptor instead.

func (Cluster_State) Number

func (Cluster_State) String

func (x Cluster_State) String() string

func (Cluster_State) Type

type 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 private network IP address for the Instance. This is the
	// default IP for the instance and is always created (even if enable_public_ip
	// is set). 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 public IP addresses for the Instance. This is available
	// ONLY when enable_public_ip is set. This is the connection endpoint for an
	// end-user application.
	PublicIpAddress string `protobuf:"bytes,5,opt,name=public_ip_address,json=publicIpAddress,proto3" json:"public_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.
	//
	// Deprecated: Marked as deprecated in google/cloud/alloydb/v1beta/resources.proto.
	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"`
	// Output only. The DNS name to use with PSC for the Instance.
	PscDnsName string `protobuf:"bytes,6,opt,name=psc_dns_name,json=pscDnsName,proto3" json:"psc_dns_name,omitempty"`
	// contains filtered or unexported fields
}

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

func (*ConnectionInfo) Descriptor deprecated

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 deprecated

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

Deprecated: Marked as deprecated in google/cloud/alloydb/v1beta/resources.proto.

func (*ConnectionInfo) GetPscDnsName added in v1.10.0

func (x *ConnectionInfo) GetPscDnsName() string

func (*ConnectionInfo) GetPublicIpAddress added in v1.10.0

func (x *ConnectionInfo) GetPublicIpAddress() 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

type 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 that are eligible to restore from using PITR. To support
	// the entire recovery window, backups and logs are retained for one day more
	// than the recovery window. If not set, 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 deprecated

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

type 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"`
	// Output only. The earliest restorable time that can be restored to. Output
	// only field.
	EarliestRestorableTime *timestamppb.Timestamp `` /* 129-byte string literal not displayed */
	// contains filtered or unexported fields
}

ContinuousBackupInfo describes the continuous backup properties of a cluster.

func (*ContinuousBackupInfo) Descriptor deprecated

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

Deprecated: Use ContinuousBackupInfo.ProtoReflect.Descriptor instead.

func (*ContinuousBackupInfo) GetEarliestRestorableTime added in v1.2.0

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

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

type 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 deprecated

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

type 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 deprecated

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

type CreateClusterRequest

type CreateClusterRequest struct {

	// Required. The location of the new 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.
	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 deprecated

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

type 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 deprecated

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

type CreateInstanceRequests

type CreateInstanceRequests struct {

	// Required. Primary and read replica instances to be created. This list
	// should not be empty.
	CreateInstanceRequests []*CreateInstanceRequest `` /* 129-byte string literal not displayed */
	// contains filtered or unexported fields
}

See usage below for notes.

func (*CreateInstanceRequests) Descriptor deprecated

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

type CreateSecondaryClusterRequest

type CreateSecondaryClusterRequest struct {

	// Required. The location of the new 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 deprecated

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 (*CreateSecondaryClusterRequest) Reset

func (x *CreateSecondaryClusterRequest) Reset()

func (*CreateSecondaryClusterRequest) String

type 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 deprecated

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 (*CreateSecondaryInstanceRequest) Reset

func (x *CreateSecondaryInstanceRequest) Reset()

func (*CreateSecondaryInstanceRequest) String

type CreateUserRequest added in v1.2.0

type CreateUserRequest struct {

	// Required. Value for parent.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Required. ID of the requesting object.
	UserId string `protobuf:"bytes,2,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	// Required. The resource being created
	User *User `protobuf:"bytes,3,opt,name=user,proto3" json:"user,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 User

func (*CreateUserRequest) Descriptor deprecated added in v1.2.0

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

Deprecated: Use CreateUserRequest.ProtoReflect.Descriptor instead.

func (*CreateUserRequest) GetParent added in v1.2.0

func (x *CreateUserRequest) GetParent() string

func (*CreateUserRequest) GetRequestId added in v1.2.0

func (x *CreateUserRequest) GetRequestId() string

func (*CreateUserRequest) GetUser added in v1.2.0

func (x *CreateUserRequest) GetUser() *User

func (*CreateUserRequest) GetUserId added in v1.2.0

func (x *CreateUserRequest) GetUserId() string

func (*CreateUserRequest) GetValidateOnly added in v1.2.0

func (x *CreateUserRequest) GetValidateOnly() bool

func (*CreateUserRequest) ProtoMessage added in v1.2.0

func (*CreateUserRequest) ProtoMessage()

func (*CreateUserRequest) ProtoReflect added in v1.2.0

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

func (*CreateUserRequest) Reset added in v1.2.0

func (x *CreateUserRequest) Reset()

func (*CreateUserRequest) String added in v1.2.0

func (x *CreateUserRequest) String() string

type Database added in v1.10.0

type Database struct {

	// Identifier. Name of the resource in the form of
	// `projects/{project}/locations/{location}/clusters/{cluster}/databases/{database}`.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. Charset for the database.
	// This field can contain any PostgreSQL supported charset name.
	// Example values include "UTF8", "SQL_ASCII", etc.
	Charset string `protobuf:"bytes,2,opt,name=charset,proto3" json:"charset,omitempty"`
	// Optional. Collation for the database.
	// Name of the custom or native collation for postgres.
	// Example values include "C", "POSIX", etc
	Collation string `protobuf:"bytes,3,opt,name=collation,proto3" json:"collation,omitempty"`
	// contains filtered or unexported fields
}

Message describing Database object.

func (*Database) Descriptor deprecated added in v1.10.0

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

Deprecated: Use Database.ProtoReflect.Descriptor instead.

func (*Database) GetCharset added in v1.10.0

func (x *Database) GetCharset() string

func (*Database) GetCollation added in v1.10.0

func (x *Database) GetCollation() string

func (*Database) GetName added in v1.10.0

func (x *Database) GetName() string

func (*Database) ProtoMessage added in v1.10.0

func (*Database) ProtoMessage()

func (*Database) ProtoReflect added in v1.10.0

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

func (*Database) Reset added in v1.10.0

func (x *Database) Reset()

func (*Database) String added in v1.10.0

func (x *Database) String() string

type DatabaseVersion

type DatabaseVersion int32

The supported database engine versions.

const (
	// This is an unknown database version.
	DatabaseVersion_DATABASE_VERSION_UNSPECIFIED DatabaseVersion = 0
	// DEPRECATED - The database version is Postgres 13.
	//
	// Deprecated: Marked as deprecated in google/cloud/alloydb/v1beta/resources.proto.
	DatabaseVersion_POSTGRES_13 DatabaseVersion = 1
	// The database version is Postgres 14.
	DatabaseVersion_POSTGRES_14 DatabaseVersion = 2
	// The database version is Postgres 15.
	DatabaseVersion_POSTGRES_15 DatabaseVersion = 3
)

func (DatabaseVersion) Descriptor

func (DatabaseVersion) Enum

func (x DatabaseVersion) Enum() *DatabaseVersion

func (DatabaseVersion) EnumDescriptor deprecated

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

Deprecated: Use DatabaseVersion.Descriptor instead.

func (DatabaseVersion) Number

func (DatabaseVersion) String

func (x DatabaseVersion) String() string

func (DatabaseVersion) Type

type 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 deprecated

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

type 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 deprecated

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

type 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 deprecated

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

type DeleteUserRequest added in v1.2.0

type DeleteUserRequest struct {

	// Required. The name of the resource. For the required format, see the
	// comment on the User.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"`
	// contains filtered or unexported fields
}

Message for deleting a User

func (*DeleteUserRequest) Descriptor deprecated added in v1.2.0

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

Deprecated: Use DeleteUserRequest.ProtoReflect.Descriptor instead.

func (*DeleteUserRequest) GetName added in v1.2.0

func (x *DeleteUserRequest) GetName() string

func (*DeleteUserRequest) GetRequestId added in v1.2.0

func (x *DeleteUserRequest) GetRequestId() string

func (*DeleteUserRequest) GetValidateOnly added in v1.2.0

func (x *DeleteUserRequest) GetValidateOnly() bool

func (*DeleteUserRequest) ProtoMessage added in v1.2.0

func (*DeleteUserRequest) ProtoMessage()

func (*DeleteUserRequest) ProtoReflect added in v1.2.0

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

func (*DeleteUserRequest) Reset added in v1.2.0

func (x *DeleteUserRequest) Reset()

func (*DeleteUserRequest) String added in v1.2.0

func (x *DeleteUserRequest) String() string

type EncryptionConfig

type EncryptionConfig struct {

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

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

func (*EncryptionConfig) Descriptor deprecated

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

Deprecated: Use EncryptionConfig.ProtoReflect.Descriptor instead.

func (*EncryptionConfig) GetKmsKeyName

func (x *EncryptionConfig) GetKmsKeyName() string

func (*EncryptionConfig) ProtoMessage

func (*EncryptionConfig) ProtoMessage()

func (*EncryptionConfig) ProtoReflect

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

func (*EncryptionConfig) Reset

func (x *EncryptionConfig) Reset()

func (*EncryptionConfig) String

func (x *EncryptionConfig) String() string

type EncryptionInfo

type EncryptionInfo struct {

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

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

func (*EncryptionInfo) Descriptor deprecated

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

Deprecated: Use EncryptionInfo.ProtoReflect.Descriptor instead.

func (*EncryptionInfo) GetEncryptionType

func (x *EncryptionInfo) GetEncryptionType() EncryptionInfo_Type

func (*EncryptionInfo) GetKmsKeyVersions

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

func (*EncryptionInfo) ProtoMessage

func (*EncryptionInfo) ProtoMessage()

func (*EncryptionInfo) ProtoReflect

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

func (*EncryptionInfo) Reset

func (x *EncryptionInfo) Reset()

func (*EncryptionInfo) String

func (x *EncryptionInfo) String() string

type EncryptionInfo_Type

type EncryptionInfo_Type int32

Possible encryption types.

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

func (EncryptionInfo_Type) Descriptor

func (EncryptionInfo_Type) Enum

func (EncryptionInfo_Type) EnumDescriptor deprecated

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

Deprecated: Use EncryptionInfo_Type.Descriptor instead.

func (EncryptionInfo_Type) Number

func (EncryptionInfo_Type) String

func (x EncryptionInfo_Type) String() string

func (EncryptionInfo_Type) Type

type 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 deprecated

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

type 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). It is
	// recommended to use public_key instead.
	//
	// Deprecated: Marked as deprecated in google/cloud/alloydb/v1beta/service.proto.
	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"`
	// Optional. The public key from the client.
	PublicKey string `protobuf:"bytes,5,opt,name=public_key,json=publicKey,proto3" json:"public_key,omitempty"`
	// Optional. An optional hint to the endpoint to generate a client
	// ceritificate that can be used by AlloyDB connectors to exchange additional
	// metadata with the server after TLS handshake.
	UseMetadataExchange bool `protobuf:"varint,6,opt,name=use_metadata_exchange,json=useMetadataExchange,proto3" json:"use_metadata_exchange,omitempty"`
	// contains filtered or unexported fields
}

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

func (*GenerateClientCertificateRequest) Descriptor deprecated

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

Deprecated: Use GenerateClientCertificateRequest.ProtoReflect.Descriptor instead.

func (*GenerateClientCertificateRequest) GetCertDuration

func (*GenerateClientCertificateRequest) GetParent

func (*GenerateClientCertificateRequest) GetPemCsr deprecated

Deprecated: Marked as deprecated in google/cloud/alloydb/v1beta/service.proto.

func (*GenerateClientCertificateRequest) GetPublicKey added in v1.2.0

func (x *GenerateClientCertificateRequest) GetPublicKey() string

func (*GenerateClientCertificateRequest) GetRequestId

func (x *GenerateClientCertificateRequest) GetRequestId() string

func (*GenerateClientCertificateRequest) GetUseMetadataExchange added in v1.5.0

func (x *GenerateClientCertificateRequest) GetUseMetadataExchange() bool

func (*GenerateClientCertificateRequest) ProtoMessage

func (*GenerateClientCertificateRequest) ProtoMessage()

func (*GenerateClientCertificateRequest) ProtoReflect

func (*GenerateClientCertificateRequest) Reset

func (*GenerateClientCertificateRequest) String

type GenerateClientCertificateResponse

type GenerateClientCertificateResponse struct {

	// Output only. The pem-encoded, signed X.509 certificate.
	//
	// Deprecated: Marked as deprecated in google/cloud/alloydb/v1beta/service.proto.
	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"`
	// Optional. The pem-encoded cluster ca X.509 certificate.
	CaCert string `protobuf:"bytes,3,opt,name=ca_cert,json=caCert,proto3" json:"ca_cert,omitempty"`
	// contains filtered or unexported fields
}

Message returned by a GenerateClientCertificate operation.

func (*GenerateClientCertificateResponse) Descriptor deprecated

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

Deprecated: Use GenerateClientCertificateResponse.ProtoReflect.Descriptor instead.

func (*GenerateClientCertificateResponse) GetCaCert added in v1.2.0

func (*GenerateClientCertificateResponse) GetPemCertificate deprecated

func (x *GenerateClientCertificateResponse) GetPemCertificate() string

Deprecated: Marked as deprecated in google/cloud/alloydb/v1beta/service.proto.

func (*GenerateClientCertificateResponse) GetPemCertificateChain

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

func (*GenerateClientCertificateResponse) ProtoMessage

func (*GenerateClientCertificateResponse) ProtoMessage()

func (*GenerateClientCertificateResponse) ProtoReflect

func (*GenerateClientCertificateResponse) Reset

func (*GenerateClientCertificateResponse) String

type 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 deprecated

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

type 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"`
	// Optional. The view of the cluster to return. Returns all default fields if
	// not set.
	View ClusterView `protobuf:"varint,2,opt,name=view,proto3,enum=google.cloud.alloydb.v1beta.ClusterView" json:"view,omitempty"`
	// contains filtered or unexported fields
}

Message for getting a Cluster

func (*GetClusterRequest) Descriptor deprecated

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

Deprecated: Use GetClusterRequest.ProtoReflect.Descriptor instead.

func (*GetClusterRequest) GetName

func (x *GetClusterRequest) GetName() string

func (*GetClusterRequest) GetView added in v1.2.0

func (x *GetClusterRequest) GetView() ClusterView

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

type 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 deprecated

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

type 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 deprecated

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

type GetUserRequest added in v1.2.0

type GetUserRequest struct {

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

Message for getting a User

func (*GetUserRequest) Descriptor deprecated added in v1.2.0

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

Deprecated: Use GetUserRequest.ProtoReflect.Descriptor instead.

func (*GetUserRequest) GetName added in v1.2.0

func (x *GetUserRequest) GetName() string

func (*GetUserRequest) ProtoMessage added in v1.2.0

func (*GetUserRequest) ProtoMessage()

func (*GetUserRequest) ProtoReflect added in v1.2.0

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

func (*GetUserRequest) Reset added in v1.2.0

func (x *GetUserRequest) Reset()

func (*GetUserRequest) String added in v1.2.0

func (x *GetUserRequest) String() string

type InjectFaultRequest added in v1.2.0

type InjectFaultRequest struct {

	// Required. The type of fault to be injected in an instance.
	FaultType InjectFaultRequest_FaultType `` /* 151-byte string literal not displayed */
	// Required. The name of the resource. For the required format, see the
	// comment on the Instance.name field.
	Name string `protobuf:"bytes,2,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,3,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 fault
	// injection.
	ValidateOnly bool `protobuf:"varint,4,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
	// contains filtered or unexported fields
}

Message for triggering fault injection on an instance

func (*InjectFaultRequest) Descriptor deprecated added in v1.2.0

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

Deprecated: Use InjectFaultRequest.ProtoReflect.Descriptor instead.

func (*InjectFaultRequest) GetFaultType added in v1.2.0

func (*InjectFaultRequest) GetName added in v1.2.0

func (x *InjectFaultRequest) GetName() string

func (*InjectFaultRequest) GetRequestId added in v1.2.0

func (x *InjectFaultRequest) GetRequestId() string

func (*InjectFaultRequest) GetValidateOnly added in v1.2.0

func (x *InjectFaultRequest) GetValidateOnly() bool

func (*InjectFaultRequest) ProtoMessage added in v1.2.0

func (*InjectFaultRequest) ProtoMessage()

func (*InjectFaultRequest) ProtoReflect added in v1.2.0

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

func (*InjectFaultRequest) Reset added in v1.2.0

func (x *InjectFaultRequest) Reset()

func (*InjectFaultRequest) String added in v1.2.0

func (x *InjectFaultRequest) String() string

type InjectFaultRequest_FaultType added in v1.2.0

type InjectFaultRequest_FaultType int32

FaultType contains all valid types of faults that can be injected to an instance.

const (
	// The fault type is unknown.
	InjectFaultRequest_FAULT_TYPE_UNSPECIFIED InjectFaultRequest_FaultType = 0
	// Stop the VM
	InjectFaultRequest_STOP_VM InjectFaultRequest_FaultType = 1
)

func (InjectFaultRequest_FaultType) Descriptor added in v1.2.0

func (InjectFaultRequest_FaultType) Enum added in v1.2.0

func (InjectFaultRequest_FaultType) EnumDescriptor deprecated added in v1.2.0

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

Deprecated: Use InjectFaultRequest_FaultType.Descriptor instead.

func (InjectFaultRequest_FaultType) Number added in v1.2.0

func (InjectFaultRequest_FaultType) String added in v1.2.0

func (InjectFaultRequest_FaultType) Type added in v1.2.0

type Instance

type Instance struct {

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

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

func (*Instance) Descriptor deprecated

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

Deprecated: Use Instance.ProtoReflect.Descriptor instead.

func (*Instance) GetAnnotations

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

func (*Instance) GetAvailabilityType

func (x *Instance) GetAvailabilityType() Instance_AvailabilityType

func (*Instance) GetClientConnectionConfig added in v1.5.0

func (x *Instance) GetClientConnectionConfig() *Instance_ClientConnectionConfig

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) GetNetworkConfig added in v1.10.0

func (x *Instance) GetNetworkConfig() *Instance_InstanceNetworkConfig

func (*Instance) GetNodes

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

func (*Instance) GetPscInstanceConfig added in v1.10.0

func (x *Instance) GetPscInstanceConfig() *Instance_PscInstanceConfig

func (*Instance) GetPublicIpAddress added in v1.10.0

func (x *Instance) GetPublicIpAddress() string

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) GetSatisfiesPzs added in v1.10.0

func (x *Instance) GetSatisfiesPzs() bool

func (*Instance) GetState

func (x *Instance) GetState() Instance_State

func (*Instance) GetUid

func (x *Instance) GetUid() string

func (*Instance) GetUpdatePolicy added in v1.2.0

func (x *Instance) GetUpdatePolicy() *Instance_UpdatePolicy

func (*Instance) GetUpdateTime

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

func (*Instance) GetWritableNode

func (x *Instance) GetWritableNode() *Instance_Node

func (*Instance) ProtoMessage

func (*Instance) ProtoMessage()

func (*Instance) ProtoReflect

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

func (*Instance) Reset

func (x *Instance) Reset()

func (*Instance) String

func (x *Instance) String() string

type InstanceView

type InstanceView int32

View on Instance. Pass this enum to rpcs that returns an Instance message to control which subsets of fields to get.

const (
	// INSTANCE_VIEW_UNSPECIFIED Not specified, equivalent to BASIC.
	InstanceView_INSTANCE_VIEW_UNSPECIFIED InstanceView = 0
	// BASIC server responses for a primary or read instance include all the
	// relevant instance details, excluding the details of each node in the
	// instance. The default value.
	InstanceView_INSTANCE_VIEW_BASIC InstanceView = 1
	// FULL response is equivalent to BASIC for primary instance (for now).
	// For read pool instance, this includes details of each node in the pool.
	InstanceView_INSTANCE_VIEW_FULL InstanceView = 2
)

func (InstanceView) Descriptor

func (InstanceView) Enum

func (x InstanceView) Enum() *InstanceView

func (InstanceView) EnumDescriptor deprecated

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

Deprecated: Use InstanceView.Descriptor instead.

func (InstanceView) Number

func (InstanceView) String

func (x InstanceView) String() string

func (InstanceView) Type

type Instance_AvailabilityType

type Instance_AvailabilityType int32

The Availability type of an instance. Potential values:

  • ZONAL: The instance serves data from only one zone. Outages in that zone affect instance availability.
  • REGIONAL: The instance can serve data from more than one zone in a region (it is highly available).
const (
	// This is an unknown Availability type.
	Instance_AVAILABILITY_TYPE_UNSPECIFIED Instance_AvailabilityType = 0
	// Zonal available instance.
	Instance_ZONAL Instance_AvailabilityType = 1
	// Regional (or Highly) available instance.
	Instance_REGIONAL Instance_AvailabilityType = 2
)

func (Instance_AvailabilityType) Descriptor

func (Instance_AvailabilityType) Enum

func (Instance_AvailabilityType) EnumDescriptor deprecated

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

Deprecated: Use Instance_AvailabilityType.Descriptor instead.

func (Instance_AvailabilityType) Number

func (Instance_AvailabilityType) String

func (x Instance_AvailabilityType) String() string

func (Instance_AvailabilityType) Type

type Instance_ClientConnectionConfig added in v1.5.0

type Instance_ClientConnectionConfig struct {

	// Optional. Configuration to enforce connectors only (ex: AuthProxy)
	// connections to the database.
	RequireConnectors bool `protobuf:"varint,1,opt,name=require_connectors,json=requireConnectors,proto3" json:"require_connectors,omitempty"`
	// Optional. SSL config option for this instance.
	SslConfig *SslConfig `protobuf:"bytes,2,opt,name=ssl_config,json=sslConfig,proto3" json:"ssl_config,omitempty"`
	// contains filtered or unexported fields
}

Client connection configuration

func (*Instance_ClientConnectionConfig) Descriptor deprecated added in v1.5.0

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

Deprecated: Use Instance_ClientConnectionConfig.ProtoReflect.Descriptor instead.

func (*Instance_ClientConnectionConfig) GetRequireConnectors added in v1.5.0

func (x *Instance_ClientConnectionConfig) GetRequireConnectors() bool

func (*Instance_ClientConnectionConfig) GetSslConfig added in v1.5.0

func (x *Instance_ClientConnectionConfig) GetSslConfig() *SslConfig

func (*Instance_ClientConnectionConfig) ProtoMessage added in v1.5.0

func (*Instance_ClientConnectionConfig) ProtoMessage()

func (*Instance_ClientConnectionConfig) ProtoReflect added in v1.5.0

func (*Instance_ClientConnectionConfig) Reset added in v1.5.0

func (*Instance_ClientConnectionConfig) String added in v1.5.0

type Instance_InstanceNetworkConfig added in v1.10.0

type Instance_InstanceNetworkConfig struct {

	// Optional. A list of external network authorized to access this instance.
	AuthorizedExternalNetworks []*Instance_InstanceNetworkConfig_AuthorizedNetwork `` /* 141-byte string literal not displayed */
	// Optional. Enabling public ip for the instance.
	EnablePublicIp bool `protobuf:"varint,2,opt,name=enable_public_ip,json=enablePublicIp,proto3" json:"enable_public_ip,omitempty"`
	// contains filtered or unexported fields
}

Metadata related to instance level network configuration.

func (*Instance_InstanceNetworkConfig) Descriptor deprecated added in v1.10.0

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

Deprecated: Use Instance_InstanceNetworkConfig.ProtoReflect.Descriptor instead.

func (*Instance_InstanceNetworkConfig) GetAuthorizedExternalNetworks added in v1.10.0

func (*Instance_InstanceNetworkConfig) GetEnablePublicIp added in v1.10.0

func (x *Instance_InstanceNetworkConfig) GetEnablePublicIp() bool

func (*Instance_InstanceNetworkConfig) ProtoMessage added in v1.10.0

func (*Instance_InstanceNetworkConfig) ProtoMessage()

func (*Instance_InstanceNetworkConfig) ProtoReflect added in v1.10.0

func (*Instance_InstanceNetworkConfig) Reset added in v1.10.0

func (x *Instance_InstanceNetworkConfig) Reset()

func (*Instance_InstanceNetworkConfig) String added in v1.10.0

type Instance_InstanceNetworkConfig_AuthorizedNetwork added in v1.10.0

type Instance_InstanceNetworkConfig_AuthorizedNetwork struct {

	// CIDR range for one authorzied network of the instance.
	CidrRange string `protobuf:"bytes,1,opt,name=cidr_range,json=cidrRange,proto3" json:"cidr_range,omitempty"`
	// contains filtered or unexported fields
}

AuthorizedNetwork contains metadata for an authorized network.

func (*Instance_InstanceNetworkConfig_AuthorizedNetwork) Descriptor deprecated added in v1.10.0

Deprecated: Use Instance_InstanceNetworkConfig_AuthorizedNetwork.ProtoReflect.Descriptor instead.

func (*Instance_InstanceNetworkConfig_AuthorizedNetwork) GetCidrRange added in v1.10.0

func (*Instance_InstanceNetworkConfig_AuthorizedNetwork) ProtoMessage added in v1.10.0

func (*Instance_InstanceNetworkConfig_AuthorizedNetwork) ProtoReflect added in v1.10.0

func (*Instance_InstanceNetworkConfig_AuthorizedNetwork) Reset added in v1.10.0

func (*Instance_InstanceNetworkConfig_AuthorizedNetwork) String added in v1.10.0

type Instance_InstanceType

type Instance_InstanceType int32

Type of an Instance

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

func (Instance_InstanceType) Descriptor

func (Instance_InstanceType) Enum

func (Instance_InstanceType) EnumDescriptor deprecated

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

Deprecated: Use Instance_InstanceType.Descriptor instead.

func (Instance_InstanceType) Number

func (Instance_InstanceType) String

func (x Instance_InstanceType) String() string

func (Instance_InstanceType) Type

type Instance_MachineConfig

type Instance_MachineConfig struct {

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

MachineConfig describes the configuration of a machine.

func (*Instance_MachineConfig) Descriptor deprecated

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

Deprecated: Use Instance_MachineConfig.ProtoReflect.Descriptor instead.

func (*Instance_MachineConfig) GetCpuCount

func (x *Instance_MachineConfig) GetCpuCount() int32

func (*Instance_MachineConfig) ProtoMessage

func (*Instance_MachineConfig) ProtoMessage()

func (*Instance_MachineConfig) ProtoReflect

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

func (*Instance_MachineConfig) Reset

func (x *Instance_MachineConfig) Reset()

func (*Instance_MachineConfig) String

func (x *Instance_MachineConfig) String() string

type Instance_Node

type Instance_Node struct {

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

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

func (*Instance_Node) Descriptor deprecated

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

Deprecated: Use Instance_Node.ProtoReflect.Descriptor instead.

func (*Instance_Node) GetId

func (x *Instance_Node) GetId() string

func (*Instance_Node) GetIp

func (x *Instance_Node) GetIp() string

func (*Instance_Node) GetState

func (x *Instance_Node) GetState() string

func (*Instance_Node) GetZoneId

func (x *Instance_Node) GetZoneId() string

func (*Instance_Node) ProtoMessage

func (*Instance_Node) ProtoMessage()

func (*Instance_Node) ProtoReflect

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

func (*Instance_Node) Reset

func (x *Instance_Node) Reset()

func (*Instance_Node) String

func (x *Instance_Node) String() string

type Instance_PscInstanceConfig added in v1.10.0

type Instance_PscInstanceConfig struct {

	// Output only. The service attachment created when Private
	// Service Connect (PSC) is enabled for the instance.
	// The name of the resource will be in the format of
	// `projects/<alloydb-tenant-project-number>/regions/<region-name>/serviceAttachments/<service-attachment-name>`
	ServiceAttachmentLink string `` /* 126-byte string literal not displayed */
	// Optional. List of consumer projects that are allowed to create
	// PSC endpoints to service-attachments to this instance.
	AllowedConsumerProjects []string `` /* 132-byte string literal not displayed */
	// Optional. List of consumer networks that are allowed to create
	// PSC endpoints to service-attachments to this instance.
	AllowedConsumerNetworks []string `` /* 132-byte string literal not displayed */
	// Optional. Configurations for setting up PSC interfaces attached to the
	// instance which are used for outbound connectivity. Only primary instances
	// can have PSC interface attached. All the VMs created for the primary
	// instance will share the same configurations. Currently we only support 0
	// or 1 PSC interface.
	PscInterfaceConfigs []*Instance_PscInterfaceConfig `protobuf:"bytes,4,rep,name=psc_interface_configs,json=pscInterfaceConfigs,proto3" json:"psc_interface_configs,omitempty"`
	// Optional. List of service attachments that this instance has created
	// endpoints to connect with. Currently, only a single outgoing service
	// attachment is supported per instance.
	OutgoingServiceAttachmentLinks []string `` /* 155-byte string literal not displayed */
	// Optional. Whether PSC connectivity is enabled for this instance.
	// This is populated by referencing the value from the parent cluster.
	PscEnabled bool `protobuf:"varint,6,opt,name=psc_enabled,json=pscEnabled,proto3" json:"psc_enabled,omitempty"`
	// contains filtered or unexported fields
}

PscInstanceConfig contains PSC related configuration at an instance level.

func (*Instance_PscInstanceConfig) Descriptor deprecated added in v1.10.0

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

Deprecated: Use Instance_PscInstanceConfig.ProtoReflect.Descriptor instead.

func (*Instance_PscInstanceConfig) GetAllowedConsumerNetworks added in v1.10.0

func (x *Instance_PscInstanceConfig) GetAllowedConsumerNetworks() []string

func (*Instance_PscInstanceConfig) GetAllowedConsumerProjects added in v1.10.0

func (x *Instance_PscInstanceConfig) GetAllowedConsumerProjects() []string
func (x *Instance_PscInstanceConfig) GetOutgoingServiceAttachmentLinks() []string

func (*Instance_PscInstanceConfig) GetPscEnabled added in v1.10.0

func (x *Instance_PscInstanceConfig) GetPscEnabled() bool

func (*Instance_PscInstanceConfig) GetPscInterfaceConfigs added in v1.10.0

func (x *Instance_PscInstanceConfig) GetPscInterfaceConfigs() []*Instance_PscInterfaceConfig
func (x *Instance_PscInstanceConfig) GetServiceAttachmentLink() string

func (*Instance_PscInstanceConfig) ProtoMessage added in v1.10.0

func (*Instance_PscInstanceConfig) ProtoMessage()

func (*Instance_PscInstanceConfig) ProtoReflect added in v1.10.0

func (*Instance_PscInstanceConfig) Reset added in v1.10.0

func (x *Instance_PscInstanceConfig) Reset()

func (*Instance_PscInstanceConfig) String added in v1.10.0

func (x *Instance_PscInstanceConfig) String() string

type Instance_PscInterfaceConfig added in v1.10.0

type Instance_PscInterfaceConfig struct {

	// A list of endpoints in the consumer VPC the interface might initiate
	// outbound connections to. This list has to be provided when the PSC
	// interface is created.
	ConsumerEndpointIps []string `protobuf:"bytes,1,rep,name=consumer_endpoint_ips,json=consumerEndpointIps,proto3" json:"consumer_endpoint_ips,omitempty"`
	// The NetworkAttachment resource created in the consumer VPC to which the
	// PSC interface will be linked, in the form of:
	// `projects/${CONSUMER_PROJECT}/regions/${REGION}/networkAttachments/${NETWORK_ATTACHMENT_NAME}`.
	// NetworkAttachment has to be provided when the PSC interface is created.
	NetworkAttachment string `protobuf:"bytes,2,opt,name=network_attachment,json=networkAttachment,proto3" json:"network_attachment,omitempty"`
	// contains filtered or unexported fields
}

Configuration for setting up a PSC interface. This information needs to be provided by the customer. PSC interfaces will be created and added to VMs via SLM (adding a network interface will require recreating the VM). For HA instances this will be done via LDTM.

func (*Instance_PscInterfaceConfig) Descriptor deprecated added in v1.10.0

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

Deprecated: Use Instance_PscInterfaceConfig.ProtoReflect.Descriptor instead.

func (*Instance_PscInterfaceConfig) GetConsumerEndpointIps added in v1.10.0

func (x *Instance_PscInterfaceConfig) GetConsumerEndpointIps() []string

func (*Instance_PscInterfaceConfig) GetNetworkAttachment added in v1.10.0

func (x *Instance_PscInterfaceConfig) GetNetworkAttachment() string

func (*Instance_PscInterfaceConfig) ProtoMessage added in v1.10.0

func (*Instance_PscInterfaceConfig) ProtoMessage()

func (*Instance_PscInterfaceConfig) ProtoReflect added in v1.10.0

func (*Instance_PscInterfaceConfig) Reset added in v1.10.0

func (x *Instance_PscInterfaceConfig) Reset()

func (*Instance_PscInterfaceConfig) String added in v1.10.0

func (x *Instance_PscInterfaceConfig) String() string

type Instance_QueryInsightsInstanceConfig

type Instance_QueryInsightsInstanceConfig struct {

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

QueryInsights Instance specific configuration.

func (*Instance_QueryInsightsInstanceConfig) Descriptor deprecated

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

Deprecated: Use Instance_QueryInsightsInstanceConfig.ProtoReflect.Descriptor instead.

func (*Instance_QueryInsightsInstanceConfig) GetQueryPlansPerMinute

func (x *Instance_QueryInsightsInstanceConfig) GetQueryPlansPerMinute() uint32

func (*Instance_QueryInsightsInstanceConfig) GetQueryStringLength

func (x *Instance_QueryInsightsInstanceConfig) GetQueryStringLength() uint32

func (*Instance_QueryInsightsInstanceConfig) GetRecordApplicationTags

func (x *Instance_QueryInsightsInstanceConfig) GetRecordApplicationTags() bool

func (*Instance_QueryInsightsInstanceConfig) GetRecordClientAddress

func (x *Instance_QueryInsightsInstanceConfig) GetRecordClientAddress() bool

func (*Instance_QueryInsightsInstanceConfig) ProtoMessage

func (*Instance_QueryInsightsInstanceConfig) ProtoMessage()

func (*Instance_QueryInsightsInstanceConfig) ProtoReflect

func (*Instance_QueryInsightsInstanceConfig) Reset

func (*Instance_QueryInsightsInstanceConfig) String

type Instance_ReadPoolConfig

type Instance_ReadPoolConfig struct {

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

Configuration for a read pool instance.

func (*Instance_ReadPoolConfig) Descriptor deprecated

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

Deprecated: Use Instance_ReadPoolConfig.ProtoReflect.Descriptor instead.

func (*Instance_ReadPoolConfig) GetNodeCount

func (x *Instance_ReadPoolConfig) GetNodeCount() int32

func (*Instance_ReadPoolConfig) ProtoMessage

func (*Instance_ReadPoolConfig) ProtoMessage()

func (*Instance_ReadPoolConfig) ProtoReflect

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

func (*Instance_ReadPoolConfig) Reset

func (x *Instance_ReadPoolConfig) Reset()

func (*Instance_ReadPoolConfig) String

func (x *Instance_ReadPoolConfig) String() string

type Instance_State

type Instance_State int32

Instance State

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

func (Instance_State) Descriptor

func (Instance_State) Enum

func (x Instance_State) Enum() *Instance_State

func (Instance_State) EnumDescriptor deprecated

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

Deprecated: Use Instance_State.Descriptor instead.

func (Instance_State) Number

func (Instance_State) String

func (x Instance_State) String() string

func (Instance_State) Type

type Instance_UpdatePolicy added in v1.2.0

type Instance_UpdatePolicy struct {

	// Mode for updating the instance.
	Mode Instance_UpdatePolicy_Mode `protobuf:"varint,1,opt,name=mode,proto3,enum=google.cloud.alloydb.v1beta.Instance_UpdatePolicy_Mode" json:"mode,omitempty"`
	// contains filtered or unexported fields
}

Policy to be used while updating the instance.

func (*Instance_UpdatePolicy) Descriptor deprecated added in v1.2.0

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

Deprecated: Use Instance_UpdatePolicy.ProtoReflect.Descriptor instead.

func (*Instance_UpdatePolicy) GetMode added in v1.2.0

func (*Instance_UpdatePolicy) ProtoMessage added in v1.2.0

func (*Instance_UpdatePolicy) ProtoMessage()

func (*Instance_UpdatePolicy) ProtoReflect added in v1.2.0

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

func (*Instance_UpdatePolicy) Reset added in v1.2.0

func (x *Instance_UpdatePolicy) Reset()

func (*Instance_UpdatePolicy) String added in v1.2.0

func (x *Instance_UpdatePolicy) String() string

type Instance_UpdatePolicy_Mode added in v1.2.0

type Instance_UpdatePolicy_Mode int32

Specifies the available modes of update.

const (
	// Mode is unknown.
	Instance_UpdatePolicy_MODE_UNSPECIFIED Instance_UpdatePolicy_Mode = 0
	// Least disruptive way to apply the update.
	Instance_UpdatePolicy_DEFAULT Instance_UpdatePolicy_Mode = 1
	// Performs a forced update when applicable. This will be fast but may
	// incur a downtime.
	Instance_UpdatePolicy_FORCE_APPLY Instance_UpdatePolicy_Mode = 2
)

func (Instance_UpdatePolicy_Mode) Descriptor added in v1.2.0

func (Instance_UpdatePolicy_Mode) Enum added in v1.2.0

func (Instance_UpdatePolicy_Mode) EnumDescriptor deprecated added in v1.2.0

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

Deprecated: Use Instance_UpdatePolicy_Mode.Descriptor instead.

func (Instance_UpdatePolicy_Mode) Number added in v1.2.0

func (Instance_UpdatePolicy_Mode) String added in v1.2.0

func (Instance_UpdatePolicy_Mode) Type added in v1.2.0

type ListBackupsRequest

type ListBackupsRequest struct {

	// Required. Parent value for ListBackupsRequest
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Requested page size. Server may return fewer items than requested.
	// If unspecified, server will pick an appropriate default.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A token identifying a page of results the server should return.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Filtering results
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// Hint for how to order the results
	OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// contains filtered or unexported fields
}

Message for requesting list of Backups

func (*ListBackupsRequest) Descriptor deprecated

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

Deprecated: Use ListBackupsRequest.ProtoReflect.Descriptor instead.

func (*ListBackupsRequest) GetFilter

func (x *ListBackupsRequest) GetFilter() string

func (*ListBackupsRequest) GetOrderBy

func (x *ListBackupsRequest) GetOrderBy() string

func (*ListBackupsRequest) GetPageSize

func (x *ListBackupsRequest) GetPageSize() int32

func (*ListBackupsRequest) GetPageToken

func (x *ListBackupsRequest) GetPageToken() string

func (*ListBackupsRequest) GetParent

func (x *ListBackupsRequest) GetParent() string

func (*ListBackupsRequest) ProtoMessage

func (*ListBackupsRequest) ProtoMessage()

func (*ListBackupsRequest) ProtoReflect

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

func (*ListBackupsRequest) Reset

func (x *ListBackupsRequest) Reset()

func (*ListBackupsRequest) String

func (x *ListBackupsRequest) String() string

type ListBackupsResponse

type ListBackupsResponse struct {

	// The list of Backup
	Backups []*Backup `protobuf:"bytes,1,rep,name=backups,proto3" json:"backups,omitempty"`
	// A token identifying a page of results the server should return.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// Locations that could not be reached.
	Unreachable []string `protobuf:"bytes,3,rep,name=unreachable,proto3" json:"unreachable,omitempty"`
	// contains filtered or unexported fields
}

Message for response to listing Backups

func (*ListBackupsResponse) Descriptor deprecated

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

Deprecated: Use ListBackupsResponse.ProtoReflect.Descriptor instead.

func (*ListBackupsResponse) GetBackups

func (x *ListBackupsResponse) GetBackups() []*Backup

func (*ListBackupsResponse) GetNextPageToken

func (x *ListBackupsResponse) GetNextPageToken() string

func (*ListBackupsResponse) GetUnreachable

func (x *ListBackupsResponse) GetUnreachable() []string

func (*ListBackupsResponse) ProtoMessage

func (*ListBackupsResponse) ProtoMessage()

func (*ListBackupsResponse) ProtoReflect

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

func (*ListBackupsResponse) Reset

func (x *ListBackupsResponse) Reset()

func (*ListBackupsResponse) String

func (x *ListBackupsResponse) String() string

type ListClustersRequest

type ListClustersRequest struct {

	// Required. The name of the parent resource. For the required format, see the
	// comment on the Cluster.name field. Additionally, you can perform an
	// aggregated list operation by specifying a value with the following format:
	//   - projects/{project}/locations/-
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. Requested page size. Server may return fewer items than
	// requested. If unspecified, server will pick an appropriate default.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A token identifying a page of results the server should return.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Optional. Filtering results
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// Optional. Hint for how to order the results
	OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// contains filtered or unexported fields
}

Message for requesting list of Clusters

func (*ListClustersRequest) Descriptor deprecated

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

Deprecated: Use ListClustersRequest.ProtoReflect.Descriptor instead.

func (*ListClustersRequest) GetFilter

func (x *ListClustersRequest) GetFilter() string

func (*ListClustersRequest) GetOrderBy

func (x *ListClustersRequest) GetOrderBy() string

func (*ListClustersRequest) GetPageSize

func (x *ListClustersRequest) GetPageSize() int32

func (*ListClustersRequest) GetPageToken

func (x *ListClustersRequest) GetPageToken() string

func (*ListClustersRequest) GetParent

func (x *ListClustersRequest) GetParent() string

func (*ListClustersRequest) ProtoMessage

func (*ListClustersRequest) ProtoMessage()

func (*ListClustersRequest) ProtoReflect

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

func (*ListClustersRequest) Reset

func (x *ListClustersRequest) Reset()

func (*ListClustersRequest) String

func (x *ListClustersRequest) String() string

type ListClustersResponse

type ListClustersResponse struct {

	// The list of Cluster
	Clusters []*Cluster `protobuf:"bytes,1,rep,name=clusters,proto3" json:"clusters,omitempty"`
	// A token identifying a page of results the server should return.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// Locations that could not be reached.
	Unreachable []string `protobuf:"bytes,3,rep,name=unreachable,proto3" json:"unreachable,omitempty"`
	// contains filtered or unexported fields
}

Message for response to listing Clusters

func (*ListClustersResponse) Descriptor deprecated

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

Deprecated: Use ListClustersResponse.ProtoReflect.Descriptor instead.

func (*ListClustersResponse) GetClusters

func (x *ListClustersResponse) GetClusters() []*Cluster

func (*ListClustersResponse) GetNextPageToken

func (x *ListClustersResponse) GetNextPageToken() string

func (*ListClustersResponse) GetUnreachable

func (x *ListClustersResponse) GetUnreachable() []string

func (*ListClustersResponse) ProtoMessage

func (*ListClustersResponse) ProtoMessage()

func (*ListClustersResponse) ProtoReflect

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

func (*ListClustersResponse) Reset

func (x *ListClustersResponse) Reset()

func (*ListClustersResponse) String

func (x *ListClustersResponse) String() string

type ListDatabasesRequest added in v1.10.0

type ListDatabasesRequest struct {

	// Required. Parent value for ListDatabasesRequest.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. The maximum number of databases to return. The service may return
	// fewer than this value. If unspecified, an appropriate number of databases
	// will be returned. The max value will be 2000, values above max will be
	// coerced to max.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. A page token, received from a previous `ListDatabases` call.
	// This should be provided to retrieve the subsequent page.
	// This field is currently not supported, its value will be ignored if passed.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Optional. Filtering results.
	// This field is currently not supported, its value will be ignored if passed.
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// contains filtered or unexported fields
}

Message for requesting list of Databases.

func (*ListDatabasesRequest) Descriptor deprecated added in v1.10.0

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

Deprecated: Use ListDatabasesRequest.ProtoReflect.Descriptor instead.

func (*ListDatabasesRequest) GetFilter added in v1.10.0

func (x *ListDatabasesRequest) GetFilter() string

func (*ListDatabasesRequest) GetPageSize added in v1.10.0

func (x *ListDatabasesRequest) GetPageSize() int32

func (*ListDatabasesRequest) GetPageToken added in v1.10.0

func (x *ListDatabasesRequest) GetPageToken() string

func (*ListDatabasesRequest) GetParent added in v1.10.0

func (x *ListDatabasesRequest) GetParent() string

func (*ListDatabasesRequest) ProtoMessage added in v1.10.0

func (*ListDatabasesRequest) ProtoMessage()

func (*ListDatabasesRequest) ProtoReflect added in v1.10.0

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

func (*ListDatabasesRequest) Reset added in v1.10.0

func (x *ListDatabasesRequest) Reset()

func (*ListDatabasesRequest) String added in v1.10.0

func (x *ListDatabasesRequest) String() string

type ListDatabasesResponse added in v1.10.0

type ListDatabasesResponse struct {

	// The list of databases
	Databases []*Database `protobuf:"bytes,1,rep,name=databases,proto3" json:"databases,omitempty"`
	// A token identifying the next page of results the server should return.
	// If this field is omitted, there are no subsequent pages.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Message for response to listing Databases.

func (*ListDatabasesResponse) Descriptor deprecated added in v1.10.0

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

Deprecated: Use ListDatabasesResponse.ProtoReflect.Descriptor instead.

func (*ListDatabasesResponse) GetDatabases added in v1.10.0

func (x *ListDatabasesResponse) GetDatabases() []*Database

func (*ListDatabasesResponse) GetNextPageToken added in v1.10.0

func (x *ListDatabasesResponse) GetNextPageToken() string

func (*ListDatabasesResponse) ProtoMessage added in v1.10.0

func (*ListDatabasesResponse) ProtoMessage()

func (*ListDatabasesResponse) ProtoReflect added in v1.10.0

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

func (*ListDatabasesResponse) Reset added in v1.10.0

func (x *ListDatabasesResponse) Reset()

func (*ListDatabasesResponse) String added in v1.10.0

func (x *ListDatabasesResponse) String() string

type ListInstancesRequest

type ListInstancesRequest struct {

	// Required. The name of the parent resource. For the required format, see the
	// comment on the Instance.name field. Additionally, you can perform an
	// aggregated list operation by specifying a value with one of the following
	// formats:
	//   - projects/{project}/locations/-/clusters/-
	//   - projects/{project}/locations/{region}/clusters/-
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. Requested page size. Server may return fewer items than
	// requested. If unspecified, server will pick an appropriate default.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A token identifying a page of results the server should return.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Optional. Filtering results
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// Optional. Hint for how to order the results
	OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// contains filtered or unexported fields
}

Message for requesting list of Instances

func (*ListInstancesRequest) Descriptor deprecated

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

Deprecated: Use ListInstancesRequest.ProtoReflect.Descriptor instead.

func (*ListInstancesRequest) GetFilter

func (x *ListInstancesRequest) GetFilter() string

func (*ListInstancesRequest) GetOrderBy

func (x *ListInstancesRequest) GetOrderBy() string

func (*ListInstancesRequest) GetPageSize

func (x *ListInstancesRequest) GetPageSize() int32

func (*ListInstancesRequest) GetPageToken

func (x *ListInstancesRequest) GetPageToken() string

func (*ListInstancesRequest) GetParent

func (x *ListInstancesRequest) GetParent() string

func (*ListInstancesRequest) ProtoMessage

func (*ListInstancesRequest) ProtoMessage()

func (*ListInstancesRequest) ProtoReflect

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

func (*ListInstancesRequest) Reset

func (x *ListInstancesRequest) Reset()

func (*ListInstancesRequest) String

func (x *ListInstancesRequest) String() string

type ListInstancesResponse

type ListInstancesResponse struct {

	// The list of Instance
	Instances []*Instance `protobuf:"bytes,1,rep,name=instances,proto3" json:"instances,omitempty"`
	// A token identifying a page of results the server should return.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// Locations that could not be reached.
	Unreachable []string `protobuf:"bytes,3,rep,name=unreachable,proto3" json:"unreachable,omitempty"`
	// contains filtered or unexported fields
}

Message for response to listing Instances

func (*ListInstancesResponse) Descriptor deprecated

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

Deprecated: Use ListInstancesResponse.ProtoReflect.Descriptor instead.

func (*ListInstancesResponse) GetInstances

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

func (*ListInstancesResponse) GetNextPageToken

func (x *ListInstancesResponse) GetNextPageToken() string

func (*ListInstancesResponse) GetUnreachable

func (x *ListInstancesResponse) GetUnreachable() []string

func (*ListInstancesResponse) ProtoMessage

func (*ListInstancesResponse) ProtoMessage()

func (*ListInstancesResponse) ProtoReflect

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

func (*ListInstancesResponse) Reset

func (x *ListInstancesResponse) Reset()

func (*ListInstancesResponse) String

func (x *ListInstancesResponse) String() string

type ListSupportedDatabaseFlagsRequest

type ListSupportedDatabaseFlagsRequest struct {

	// Required. The name of the parent resource. The required format is:
	//   - projects/{project}/locations/{location}
	//
	// Regardless of the parent specified here, as long it is contains a valid
	// project and location, the service will return a static list of supported
	// flags resources. Note that we do not yet support region-specific
	// flags.
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Requested page size. Server may return fewer items than requested.
	// If unspecified, server will pick an appropriate default.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// A token identifying a page of results the server should return.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

Message for listing the information about the supported Database flags.

func (*ListSupportedDatabaseFlagsRequest) Descriptor deprecated

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

Deprecated: Use ListSupportedDatabaseFlagsRequest.ProtoReflect.Descriptor instead.

func (*ListSupportedDatabaseFlagsRequest) GetPageSize

func (x *ListSupportedDatabaseFlagsRequest) GetPageSize() int32

func (*ListSupportedDatabaseFlagsRequest) GetPageToken

func (x *ListSupportedDatabaseFlagsRequest) GetPageToken() string

func (*ListSupportedDatabaseFlagsRequest) GetParent

func (*ListSupportedDatabaseFlagsRequest) ProtoMessage

func (*ListSupportedDatabaseFlagsRequest) ProtoMessage()

func (*ListSupportedDatabaseFlagsRequest) ProtoReflect

func (*ListSupportedDatabaseFlagsRequest) Reset

func (*ListSupportedDatabaseFlagsRequest) String

type ListSupportedDatabaseFlagsResponse

type ListSupportedDatabaseFlagsResponse struct {

	// The list of SupportedDatabaseFlags.
	SupportedDatabaseFlags []*SupportedDatabaseFlag `` /* 129-byte string literal not displayed */
	// A token identifying a page of results the server should return.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

Message for response to listing SupportedDatabaseFlags.

func (*ListSupportedDatabaseFlagsResponse) Descriptor deprecated

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

Deprecated: Use ListSupportedDatabaseFlagsResponse.ProtoReflect.Descriptor instead.

func (*ListSupportedDatabaseFlagsResponse) GetNextPageToken

func (x *ListSupportedDatabaseFlagsResponse) GetNextPageToken() string

func (*ListSupportedDatabaseFlagsResponse) GetSupportedDatabaseFlags

func (x *ListSupportedDatabaseFlagsResponse) GetSupportedDatabaseFlags() []*SupportedDatabaseFlag

func (*ListSupportedDatabaseFlagsResponse) ProtoMessage

func (*ListSupportedDatabaseFlagsResponse) ProtoMessage()

func (*ListSupportedDatabaseFlagsResponse) ProtoReflect

func (*ListSupportedDatabaseFlagsResponse) Reset

func (*ListSupportedDatabaseFlagsResponse) String

type ListUsersRequest added in v1.2.0

type ListUsersRequest struct {

	// Required. Parent value for ListUsersRequest
	Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
	// Optional. Requested page size. Server may return fewer items than
	// requested. If unspecified, server will pick an appropriate default.
	PageSize int32 `protobuf:"varint,2,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Optional. A token identifying a page of results the server should return.
	PageToken string `protobuf:"bytes,3,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// Optional. Filtering results
	Filter string `protobuf:"bytes,4,opt,name=filter,proto3" json:"filter,omitempty"`
	// Optional. Hint for how to order the results
	OrderBy string `protobuf:"bytes,5,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	// contains filtered or unexported fields
}

Message for requesting list of Users

func (*ListUsersRequest) Descriptor deprecated added in v1.2.0

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

Deprecated: Use ListUsersRequest.ProtoReflect.Descriptor instead.

func (*ListUsersRequest) GetFilter added in v1.2.0

func (x *ListUsersRequest) GetFilter() string

func (*ListUsersRequest) GetOrderBy added in v1.2.0

func (x *ListUsersRequest) GetOrderBy() string

func (*ListUsersRequest) GetPageSize added in v1.2.0

func (x *ListUsersRequest) GetPageSize() int32

func (*ListUsersRequest) GetPageToken added in v1.2.0

func (x *ListUsersRequest) GetPageToken() string

func (*ListUsersRequest) GetParent added in v1.2.0

func (x *ListUsersRequest) GetParent() string

func (*ListUsersRequest) ProtoMessage added in v1.2.0

func (*ListUsersRequest) ProtoMessage()

func (*ListUsersRequest) ProtoReflect added in v1.2.0

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

func (*ListUsersRequest) Reset added in v1.2.0

func (x *ListUsersRequest) Reset()

func (*ListUsersRequest) String added in v1.2.0

func (x *ListUsersRequest) String() string

type ListUsersResponse added in v1.2.0

type ListUsersResponse struct {

	// The list of User
	Users []*User `protobuf:"bytes,1,rep,name=users,proto3" json:"users,omitempty"`
	// A token identifying a page of results the server should return.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// Locations that could not be reached.
	Unreachable []string `protobuf:"bytes,3,rep,name=unreachable,proto3" json:"unreachable,omitempty"`
	// contains filtered or unexported fields
}

Message for response to listing Users

func (*ListUsersResponse) Descriptor deprecated added in v1.2.0

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

Deprecated: Use ListUsersResponse.ProtoReflect.Descriptor instead.

func (*ListUsersResponse) GetNextPageToken added in v1.2.0

func (x *ListUsersResponse) GetNextPageToken() string

func (*ListUsersResponse) GetUnreachable added in v1.2.0

func (x *ListUsersResponse) GetUnreachable() []string

func (*ListUsersResponse) GetUsers added in v1.2.0

func (x *ListUsersResponse) GetUsers() []*User

func (*ListUsersResponse) ProtoMessage added in v1.2.0

func (*ListUsersResponse) ProtoMessage()

func (*ListUsersResponse) ProtoReflect added in v1.2.0

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

func (*ListUsersResponse) Reset added in v1.2.0

func (x *ListUsersResponse) Reset()

func (*ListUsersResponse) String added in v1.2.0

func (x *ListUsersResponse) String() string

type MigrationSource

type MigrationSource struct {

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

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

func (*MigrationSource) Descriptor deprecated

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

Deprecated: Use MigrationSource.ProtoReflect.Descriptor instead.

func (*MigrationSource) GetHostPort

func (x *MigrationSource) GetHostPort() string

func (*MigrationSource) GetReferenceId

func (x *MigrationSource) GetReferenceId() string

func (*MigrationSource) GetSourceType

func (*MigrationSource) ProtoMessage

func (*MigrationSource) ProtoMessage()

func (*MigrationSource) ProtoReflect

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

func (*MigrationSource) Reset

func (x *MigrationSource) Reset()

func (*MigrationSource) String

func (x *MigrationSource) String() string

type MigrationSource_MigrationSourceType

type MigrationSource_MigrationSourceType int32

Denote the type of migration source that created this cluster.

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

func (MigrationSource_MigrationSourceType) Descriptor

func (MigrationSource_MigrationSourceType) Enum

func (MigrationSource_MigrationSourceType) EnumDescriptor deprecated

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

Deprecated: Use MigrationSource_MigrationSourceType.Descriptor instead.

func (MigrationSource_MigrationSourceType) Number

func (MigrationSource_MigrationSourceType) String

func (MigrationSource_MigrationSourceType) Type

type OperationMetadata

type OperationMetadata struct {

	// Request specific metadata, if any.
	//
	// Types that are assignable to RequestSpecific:
	//
	//	*OperationMetadata_BatchCreateInstancesMetadata
	RequestSpecific isOperationMetadata_RequestSpecific `protobuf_oneof:"request_specific"`
	// Output only. The time the operation was created.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// Output only. The time the operation finished running.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// Output only. Server-defined resource path for the target of the operation.
	Target string `protobuf:"bytes,3,opt,name=target,proto3" json:"target,omitempty"`
	// Output only. Name of the verb executed by the operation.
	Verb string `protobuf:"bytes,4,opt,name=verb,proto3" json:"verb,omitempty"`
	// Output only. Human-readable status of the operation, if any.
	StatusMessage string `protobuf:"bytes,5,opt,name=status_message,json=statusMessage,proto3" json:"status_message,omitempty"`
	// Output only. Identifies whether the user has requested cancellation
	// of the operation. Operations that have successfully been cancelled
	// have [Operation.error][] value with a
	// [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to
	// `Code.CANCELLED`.
	RequestedCancellation bool `protobuf:"varint,6,opt,name=requested_cancellation,json=requestedCancellation,proto3" json:"requested_cancellation,omitempty"`
	// Output only. API version used to start the operation.
	ApiVersion string `protobuf:"bytes,7,opt,name=api_version,json=apiVersion,proto3" json:"api_version,omitempty"`
	// contains filtered or unexported fields
}

Represents the metadata of the long-running operation.

func (*OperationMetadata) Descriptor deprecated

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

Deprecated: Use OperationMetadata.ProtoReflect.Descriptor instead.

func (*OperationMetadata) GetApiVersion

func (x *OperationMetadata) GetApiVersion() string

func (*OperationMetadata) GetBatchCreateInstancesMetadata

func (x *OperationMetadata) GetBatchCreateInstancesMetadata() *BatchCreateInstancesMetadata

func (*OperationMetadata) GetCreateTime

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

func (*OperationMetadata) GetEndTime

func (x *OperationMetadata) GetEndTime() *timestamppb.Timestamp

func (*OperationMetadata) GetRequestSpecific

func (m *OperationMetadata) GetRequestSpecific() isOperationMetadata_RequestSpecific

func (*OperationMetadata) GetRequestedCancellation

func (x *OperationMetadata) GetRequestedCancellation() bool

func (*OperationMetadata) GetStatusMessage

func (x *OperationMetadata) GetStatusMessage() string

func (*OperationMetadata) GetTarget

func (x *OperationMetadata) GetTarget() string

func (*OperationMetadata) GetVerb

func (x *OperationMetadata) GetVerb() string

func (*OperationMetadata) ProtoMessage

func (*OperationMetadata) ProtoMessage()

func (*OperationMetadata) ProtoReflect

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

func (*OperationMetadata) Reset

func (x *OperationMetadata) Reset()

func (*OperationMetadata) String

func (x *OperationMetadata) String() string

type OperationMetadata_BatchCreateInstancesMetadata

type OperationMetadata_BatchCreateInstancesMetadata struct {
	// Output only. BatchCreateInstances related metadata.
	BatchCreateInstancesMetadata *BatchCreateInstancesMetadata `protobuf:"bytes,8,opt,name=batch_create_instances_metadata,json=batchCreateInstancesMetadata,proto3,oneof"`
}

type PromoteClusterRequest

type PromoteClusterRequest 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"`
	// contains filtered or unexported fields
}

Message for promoting a Cluster

func (*PromoteClusterRequest) Descriptor deprecated

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

Deprecated: Use PromoteClusterRequest.ProtoReflect.Descriptor instead.

func (*PromoteClusterRequest) GetEtag

func (x *PromoteClusterRequest) GetEtag() string

func (*PromoteClusterRequest) GetName

func (x *PromoteClusterRequest) GetName() string

func (*PromoteClusterRequest) GetRequestId

func (x *PromoteClusterRequest) GetRequestId() string

func (*PromoteClusterRequest) GetValidateOnly

func (x *PromoteClusterRequest) GetValidateOnly() bool

func (*PromoteClusterRequest) ProtoMessage

func (*PromoteClusterRequest) ProtoMessage()

func (*PromoteClusterRequest) ProtoReflect

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

func (*PromoteClusterRequest) Reset

func (x *PromoteClusterRequest) Reset()

func (*PromoteClusterRequest) String

func (x *PromoteClusterRequest) String() string

type RestartInstanceRequest

type RestartInstanceRequest 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 restart.
	ValidateOnly bool `protobuf:"varint,3,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
	// contains filtered or unexported fields
}

func (*RestartInstanceRequest) Descriptor deprecated

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

Deprecated: Use RestartInstanceRequest.ProtoReflect.Descriptor instead.

func (*RestartInstanceRequest) GetName

func (x *RestartInstanceRequest) GetName() string

func (*RestartInstanceRequest) GetRequestId

func (x *RestartInstanceRequest) GetRequestId() string

func (*RestartInstanceRequest) GetValidateOnly

func (x *RestartInstanceRequest) GetValidateOnly() bool

func (*RestartInstanceRequest) ProtoMessage

func (*RestartInstanceRequest) ProtoMessage()

func (*RestartInstanceRequest) ProtoReflect

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

func (*RestartInstanceRequest) Reset

func (x *RestartInstanceRequest) Reset()

func (*RestartInstanceRequest) String

func (x *RestartInstanceRequest) String() string

type RestoreClusterRequest

type RestoreClusterRequest struct {

	// Required.
	// The source to import from.
	//
	// Types that are assignable to Source:
	//
	//	*RestoreClusterRequest_BackupSource
	//	*RestoreClusterRequest_ContinuousBackupSource
	Source isRestoreClusterRequest_Source `protobuf_oneof:"source"`
	// 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,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 import
	// request.
	ValidateOnly bool `protobuf:"varint,6,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
	// contains filtered or unexported fields
}

Message for restoring a Cluster from a backup or another cluster at a given point in time.

func (*RestoreClusterRequest) Descriptor deprecated

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

Deprecated: Use RestoreClusterRequest.ProtoReflect.Descriptor instead.

func (*RestoreClusterRequest) GetBackupSource

func (x *RestoreClusterRequest) GetBackupSource() *BackupSource

func (*RestoreClusterRequest) GetCluster

func (x *RestoreClusterRequest) GetCluster() *Cluster

func (*RestoreClusterRequest) GetClusterId

func (x *RestoreClusterRequest) GetClusterId() string

func (*RestoreClusterRequest) GetContinuousBackupSource

func (x *RestoreClusterRequest) GetContinuousBackupSource() *ContinuousBackupSource

func (*RestoreClusterRequest) GetParent

func (x *RestoreClusterRequest) GetParent() string

func (*RestoreClusterRequest) GetRequestId

func (x *RestoreClusterRequest) GetRequestId() string

func (*RestoreClusterRequest) GetSource

func (m *RestoreClusterRequest) GetSource() isRestoreClusterRequest_Source

func (*RestoreClusterRequest) GetValidateOnly

func (x *RestoreClusterRequest) GetValidateOnly() bool

func (*RestoreClusterRequest) ProtoMessage

func (*RestoreClusterRequest) ProtoMessage()

func (*RestoreClusterRequest) ProtoReflect

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

func (*RestoreClusterRequest) Reset

func (x *RestoreClusterRequest) Reset()

func (*RestoreClusterRequest) String

func (x *RestoreClusterRequest) String() string

type RestoreClusterRequest_BackupSource

type RestoreClusterRequest_BackupSource struct {
	// Backup source.
	BackupSource *BackupSource `protobuf:"bytes,4,opt,name=backup_source,json=backupSource,proto3,oneof"`
}

type RestoreClusterRequest_ContinuousBackupSource

type RestoreClusterRequest_ContinuousBackupSource struct {
	// ContinuousBackup source. Continuous backup needs to be enabled in the
	// source cluster for this operation to succeed.
	ContinuousBackupSource *ContinuousBackupSource `protobuf:"bytes,8,opt,name=continuous_backup_source,json=continuousBackupSource,proto3,oneof"`
}

type SslConfig

type SslConfig struct {

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

SSL configuration.

func (*SslConfig) Descriptor deprecated

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

Deprecated: Use SslConfig.ProtoReflect.Descriptor instead.

func (*SslConfig) GetCaSource

func (x *SslConfig) GetCaSource() SslConfig_CaSource

func (*SslConfig) GetSslMode

func (x *SslConfig) GetSslMode() SslConfig_SslMode

func (*SslConfig) ProtoMessage

func (*SslConfig) ProtoMessage()

func (*SslConfig) ProtoReflect

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

func (*SslConfig) Reset

func (x *SslConfig) Reset()

func (*SslConfig) String

func (x *SslConfig) String() string

type SslConfig_CaSource

type SslConfig_CaSource int32

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

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

func (SslConfig_CaSource) Descriptor

func (SslConfig_CaSource) Enum

func (SslConfig_CaSource) EnumDescriptor deprecated

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

Deprecated: Use SslConfig_CaSource.Descriptor instead.

func (SslConfig_CaSource) Number

func (SslConfig_CaSource) String

func (x SslConfig_CaSource) String() string

func (SslConfig_CaSource) Type

type SslConfig_SslMode

type SslConfig_SslMode int32

SSL mode options.

const (
	// SSL mode not specified. Defaults to ENCRYPTED_ONLY.
	SslConfig_SSL_MODE_UNSPECIFIED SslConfig_SslMode = 0
	// SSL connections are optional. CA verification not enforced.
	//
	// Deprecated: Marked as deprecated in google/cloud/alloydb/v1beta/resources.proto.
	SslConfig_SSL_MODE_ALLOW SslConfig_SslMode = 1
	// SSL connections are required. CA verification not enforced.
	// Clients may use locally self-signed certificates (default psql client
	// behavior).
	//
	// Deprecated: Marked as deprecated in google/cloud/alloydb/v1beta/resources.proto.
	SslConfig_SSL_MODE_REQUIRE SslConfig_SslMode = 2
	// SSL connections are required. CA verification enforced.
	// Clients must have certificates signed by a Cluster CA, e.g. via
	// GenerateClientCertificate.
	//
	// Deprecated: Marked as deprecated in google/cloud/alloydb/v1beta/resources.proto.
	SslConfig_SSL_MODE_VERIFY_CA SslConfig_SslMode = 3
	// SSL connections are optional. CA verification not enforced.
	SslConfig_ALLOW_UNENCRYPTED_AND_ENCRYPTED SslConfig_SslMode = 4
	// SSL connections are required. CA verification not enforced.
	SslConfig_ENCRYPTED_ONLY SslConfig_SslMode = 5
)

func (SslConfig_SslMode) Descriptor

func (SslConfig_SslMode) Enum

func (SslConfig_SslMode) EnumDescriptor deprecated

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

Deprecated: Use SslConfig_SslMode.Descriptor instead.

func (SslConfig_SslMode) Number

func (SslConfig_SslMode) String

func (x SslConfig_SslMode) String() string

func (SslConfig_SslMode) Type

type SupportedDatabaseFlag

type SupportedDatabaseFlag struct {

	// The restrictions on the flag value per type.
	//
	// Types that are assignable to Restrictions:
	//
	//	*SupportedDatabaseFlag_StringRestrictions_
	//	*SupportedDatabaseFlag_IntegerRestrictions_
	Restrictions isSupportedDatabaseFlag_Restrictions `protobuf_oneof:"restrictions"`
	// The name of the flag resource, following Google Cloud conventions, e.g.:
	//   - projects/{project}/locations/{location}/flags/{flag}
	//
	// This field currently has no semantic meaning.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The name of the database flag, e.g. "max_allowed_packets".
	// The is a possibly key for the Instance.database_flags map field.
	FlagName  string                          `protobuf:"bytes,2,opt,name=flag_name,json=flagName,proto3" json:"flag_name,omitempty"`
	ValueType SupportedDatabaseFlag_ValueType `` /* 154-byte string literal not displayed */
	// Whether the database flag accepts multiple values. If true,
	// a comma-separated list of stringified values may be specified.
	AcceptsMultipleValues bool `` /* 127-byte string literal not displayed */
	// Major database engine versions for which this flag is supported.
	SupportedDbVersions []DatabaseVersion `` /* 177-byte string literal not displayed */
	// Whether setting or updating this flag on an Instance requires a database
	// restart. If a flag that requires database restart is set, the backend
	// will automatically restart the database (making sure to satisfy any
	// availability SLO's).
	RequiresDbRestart bool `protobuf:"varint,6,opt,name=requires_db_restart,json=requiresDbRestart,proto3" json:"requires_db_restart,omitempty"`
	// contains filtered or unexported fields
}

SupportedDatabaseFlag gives general information about a database flag, like type and allowed values. This is a static value that is defined on the server side, and it cannot be modified by callers. To set the Database flags on a particular Instance, a caller should modify the Instance.database_flags field.

func (*SupportedDatabaseFlag) Descriptor deprecated

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

Deprecated: Use SupportedDatabaseFlag.ProtoReflect.Descriptor instead.

func (*SupportedDatabaseFlag) GetAcceptsMultipleValues

func (x *SupportedDatabaseFlag) GetAcceptsMultipleValues() bool

func (*SupportedDatabaseFlag) GetFlagName

func (x *SupportedDatabaseFlag) GetFlagName() string

func (*SupportedDatabaseFlag) GetIntegerRestrictions

func (*SupportedDatabaseFlag) GetName

func (x *SupportedDatabaseFlag) GetName() string

func (*SupportedDatabaseFlag) GetRequiresDbRestart

func (x *SupportedDatabaseFlag) GetRequiresDbRestart() bool

func (*SupportedDatabaseFlag) GetRestrictions

func (m *SupportedDatabaseFlag) GetRestrictions() isSupportedDatabaseFlag_Restrictions

func (*SupportedDatabaseFlag) GetStringRestrictions

func (*SupportedDatabaseFlag) GetSupportedDbVersions

func (x *SupportedDatabaseFlag) GetSupportedDbVersions() []DatabaseVersion

func (*SupportedDatabaseFlag) GetValueType

func (*SupportedDatabaseFlag) ProtoMessage

func (*SupportedDatabaseFlag) ProtoMessage()

func (*SupportedDatabaseFlag) ProtoReflect

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

func (*SupportedDatabaseFlag) Reset

func (x *SupportedDatabaseFlag) Reset()

func (*SupportedDatabaseFlag) String

func (x *SupportedDatabaseFlag) String() string

type SupportedDatabaseFlag_IntegerRestrictions

type SupportedDatabaseFlag_IntegerRestrictions struct {

	// The minimum value that can be specified, if applicable.
	MinValue *wrapperspb.Int64Value `protobuf:"bytes,1,opt,name=min_value,json=minValue,proto3" json:"min_value,omitempty"`
	// The maximum value that can be specified, if applicable.
	MaxValue *wrapperspb.Int64Value `protobuf:"bytes,2,opt,name=max_value,json=maxValue,proto3" json:"max_value,omitempty"`
	// contains filtered or unexported fields
}

Restrictions on INTEGER type values.

func (*SupportedDatabaseFlag_IntegerRestrictions) Descriptor deprecated

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

Deprecated: Use SupportedDatabaseFlag_IntegerRestrictions.ProtoReflect.Descriptor instead.

func (*SupportedDatabaseFlag_IntegerRestrictions) GetMaxValue

func (*SupportedDatabaseFlag_IntegerRestrictions) GetMinValue

func (*SupportedDatabaseFlag_IntegerRestrictions) ProtoMessage

func (*SupportedDatabaseFlag_IntegerRestrictions) ProtoReflect

func (*SupportedDatabaseFlag_IntegerRestrictions) Reset

func (*SupportedDatabaseFlag_IntegerRestrictions) String

type SupportedDatabaseFlag_IntegerRestrictions_

type SupportedDatabaseFlag_IntegerRestrictions_ struct {
	// Restriction on INTEGER type value.
	IntegerRestrictions *SupportedDatabaseFlag_IntegerRestrictions `protobuf:"bytes,8,opt,name=integer_restrictions,json=integerRestrictions,proto3,oneof"`
}

type SupportedDatabaseFlag_StringRestrictions

type SupportedDatabaseFlag_StringRestrictions struct {

	// The list of allowed values, if bounded. This field will be empty
	// if there is a unbounded number of allowed values.
	AllowedValues []string `protobuf:"bytes,1,rep,name=allowed_values,json=allowedValues,proto3" json:"allowed_values,omitempty"`
	// contains filtered or unexported fields
}

Restrictions on STRING type values

func (*SupportedDatabaseFlag_StringRestrictions) Descriptor deprecated

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

Deprecated: Use SupportedDatabaseFlag_StringRestrictions.ProtoReflect.Descriptor instead.

func (*SupportedDatabaseFlag_StringRestrictions) GetAllowedValues

func (x *SupportedDatabaseFlag_StringRestrictions) GetAllowedValues() []string

func (*SupportedDatabaseFlag_StringRestrictions) ProtoMessage

func (*SupportedDatabaseFlag_StringRestrictions) ProtoReflect

func (*SupportedDatabaseFlag_StringRestrictions) Reset

func (*SupportedDatabaseFlag_StringRestrictions) String

type SupportedDatabaseFlag_StringRestrictions_

type SupportedDatabaseFlag_StringRestrictions_ struct {
	// Restriction on STRING type value.
	StringRestrictions *SupportedDatabaseFlag_StringRestrictions `protobuf:"bytes,7,opt,name=string_restrictions,json=stringRestrictions,proto3,oneof"`
}

type SupportedDatabaseFlag_ValueType

type SupportedDatabaseFlag_ValueType int32

ValueType describes the semantic type of the value that the flag accepts. Regardless of the ValueType, the Instance.database_flags field accepts the stringified version of the value, i.e. "20" or "3.14".

const (
	// This is an unknown flag type.
	SupportedDatabaseFlag_VALUE_TYPE_UNSPECIFIED SupportedDatabaseFlag_ValueType = 0
	// String type flag.
	SupportedDatabaseFlag_STRING SupportedDatabaseFlag_ValueType = 1
	// Integer type flag.
	SupportedDatabaseFlag_INTEGER SupportedDatabaseFlag_ValueType = 2
	// Float type flag.
	SupportedDatabaseFlag_FLOAT SupportedDatabaseFlag_ValueType = 3
	// Denotes that the flag does not accept any values.
	SupportedDatabaseFlag_NONE SupportedDatabaseFlag_ValueType = 4
)

func (SupportedDatabaseFlag_ValueType) Descriptor

func (SupportedDatabaseFlag_ValueType) Enum

func (SupportedDatabaseFlag_ValueType) EnumDescriptor deprecated

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

Deprecated: Use SupportedDatabaseFlag_ValueType.Descriptor instead.

func (SupportedDatabaseFlag_ValueType) Number

func (SupportedDatabaseFlag_ValueType) String

func (SupportedDatabaseFlag_ValueType) Type

type UnimplementedAlloyDBAdminServer

type UnimplementedAlloyDBAdminServer struct {
}

UnimplementedAlloyDBAdminServer can be embedded to have forward compatible implementations.

func (*UnimplementedAlloyDBAdminServer) BatchCreateInstances

func (*UnimplementedAlloyDBAdminServer) CreateBackup

func (*UnimplementedAlloyDBAdminServer) CreateCluster

func (*UnimplementedAlloyDBAdminServer) CreateInstance

func (*UnimplementedAlloyDBAdminServer) CreateSecondaryCluster

func (*UnimplementedAlloyDBAdminServer) CreateSecondaryInstance

func (*UnimplementedAlloyDBAdminServer) CreateUser added in v1.2.0

func (*UnimplementedAlloyDBAdminServer) DeleteBackup

func (*UnimplementedAlloyDBAdminServer) DeleteCluster

func (*UnimplementedAlloyDBAdminServer) DeleteInstance

func (*UnimplementedAlloyDBAdminServer) DeleteUser added in v1.2.0

func (*UnimplementedAlloyDBAdminServer) FailoverInstance

func (*UnimplementedAlloyDBAdminServer) GetBackup

func (*UnimplementedAlloyDBAdminServer) GetCluster

func (*UnimplementedAlloyDBAdminServer) GetConnectionInfo

func (*UnimplementedAlloyDBAdminServer) GetInstance

func (*UnimplementedAlloyDBAdminServer) GetUser added in v1.2.0

func (*UnimplementedAlloyDBAdminServer) InjectFault added in v1.2.0

func (*UnimplementedAlloyDBAdminServer) ListBackups

func (*UnimplementedAlloyDBAdminServer) ListClusters

func (*UnimplementedAlloyDBAdminServer) ListDatabases added in v1.10.0

func (*UnimplementedAlloyDBAdminServer) ListInstances

func (*UnimplementedAlloyDBAdminServer) ListUsers added in v1.2.0

func (*UnimplementedAlloyDBAdminServer) PromoteCluster

func (*UnimplementedAlloyDBAdminServer) RestartInstance

func (*UnimplementedAlloyDBAdminServer) RestoreCluster

func (*UnimplementedAlloyDBAdminServer) UpdateBackup

func (*UnimplementedAlloyDBAdminServer) UpdateCluster

func (*UnimplementedAlloyDBAdminServer) UpdateInstance

func (*UnimplementedAlloyDBAdminServer) UpdateUser added in v1.2.0

type UpdateBackupRequest

type UpdateBackupRequest struct {

	// Optional. Field mask is used to specify the fields to be overwritten in the
	// Backup resource by the update.
	// The fields specified in the update_mask are relative to the resource, not
	// the full request. A field will be overwritten if it is in the mask. If the
	// user does not provide a mask then all fields will be overwritten.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,1,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// Required. The resource being updated
	Backup *Backup `protobuf:"bytes,2,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,3,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,4,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
	// Optional. If set to true, update succeeds even if instance is not found. In
	// that case, a new backup is created and `update_mask` is ignored.
	AllowMissing bool `protobuf:"varint,5,opt,name=allow_missing,json=allowMissing,proto3" json:"allow_missing,omitempty"`
	// contains filtered or unexported fields
}

Message for updating a Backup

func (*UpdateBackupRequest) Descriptor deprecated

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

Deprecated: Use UpdateBackupRequest.ProtoReflect.Descriptor instead.

func (*UpdateBackupRequest) GetAllowMissing

func (x *UpdateBackupRequest) GetAllowMissing() bool

func (*UpdateBackupRequest) GetBackup

func (x *UpdateBackupRequest) GetBackup() *Backup

func (*UpdateBackupRequest) GetRequestId

func (x *UpdateBackupRequest) GetRequestId() string

func (*UpdateBackupRequest) GetUpdateMask

func (x *UpdateBackupRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateBackupRequest) GetValidateOnly

func (x *UpdateBackupRequest) GetValidateOnly() bool

func (*UpdateBackupRequest) ProtoMessage

func (*UpdateBackupRequest) ProtoMessage()

func (*UpdateBackupRequest) ProtoReflect

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

func (*UpdateBackupRequest) Reset

func (x *UpdateBackupRequest) Reset()

func (*UpdateBackupRequest) String

func (x *UpdateBackupRequest) String() string

type UpdateClusterRequest

type UpdateClusterRequest struct {

	// Optional. Field mask is used to specify the fields to be overwritten in the
	// Cluster resource by the update.
	// The fields specified in the update_mask are relative to the resource, not
	// the full request. A field will be overwritten if it is in the mask. If the
	// user does not provide a mask then all fields will be overwritten.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,1,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// Required. The resource being updated
	Cluster *Cluster `protobuf:"bytes,2,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,3,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 update
	// request.
	ValidateOnly bool `protobuf:"varint,4,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
	// Optional. If set to true, update succeeds even if cluster is not found. In
	// that case, a new cluster is created and `update_mask` is ignored.
	AllowMissing bool `protobuf:"varint,5,opt,name=allow_missing,json=allowMissing,proto3" json:"allow_missing,omitempty"`
	// contains filtered or unexported fields
}

Message for updating a Cluster

func (*UpdateClusterRequest) Descriptor deprecated

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

Deprecated: Use UpdateClusterRequest.ProtoReflect.Descriptor instead.

func (*UpdateClusterRequest) GetAllowMissing

func (x *UpdateClusterRequest) GetAllowMissing() bool

func (*UpdateClusterRequest) GetCluster

func (x *UpdateClusterRequest) GetCluster() *Cluster

func (*UpdateClusterRequest) GetRequestId

func (x *UpdateClusterRequest) GetRequestId() string

func (*UpdateClusterRequest) GetUpdateMask

func (x *UpdateClusterRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateClusterRequest) GetValidateOnly

func (x *UpdateClusterRequest) GetValidateOnly() bool

func (*UpdateClusterRequest) ProtoMessage

func (*UpdateClusterRequest) ProtoMessage()

func (*UpdateClusterRequest) ProtoReflect

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

func (*UpdateClusterRequest) Reset

func (x *UpdateClusterRequest) Reset()

func (*UpdateClusterRequest) String

func (x *UpdateClusterRequest) String() string

type UpdateInstanceRequest

type UpdateInstanceRequest struct {

	// Optional. Field mask is used to specify the fields to be overwritten in the
	// Instance resource by the update.
	// The fields specified in the update_mask are relative to the resource, not
	// the full request. A field will be overwritten if it is in the mask. If the
	// user does not provide a mask then all fields will be overwritten.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,1,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// Required. The resource being updated
	Instance *Instance `protobuf:"bytes,2,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,3,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 update
	// request.
	ValidateOnly bool `protobuf:"varint,4,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
	// Optional. If set to true, update succeeds even if instance is not found. In
	// that case, a new instance is created and `update_mask` is ignored.
	AllowMissing bool `protobuf:"varint,5,opt,name=allow_missing,json=allowMissing,proto3" json:"allow_missing,omitempty"`
	// contains filtered or unexported fields
}

Message for updating a Instance

func (*UpdateInstanceRequest) Descriptor deprecated

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

Deprecated: Use UpdateInstanceRequest.ProtoReflect.Descriptor instead.

func (*UpdateInstanceRequest) GetAllowMissing

func (x *UpdateInstanceRequest) GetAllowMissing() bool

func (*UpdateInstanceRequest) GetInstance

func (x *UpdateInstanceRequest) GetInstance() *Instance

func (*UpdateInstanceRequest) GetRequestId

func (x *UpdateInstanceRequest) GetRequestId() string

func (*UpdateInstanceRequest) GetUpdateMask

func (x *UpdateInstanceRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateInstanceRequest) GetValidateOnly

func (x *UpdateInstanceRequest) GetValidateOnly() bool

func (*UpdateInstanceRequest) ProtoMessage

func (*UpdateInstanceRequest) ProtoMessage()

func (*UpdateInstanceRequest) ProtoReflect

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

func (*UpdateInstanceRequest) Reset

func (x *UpdateInstanceRequest) Reset()

func (*UpdateInstanceRequest) String

func (x *UpdateInstanceRequest) String() string

type UpdateUserRequest added in v1.2.0

type UpdateUserRequest struct {

	// Optional. Field mask is used to specify the fields to be overwritten in the
	// User resource by the update.
	// The fields specified in the update_mask are relative to the resource, not
	// the full request. A field will be overwritten if it is in the mask. If the
	// user does not provide a mask then all fields will be overwritten.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,1,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// Required. The resource being updated
	User *User `protobuf:"bytes,2,opt,name=user,proto3" json:"user,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"`
	// Optional. If set, the backend validates the request, but doesn't actually
	// execute it.
	ValidateOnly bool `protobuf:"varint,4,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
	// Optional. Allow missing fields in the update mask.
	AllowMissing bool `protobuf:"varint,5,opt,name=allow_missing,json=allowMissing,proto3" json:"allow_missing,omitempty"`
	// contains filtered or unexported fields
}

Message for updating a User

func (*UpdateUserRequest) Descriptor deprecated added in v1.2.0

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

Deprecated: Use UpdateUserRequest.ProtoReflect.Descriptor instead.

func (*UpdateUserRequest) GetAllowMissing added in v1.2.0

func (x *UpdateUserRequest) GetAllowMissing() bool

func (*UpdateUserRequest) GetRequestId added in v1.2.0

func (x *UpdateUserRequest) GetRequestId() string

func (*UpdateUserRequest) GetUpdateMask added in v1.2.0

func (x *UpdateUserRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateUserRequest) GetUser added in v1.2.0

func (x *UpdateUserRequest) GetUser() *User

func (*UpdateUserRequest) GetValidateOnly added in v1.2.0

func (x *UpdateUserRequest) GetValidateOnly() bool

func (*UpdateUserRequest) ProtoMessage added in v1.2.0

func (*UpdateUserRequest) ProtoMessage()

func (*UpdateUserRequest) ProtoReflect added in v1.2.0

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

func (*UpdateUserRequest) Reset added in v1.2.0

func (x *UpdateUserRequest) Reset()

func (*UpdateUserRequest) String added in v1.2.0

func (x *UpdateUserRequest) String() string

type User added in v1.2.0

type User struct {

	// Output only. Name of the resource in the form of
	// projects/{project}/locations/{location}/cluster/{cluster}/users/{user}.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Input only. Password for the user.
	Password string `protobuf:"bytes,2,opt,name=password,proto3" json:"password,omitempty"`
	// Optional. List of database roles this user has.
	// The database role strings are subject to the PostgreSQL naming conventions.
	DatabaseRoles []string `protobuf:"bytes,4,rep,name=database_roles,json=databaseRoles,proto3" json:"database_roles,omitempty"`
	// Optional. Type of this user.
	UserType User_UserType `` /* 133-byte string literal not displayed */
	// contains filtered or unexported fields
}

Message describing User object.

func (*User) Descriptor deprecated added in v1.2.0

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

Deprecated: Use User.ProtoReflect.Descriptor instead.

func (*User) GetDatabaseRoles added in v1.2.0

func (x *User) GetDatabaseRoles() []string

func (*User) GetName added in v1.2.0

func (x *User) GetName() string

func (*User) GetPassword added in v1.2.0

func (x *User) GetPassword() string

func (*User) GetUserType added in v1.2.0

func (x *User) GetUserType() User_UserType

func (*User) ProtoMessage added in v1.2.0

func (*User) ProtoMessage()

func (*User) ProtoReflect added in v1.2.0

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

func (*User) Reset added in v1.2.0

func (x *User) Reset()

func (*User) String added in v1.2.0

func (x *User) String() string

type UserPassword

type UserPassword struct {

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

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

func (*UserPassword) Descriptor deprecated

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

Deprecated: Use UserPassword.ProtoReflect.Descriptor instead.

func (*UserPassword) GetPassword

func (x *UserPassword) GetPassword() string

func (*UserPassword) GetUser

func (x *UserPassword) GetUser() string

func (*UserPassword) ProtoMessage

func (*UserPassword) ProtoMessage()

func (*UserPassword) ProtoReflect

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

func (*UserPassword) Reset

func (x *UserPassword) Reset()

func (*UserPassword) String

func (x *UserPassword) String() string

type User_UserType added in v1.2.0

type User_UserType int32

Enum that details the user type.

const (
	// Unspecified user type.
	User_USER_TYPE_UNSPECIFIED User_UserType = 0
	// The default user type that authenticates via password-based
	// authentication.
	User_ALLOYDB_BUILT_IN User_UserType = 1
	// Database user that can authenticate via IAM-Based authentication.
	User_ALLOYDB_IAM_USER User_UserType = 2
)

func (User_UserType) Descriptor added in v1.2.0

func (User_UserType) Enum added in v1.2.0

func (x User_UserType) Enum() *User_UserType

func (User_UserType) EnumDescriptor deprecated added in v1.2.0

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

Deprecated: Use User_UserType.Descriptor instead.

func (User_UserType) Number added in v1.2.0

func (User_UserType) String added in v1.2.0

func (x User_UserType) String() string

func (User_UserType) Type added in v1.2.0

Jump to

Keyboard shortcuts

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