Variables
InstanceView_name, InstanceView_value
var (
InstanceView_name = map[int32]string{
0: "INSTANCE_VIEW_UNSPECIFIED",
1: "INSTANCE_VIEW_BASIC",
2: "INSTANCE_VIEW_FULL",
}
InstanceView_value = map[string]int32{
"INSTANCE_VIEW_UNSPECIFIED": 0,
"INSTANCE_VIEW_BASIC": 1,
"INSTANCE_VIEW_FULL": 2,
}
)Enum value maps for InstanceView.
ClusterView_name, ClusterView_value
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.
DatabaseVersion_name, DatabaseVersion_value
var (
DatabaseVersion_name = map[int32]string{
0: "DATABASE_VERSION_UNSPECIFIED",
1: "POSTGRES_13",
2: "POSTGRES_14",
}
DatabaseVersion_value = map[string]int32{
"DATABASE_VERSION_UNSPECIFIED": 0,
"POSTGRES_13": 1,
"POSTGRES_14": 2,
}
)Enum value maps for DatabaseVersion.
MigrationSource_MigrationSourceType_name, MigrationSource_MigrationSourceType_value
var (
MigrationSource_MigrationSourceType_name = map[int32]string{
0: "MIGRATION_SOURCE_TYPE_UNSPECIFIED",
1: "DMS",
}
MigrationSource_MigrationSourceType_value = map[string]int32{
"MIGRATION_SOURCE_TYPE_UNSPECIFIED": 0,
"DMS": 1,
}
)Enum value maps for MigrationSource_MigrationSourceType.
EncryptionInfo_Type_name, EncryptionInfo_Type_value
var (
EncryptionInfo_Type_name = map[int32]string{
0: "TYPE_UNSPECIFIED",
1: "GOOGLE_DEFAULT_ENCRYPTION",
2: "CUSTOMER_MANAGED_ENCRYPTION",
}
EncryptionInfo_Type_value = map[string]int32{
"TYPE_UNSPECIFIED": 0,
"GOOGLE_DEFAULT_ENCRYPTION": 1,
"CUSTOMER_MANAGED_ENCRYPTION": 2,
}
)Enum value maps for EncryptionInfo_Type.
SslConfig_SslMode_name, SslConfig_SslMode_value
var (
SslConfig_SslMode_name = map[int32]string{
0: "SSL_MODE_UNSPECIFIED",
1: "SSL_MODE_ALLOW",
2: "SSL_MODE_REQUIRE",
3: "SSL_MODE_VERIFY_CA",
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.
SslConfig_CaSource_name, SslConfig_CaSource_value
var (
SslConfig_CaSource_name = map[int32]string{
0: "CA_SOURCE_UNSPECIFIED",
1: "CA_SOURCE_MANAGED",
}
SslConfig_CaSource_value = map[string]int32{
"CA_SOURCE_UNSPECIFIED": 0,
"CA_SOURCE_MANAGED": 1,
}
)Enum value maps for SslConfig_CaSource.
Cluster_State_name, Cluster_State_value
var (
Cluster_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "READY",
2: "STOPPED",
3: "EMPTY",
4: "CREATING",
5: "DELETING",
6: "FAILED",
7: "BOOTSTRAPPING",
8: "MAINTENANCE",
9: "PROMOTING",
}
Cluster_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"READY": 1,
"STOPPED": 2,
"EMPTY": 3,
"CREATING": 4,
"DELETING": 5,
"FAILED": 6,
"BOOTSTRAPPING": 7,
"MAINTENANCE": 8,
"PROMOTING": 9,
}
)Enum value maps for Cluster_State.
Cluster_ClusterType_name, Cluster_ClusterType_value
var (
Cluster_ClusterType_name = map[int32]string{
0: "CLUSTER_TYPE_UNSPECIFIED",
1: "PRIMARY",
2: "SECONDARY",
}
Cluster_ClusterType_value = map[string]int32{
"CLUSTER_TYPE_UNSPECIFIED": 0,
"PRIMARY": 1,
"SECONDARY": 2,
}
)Enum value maps for Cluster_ClusterType.
Instance_State_name, Instance_State_value
var (
Instance_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "READY",
2: "STOPPED",
3: "CREATING",
4: "DELETING",
5: "MAINTENANCE",
6: "FAILED",
8: "BOOTSTRAPPING",
9: "PROMOTING",
}
Instance_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"READY": 1,
"STOPPED": 2,
"CREATING": 3,
"DELETING": 4,
"MAINTENANCE": 5,
"FAILED": 6,
"BOOTSTRAPPING": 8,
"PROMOTING": 9,
}
)Enum value maps for Instance_State.
Instance_InstanceType_name, Instance_InstanceType_value
var (
Instance_InstanceType_name = map[int32]string{
0: "INSTANCE_TYPE_UNSPECIFIED",
1: "PRIMARY",
2: "READ_POOL",
3: "SECONDARY",
}
Instance_InstanceType_value = map[string]int32{
"INSTANCE_TYPE_UNSPECIFIED": 0,
"PRIMARY": 1,
"READ_POOL": 2,
"SECONDARY": 3,
}
)Enum value maps for Instance_InstanceType.
Instance_AvailabilityType_name, Instance_AvailabilityType_value
var (
Instance_AvailabilityType_name = map[int32]string{
0: "AVAILABILITY_TYPE_UNSPECIFIED",
1: "ZONAL",
2: "REGIONAL",
}
Instance_AvailabilityType_value = map[string]int32{
"AVAILABILITY_TYPE_UNSPECIFIED": 0,
"ZONAL": 1,
"REGIONAL": 2,
}
)Enum value maps for Instance_AvailabilityType.
Instance_UpdatePolicy_Mode_name, Instance_UpdatePolicy_Mode_value
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.
Backup_State_name, Backup_State_value
var (
Backup_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "READY",
2: "CREATING",
3: "FAILED",
4: "DELETING",
}
Backup_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"READY": 1,
"CREATING": 2,
"FAILED": 3,
"DELETING": 4,
}
)Enum value maps for Backup_State.
Backup_Type_name, Backup_Type_value
var (
Backup_Type_name = map[int32]string{
0: "TYPE_UNSPECIFIED",
1: "ON_DEMAND",
2: "AUTOMATED",
3: "CONTINUOUS",
}
Backup_Type_value = map[string]int32{
"TYPE_UNSPECIFIED": 0,
"ON_DEMAND": 1,
"AUTOMATED": 2,
"CONTINUOUS": 3,
}
)Enum value maps for Backup_Type.
SupportedDatabaseFlag_ValueType_name, SupportedDatabaseFlag_ValueType_value
var (
SupportedDatabaseFlag_ValueType_name = map[int32]string{
0: "VALUE_TYPE_UNSPECIFIED",
1: "STRING",
2: "INTEGER",
3: "FLOAT",
4: "NONE",
}
SupportedDatabaseFlag_ValueType_value = map[string]int32{
"VALUE_TYPE_UNSPECIFIED": 0,
"STRING": 1,
"INTEGER": 2,
"FLOAT": 3,
"NONE": 4,
}
)Enum value maps for SupportedDatabaseFlag_ValueType.
User_UserType_name, User_UserType_value
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.
BatchCreateInstanceStatus_State_name, BatchCreateInstanceStatus_State_value
var (
BatchCreateInstanceStatus_State_name = map[int32]string{
0: "STATE_UNSPECIFIED",
1: "PENDING_CREATE",
2: "READY",
3: "CREATING",
4: "DELETING",
5: "FAILED",
6: "ROLLED_BACK",
}
BatchCreateInstanceStatus_State_value = map[string]int32{
"STATE_UNSPECIFIED": 0,
"PENDING_CREATE": 1,
"READY": 2,
"CREATING": 3,
"DELETING": 4,
"FAILED": 5,
"ROLLED_BACK": 6,
}
)Enum value maps for BatchCreateInstanceStatus_State.
InjectFaultRequest_FaultType_name, InjectFaultRequest_FaultType_value
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.
File_google_cloud_alloydb_v1beta_resources_proto
var File_google_cloud_alloydb_v1beta_resources_proto protoreflect.FileDescriptorFile_google_cloud_alloydb_v1beta_service_proto
var File_google_cloud_alloydb_v1beta_service_proto protoreflect.FileDescriptorFunctions
func RegisterAlloyDBAdminServer
func RegisterAlloyDBAdminServer(s *grpc.Server, srv AlloyDBAdminServer)AlloyDBAdminClient
type AlloyDBAdminClient interface {
// Lists Clusters in a given project and location.
ListClusters(ctx context.Context, in *ListClustersRequest, opts ...grpc.CallOption) (*ListClustersResponse, error)
// Gets details of a single Cluster.
GetCluster(ctx context.Context, in *GetClusterRequest, opts ...grpc.CallOption) (*Cluster, error)
// Creates a new Cluster in a given project and location.
CreateCluster(ctx context.Context, in *CreateClusterRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Updates the parameters of a single Cluster.
UpdateCluster(ctx context.Context, in *UpdateClusterRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Deletes a single Cluster.
DeleteCluster(ctx context.Context, in *DeleteClusterRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Promotes a SECONDARY cluster. This turns down replication
// from the PRIMARY cluster and promotes a secondary cluster
// into its own standalone cluster.
// Imperative only.
PromoteCluster(ctx context.Context, in *PromoteClusterRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Creates a new Cluster in a given project and location, with a volume
// restored from the provided source, either a backup ID or a point-in-time
// and a source cluster.
RestoreCluster(ctx context.Context, in *RestoreClusterRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Creates a cluster of type SECONDARY in the given location using
// the primary cluster as the source.
CreateSecondaryCluster(ctx context.Context, in *CreateSecondaryClusterRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Lists Instances in a given project and location.
ListInstances(ctx context.Context, in *ListInstancesRequest, opts ...grpc.CallOption) (*ListInstancesResponse, error)
// Gets details of a single Instance.
GetInstance(ctx context.Context, in *GetInstanceRequest, opts ...grpc.CallOption) (*Instance, error)
// Creates a new Instance in a given project and location.
CreateInstance(ctx context.Context, in *CreateInstanceRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Creates a new SECONDARY Instance in a given project and location.
CreateSecondaryInstance(ctx context.Context, in *CreateSecondaryInstanceRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Creates new instances under the given project, location and cluster.
// There can be only one primary instance in a cluster. If the primary
// instance exists in the cluster as well as this request, then API will
// throw an error.
// The primary instance should exist before any read pool instance is
// created. If the primary instance is a part of the request payload, then
// the API will take care of creating instances in the correct order.
// This method is here to support Google-internal use cases, and is not meant
// for external customers to consume. Please do not start relying on it; its
// behavior is subject to change without notice.
BatchCreateInstances(ctx context.Context, in *BatchCreateInstancesRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Updates the parameters of a single Instance.
UpdateInstance(ctx context.Context, in *UpdateInstanceRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Deletes a single Instance.
DeleteInstance(ctx context.Context, in *DeleteInstanceRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// Forces a Failover for a highly available instance.
// Failover promotes the HA standby instance as the new primary.
// Imperative only.
FailoverInstance(ctx context.Context, in *FailoverInstanceRequest, opts ...grpc.CallOption) (*longrunningpb.Operation, error)
// 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 the Auth Proxy client and
// the endpoint's behavior is subject to change without notice, so do not rely
// on its behavior remaining constant. Future changes will not break the Auth
// Proxy client.
GenerateClientCertificate(ctx context.Context, in *GenerateClientCertificateRequest, opts ...grpc.CallOption) (*GenerateClientCertificateResponse, error)
// Get instance metadata used for a connection.
GetConnectionInfo(ctx context.Context, in *GetConnectionInfoRequest, opts ...grpc.CallOption) (*ConnectionInfo, error)
// 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)
}AlloyDBAdminClient is the client API for AlloyDBAdmin service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func NewAlloyDBAdminClient
func NewAlloyDBAdminClient(cc grpc.ClientConnInterface) AlloyDBAdminClientAlloyDBAdminServer
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 the Auth Proxy client and
// the endpoint's behavior is subject to change without notice, so do not rely
// on its behavior remaining constant. Future changes will not break the Auth
// Proxy client.
GenerateClientCertificate(context.Context, *GenerateClientCertificateRequest) (*GenerateClientCertificateResponse, error)
// Get instance metadata used for a connection.
GetConnectionInfo(context.Context, *GetConnectionInfoRequest) (*ConnectionInfo, error)
// 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)
}AlloyDBAdminServer is the server API for AlloyDBAdmin service.
AutomatedBackupPolicy
type AutomatedBackupPolicy struct {
Schedule isAutomatedBackupPolicy_Schedule `protobuf_oneof:"schedule"`
Retention isAutomatedBackupPolicy_Retention `protobuf_oneof:"retention"`
Enabled *bool `protobuf:"varint,1,opt,name=enabled,proto3,oneof" json:"enabled,omitempty"`
BackupWindow *durationpb.Duration `protobuf:"bytes,3,opt,name=backup_window,json=backupWindow,proto3" json:"backup_window,omitempty"`
EncryptionConfig *EncryptionConfig `protobuf:"bytes,8,opt,name=encryption_config,json=encryptionConfig,proto3" json:"encryption_config,omitempty"`
Location string `protobuf:"bytes,6,opt,name=location,proto3" json:"location,omitempty"`
Labels map[string]string "" /* 153 byte string literal not displayed */
}Message describing the user-specified automated backup policy.
All fields in the automated backup policy are optional. Defaults for each field are provided if they are not set.
func (*AutomatedBackupPolicy) Descriptor
func (*AutomatedBackupPolicy) Descriptor() ([]byte, []int)Deprecated: Use AutomatedBackupPolicy.ProtoReflect.Descriptor instead.
func (*AutomatedBackupPolicy) GetBackupWindow
func (x *AutomatedBackupPolicy) GetBackupWindow() *durationpb.Durationfunc (*AutomatedBackupPolicy) GetEnabled
func (x *AutomatedBackupPolicy) GetEnabled() boolfunc (*AutomatedBackupPolicy) GetEncryptionConfig
func (x *AutomatedBackupPolicy) GetEncryptionConfig() *EncryptionConfigfunc (*AutomatedBackupPolicy) GetLabels
func (x *AutomatedBackupPolicy) GetLabels() map[string]stringfunc (*AutomatedBackupPolicy) GetLocation
func (x *AutomatedBackupPolicy) GetLocation() stringfunc (*AutomatedBackupPolicy) GetQuantityBasedRetention
func (x *AutomatedBackupPolicy) GetQuantityBasedRetention() *AutomatedBackupPolicy_QuantityBasedRetentionfunc (*AutomatedBackupPolicy) GetRetention
func (m *AutomatedBackupPolicy) GetRetention() isAutomatedBackupPolicy_Retentionfunc (*AutomatedBackupPolicy) GetSchedule
func (m *AutomatedBackupPolicy) GetSchedule() isAutomatedBackupPolicy_Schedulefunc (*AutomatedBackupPolicy) GetTimeBasedRetention
func (x *AutomatedBackupPolicy) GetTimeBasedRetention() *AutomatedBackupPolicy_TimeBasedRetentionfunc (*AutomatedBackupPolicy) GetWeeklySchedule
func (x *AutomatedBackupPolicy) GetWeeklySchedule() *AutomatedBackupPolicy_WeeklySchedulefunc (*AutomatedBackupPolicy) ProtoMessage
func (*AutomatedBackupPolicy) ProtoMessage()func (*AutomatedBackupPolicy) ProtoReflect
func (x *AutomatedBackupPolicy) ProtoReflect() protoreflect.Messagefunc (*AutomatedBackupPolicy) Reset
func (x *AutomatedBackupPolicy) Reset()func (*AutomatedBackupPolicy) String
func (x *AutomatedBackupPolicy) String() stringAutomatedBackupPolicy_QuantityBasedRetention
type AutomatedBackupPolicy_QuantityBasedRetention struct {
// The number of backups to retain.
Count int32 `protobuf:"varint,1,opt,name=count,proto3" json:"count,omitempty"`
// contains filtered or unexported fields
}A quantity based policy specifies that a certain number of the most recent successful backups should be retained.
func (*AutomatedBackupPolicy_QuantityBasedRetention) Descriptor
func (*AutomatedBackupPolicy_QuantityBasedRetention) Descriptor() ([]byte, []int)Deprecated: Use AutomatedBackupPolicy_QuantityBasedRetention.ProtoReflect.Descriptor instead.
func (*AutomatedBackupPolicy_QuantityBasedRetention) GetCount
func (x *AutomatedBackupPolicy_QuantityBasedRetention) GetCount() int32func (*AutomatedBackupPolicy_QuantityBasedRetention) ProtoMessage
func (*AutomatedBackupPolicy_QuantityBasedRetention) ProtoMessage()func (*AutomatedBackupPolicy_QuantityBasedRetention) ProtoReflect
func (x *AutomatedBackupPolicy_QuantityBasedRetention) ProtoReflect() protoreflect.Messagefunc (*AutomatedBackupPolicy_QuantityBasedRetention) Reset
func (x *AutomatedBackupPolicy_QuantityBasedRetention) Reset()func (*AutomatedBackupPolicy_QuantityBasedRetention) String
func (x *AutomatedBackupPolicy_QuantityBasedRetention) String() stringAutomatedBackupPolicy_QuantityBasedRetention_
type AutomatedBackupPolicy_QuantityBasedRetention_ struct {
// Quantity-based Backup retention policy to retain recent backups.
QuantityBasedRetention *AutomatedBackupPolicy_QuantityBasedRetention `protobuf:"bytes,5,opt,name=quantity_based_retention,json=quantityBasedRetention,proto3,oneof"`
}AutomatedBackupPolicy_TimeBasedRetention
type AutomatedBackupPolicy_TimeBasedRetention struct {
// The retention period.
RetentionPeriod *durationpb.Duration `protobuf:"bytes,1,opt,name=retention_period,json=retentionPeriod,proto3" json:"retention_period,omitempty"`
// contains filtered or unexported fields
}A time based retention policy specifies that all backups within a certain time period should be retained.
func (*AutomatedBackupPolicy_TimeBasedRetention) Descriptor
func (*AutomatedBackupPolicy_TimeBasedRetention) Descriptor() ([]byte, []int)Deprecated: Use AutomatedBackupPolicy_TimeBasedRetention.ProtoReflect.Descriptor instead.
func (*AutomatedBackupPolicy_TimeBasedRetention) GetRetentionPeriod
func (x *AutomatedBackupPolicy_TimeBasedRetention) GetRetentionPeriod() *durationpb.Durationfunc (*AutomatedBackupPolicy_TimeBasedRetention) ProtoMessage
func (*AutomatedBackupPolicy_TimeBasedRetention) ProtoMessage()func (*AutomatedBackupPolicy_TimeBasedRetention) ProtoReflect
func (x *AutomatedBackupPolicy_TimeBasedRetention) ProtoReflect() protoreflect.Messagefunc (*AutomatedBackupPolicy_TimeBasedRetention) Reset
func (x *AutomatedBackupPolicy_TimeBasedRetention) Reset()func (*AutomatedBackupPolicy_TimeBasedRetention) String
func (x *AutomatedBackupPolicy_TimeBasedRetention) String() stringAutomatedBackupPolicy_TimeBasedRetention_
type AutomatedBackupPolicy_TimeBasedRetention_ struct {
// Time-based Backup retention policy.
TimeBasedRetention *AutomatedBackupPolicy_TimeBasedRetention `protobuf:"bytes,4,opt,name=time_based_retention,json=timeBasedRetention,proto3,oneof"`
}AutomatedBackupPolicy_WeeklySchedule
type AutomatedBackupPolicy_WeeklySchedule struct {
StartTimes []*timeofday.TimeOfDay `protobuf:"bytes,1,rep,name=start_times,json=startTimes,proto3" json:"start_times,omitempty"`
DaysOfWeek []dayofweek.DayOfWeek "" /* 128 byte string literal not displayed */
}A weekly schedule starts a backup at prescribed start times within a day, for the specified days of the week.
The weekly schedule message is flexible and can be used to create many
types of schedules. For example, to have a daily backup that starts at
22:00, configure the start_times field to have one element "22:00" and
the days_of_week field to have all seven days of the week.
func (*AutomatedBackupPolicy_WeeklySchedule) Descriptor
func (*AutomatedBackupPolicy_WeeklySchedule) Descriptor() ([]byte, []int)Deprecated: Use AutomatedBackupPolicy_WeeklySchedule.ProtoReflect.Descriptor instead.
func (*AutomatedBackupPolicy_WeeklySchedule) GetDaysOfWeek
func (x *AutomatedBackupPolicy_WeeklySchedule) GetDaysOfWeek() []dayofweek.DayOfWeekfunc (*AutomatedBackupPolicy_WeeklySchedule) GetStartTimes
func (x *AutomatedBackupPolicy_WeeklySchedule) GetStartTimes() []*timeofday.TimeOfDayfunc (*AutomatedBackupPolicy_WeeklySchedule) ProtoMessage
func (*AutomatedBackupPolicy_WeeklySchedule) ProtoMessage()func (*AutomatedBackupPolicy_WeeklySchedule) ProtoReflect
func (x *AutomatedBackupPolicy_WeeklySchedule) ProtoReflect() protoreflect.Messagefunc (*AutomatedBackupPolicy_WeeklySchedule) Reset
func (x *AutomatedBackupPolicy_WeeklySchedule) Reset()func (*AutomatedBackupPolicy_WeeklySchedule) String
func (x *AutomatedBackupPolicy_WeeklySchedule) String() stringAutomatedBackupPolicy_WeeklySchedule_
type AutomatedBackupPolicy_WeeklySchedule_ struct {
// Weekly schedule for the Backup.
WeeklySchedule *AutomatedBackupPolicy_WeeklySchedule `protobuf:"bytes,2,opt,name=weekly_schedule,json=weeklySchedule,proto3,oneof"`
}Backup
type Backup struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
Uid string `protobuf:"bytes,3,opt,name=uid,proto3" json:"uid,omitempty"`
CreateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
DeleteTime *timestamppb.Timestamp `protobuf:"bytes,15,opt,name=delete_time,json=deleteTime,proto3" json:"delete_time,omitempty"`
Labels map[string]string "" /* 153 byte string literal not displayed */
State Backup_State `protobuf:"varint,7,opt,name=state,proto3,enum=google.cloud.alloydb.v1beta.Backup_State" json:"state,omitempty"`
Type Backup_Type `protobuf:"varint,8,opt,name=type,proto3,enum=google.cloud.alloydb.v1beta.Backup_Type" json:"type,omitempty"`
Description string `protobuf:"bytes,9,opt,name=description,proto3" json:"description,omitempty"`
ClusterUid string `protobuf:"bytes,18,opt,name=cluster_uid,json=clusterUid,proto3" json:"cluster_uid,omitempty"`
ClusterName string `protobuf:"bytes,10,opt,name=cluster_name,json=clusterName,proto3" json:"cluster_name,omitempty"`
Reconciling bool `protobuf:"varint,11,opt,name=reconciling,proto3" json:"reconciling,omitempty"`
EncryptionConfig *EncryptionConfig `protobuf:"bytes,12,opt,name=encryption_config,json=encryptionConfig,proto3" json:"encryption_config,omitempty"`
EncryptionInfo *EncryptionInfo `protobuf:"bytes,13,opt,name=encryption_info,json=encryptionInfo,proto3" json:"encryption_info,omitempty"`
Etag string `protobuf:"bytes,14,opt,name=etag,proto3" json:"etag,omitempty"`
Annotations map[string]string "" /* 164 byte string literal not displayed */
SizeBytes int64 `protobuf:"varint,17,opt,name=size_bytes,json=sizeBytes,proto3" json:"size_bytes,omitempty"`
ExpiryTime *timestamppb.Timestamp `protobuf:"bytes,19,opt,name=expiry_time,json=expiryTime,proto3" json:"expiry_time,omitempty"`
}Message describing Backup object
func (*Backup) Descriptor
Deprecated: Use Backup.ProtoReflect.Descriptor instead.
func (*Backup) GetAnnotations
func (*Backup) GetClusterName
func (*Backup) GetClusterUid
func (*Backup) GetCreateTime
func (x *Backup) GetCreateTime() *timestamppb.Timestampfunc (*Backup) GetDeleteTime
func (x *Backup) GetDeleteTime() *timestamppb.Timestampfunc (*Backup) GetDescription
func (*Backup) GetDisplayName
func (*Backup) GetEncryptionConfig
func (x *Backup) GetEncryptionConfig() *EncryptionConfigfunc (*Backup) GetEncryptionInfo
func (x *Backup) GetEncryptionInfo() *EncryptionInfofunc (*Backup) GetEtag
func (*Backup) GetExpiryTime
func (x *Backup) GetExpiryTime() *timestamppb.Timestampfunc (*Backup) GetLabels
func (*Backup) GetName
func (*Backup) GetReconciling
func (*Backup) GetSizeBytes
func (*Backup) GetState
func (x *Backup) GetState() Backup_Statefunc (*Backup) GetType
func (x *Backup) GetType() Backup_Typefunc (*Backup) GetUid
func (*Backup) GetUpdateTime
func (x *Backup) GetUpdateTime() *timestamppb.Timestampfunc (*Backup) ProtoMessage
func (*Backup) ProtoMessage()func (*Backup) ProtoReflect
func (x *Backup) ProtoReflect() protoreflect.Messagefunc (*Backup) Reset
func (x *Backup) Reset()func (*Backup) String
BackupSource
type BackupSource struct {
// Output only. The system-generated UID of the backup which was used to
// create this resource. The UID is generated when the backup is created, and
// it is retained until the backup is deleted.
BackupUid string `protobuf:"bytes,2,opt,name=backup_uid,json=backupUid,proto3" json:"backup_uid,omitempty"`
// Required. The name of the backup resource with the format:
// * projects/{project}/locations/{region}/backups/{backup_id}
BackupName string `protobuf:"bytes,1,opt,name=backup_name,json=backupName,proto3" json:"backup_name,omitempty"`
// contains filtered or unexported fields
}Message describing a BackupSource.
func (*BackupSource) Descriptor
func (*BackupSource) Descriptor() ([]byte, []int)Deprecated: Use BackupSource.ProtoReflect.Descriptor instead.
func (*BackupSource) GetBackupName
func (x *BackupSource) GetBackupName() stringfunc (*BackupSource) GetBackupUid
func (x *BackupSource) GetBackupUid() stringfunc (*BackupSource) ProtoMessage
func (*BackupSource) ProtoMessage()func (*BackupSource) ProtoReflect
func (x *BackupSource) ProtoReflect() protoreflect.Messagefunc (*BackupSource) Reset
func (x *BackupSource) Reset()func (*BackupSource) String
func (x *BackupSource) String() stringBackup_State
type Backup_State int32Backup State
Backup_STATE_UNSPECIFIED, Backup_READY, Backup_CREATING, Backup_FAILED, Backup_DELETING
const (
// The state of the backup is unknown.
Backup_STATE_UNSPECIFIED Backup_State = 0
// The backup is ready.
Backup_READY Backup_State = 1
// The backup is creating.
Backup_CREATING Backup_State = 2
// The backup failed.
Backup_FAILED Backup_State = 3
// The backup is being deleted.
Backup_DELETING Backup_State = 4
)func (Backup_State) Descriptor
func (Backup_State) Descriptor() protoreflect.EnumDescriptorfunc (Backup_State) Enum
func (x Backup_State) Enum() *Backup_Statefunc (Backup_State) EnumDescriptor
func (Backup_State) EnumDescriptor() ([]byte, []int)Deprecated: Use Backup_State.Descriptor instead.
func (Backup_State) Number
func (x Backup_State) Number() protoreflect.EnumNumberfunc (Backup_State) String
func (x Backup_State) String() stringfunc (Backup_State) Type
func (Backup_State) Type() protoreflect.EnumTypeBackup_Type
type Backup_Type int32Backup Type
Backup_TYPE_UNSPECIFIED, Backup_ON_DEMAND, Backup_AUTOMATED, Backup_CONTINUOUS
const (
// Backup Type is unknown.
Backup_TYPE_UNSPECIFIED Backup_Type = 0
// ON_DEMAND backups that were triggered by the customer (e.g., not
// AUTOMATED).
Backup_ON_DEMAND Backup_Type = 1
// AUTOMATED backups triggered by the automated backups scheduler pursuant
// to an automated backup policy.
Backup_AUTOMATED Backup_Type = 2
// CONTINUOUS backups triggered by the automated backups scheduler
// due to a continuous backup policy.
Backup_CONTINUOUS Backup_Type = 3
)func (Backup_Type) Descriptor
func (Backup_Type) Descriptor() protoreflect.EnumDescriptorfunc (Backup_Type) Enum
func (x Backup_Type) Enum() *Backup_Typefunc (Backup_Type) EnumDescriptor
func (Backup_Type) EnumDescriptor() ([]byte, []int)Deprecated: Use Backup_Type.Descriptor instead.
func (Backup_Type) Number
func (x Backup_Type) Number() protoreflect.EnumNumberfunc (Backup_Type) String
func (x Backup_Type) String() stringfunc (Backup_Type) Type
func (Backup_Type) Type() protoreflect.EnumTypeBatchCreateInstanceStatus
type BatchCreateInstanceStatus struct {
State BatchCreateInstanceStatus_State "" /* 129 byte string literal not displayed */
ErrorMsg string `protobuf:"bytes,2,opt,name=error_msg,json=errorMsg,proto3" json:"error_msg,omitempty"`
Error *status.Status `protobuf:"bytes,4,opt,name=error,proto3" json:"error,omitempty"`
Type Instance_InstanceType `protobuf:"varint,3,opt,name=type,proto3,enum=google.cloud.alloydb.v1beta.Instance_InstanceType" json:"type,omitempty"`
}Message for current status of an instance in the BatchCreateInstances operation. For example, lets say a BatchCreateInstances workflow has 4 instances, Instance1 through Instance4. Lets also assume that 2 instances succeeded but the third failed to create and the 4th was never picked up for creation because of failure of the previous one. Then, resulting states would look something like:
- Instance1 = ROLLED_BACK
- Instance2 = ROLLED_BACK
- Instance3 = FAILED
- Instance4 = FAILED
However, while the operation is running, the instance might be in other states including PENDING_CREATE, ACTIVE, DELETING and CREATING. The states / do not get further updated once the operation is done.
func (*BatchCreateInstanceStatus) Descriptor
func (*BatchCreateInstanceStatus) Descriptor() ([]byte, []int)Deprecated: Use BatchCreateInstanceStatus.ProtoReflect.Descriptor instead.
func (*BatchCreateInstanceStatus) GetError
func (x *BatchCreateInstanceStatus) GetError() *status.Statusfunc (*BatchCreateInstanceStatus) GetErrorMsg
func (x *BatchCreateInstanceStatus) GetErrorMsg() stringfunc (*BatchCreateInstanceStatus) GetState
func (x *BatchCreateInstanceStatus) GetState() BatchCreateInstanceStatus_Statefunc (*BatchCreateInstanceStatus) GetType
func (x *BatchCreateInstanceStatus) GetType() Instance_InstanceTypefunc (*BatchCreateInstanceStatus) ProtoMessage
func (*BatchCreateInstanceStatus) ProtoMessage()func (*BatchCreateInstanceStatus) ProtoReflect
func (x *BatchCreateInstanceStatus) ProtoReflect() protoreflect.Messagefunc (*BatchCreateInstanceStatus) Reset
func (x *BatchCreateInstanceStatus) Reset()func (*BatchCreateInstanceStatus) String
func (x *BatchCreateInstanceStatus) String() stringBatchCreateInstanceStatus_State
type BatchCreateInstanceStatus_State int32State contains all valid instance states for the BatchCreateInstances operation. This is mainly used for status reporting through the LRO metadata.
BatchCreateInstanceStatus_STATE_UNSPECIFIED, BatchCreateInstanceStatus_PENDING_CREATE, BatchCreateInstanceStatus_READY, BatchCreateInstanceStatus_CREATING, BatchCreateInstanceStatus_DELETING, BatchCreateInstanceStatus_FAILED, BatchCreateInstanceStatus_ROLLED_BACK
const (
// The state of the instance is unknown.
BatchCreateInstanceStatus_STATE_UNSPECIFIED BatchCreateInstanceStatus_State = 0
// Instance is pending creation and has not yet been picked up for
// processsing in the backend.
BatchCreateInstanceStatus_PENDING_CREATE BatchCreateInstanceStatus_State = 1
// The instance is active and running.
BatchCreateInstanceStatus_READY BatchCreateInstanceStatus_State = 2
// The instance is being created.
BatchCreateInstanceStatus_CREATING BatchCreateInstanceStatus_State = 3
// The instance is being deleted.
BatchCreateInstanceStatus_DELETING BatchCreateInstanceStatus_State = 4
// The creation of the instance failed or a fatal error occurred during
// an operation on the instance or a batch of instances.
BatchCreateInstanceStatus_FAILED BatchCreateInstanceStatus_State = 5
// The instance was created successfully, but was rolled back and deleted
// due to some other failure during BatchCreateInstances operation.
BatchCreateInstanceStatus_ROLLED_BACK BatchCreateInstanceStatus_State = 6
)func (BatchCreateInstanceStatus_State) Descriptor
func (BatchCreateInstanceStatus_State) Descriptor() protoreflect.EnumDescriptorfunc (BatchCreateInstanceStatus_State) Enum
func (x BatchCreateInstanceStatus_State) Enum() *BatchCreateInstanceStatus_Statefunc (BatchCreateInstanceStatus_State) EnumDescriptor
func (BatchCreateInstanceStatus_State) EnumDescriptor() ([]byte, []int)Deprecated: Use BatchCreateInstanceStatus_State.Descriptor instead.
func (BatchCreateInstanceStatus_State) Number
func (x BatchCreateInstanceStatus_State) Number() protoreflect.EnumNumberfunc (BatchCreateInstanceStatus_State) String
func (x BatchCreateInstanceStatus_State) String() stringfunc (BatchCreateInstanceStatus_State) Type
func (BatchCreateInstanceStatus_State) Type() protoreflect.EnumTypeBatchCreateInstancesMetadata
type BatchCreateInstancesMetadata struct {
InstanceTargets []string `protobuf:"bytes,1,rep,name=instance_targets,json=instanceTargets,proto3" json:"instance_targets,omitempty"`
InstanceStatuses map[string]*BatchCreateInstanceStatus "" /* 197 byte string literal not displayed */
}Message for metadata that is specific to BatchCreateInstances API. NEXT_ID: 3
func (*BatchCreateInstancesMetadata) Descriptor
func (*BatchCreateInstancesMetadata) Descriptor() ([]byte, []int)Deprecated: Use BatchCreateInstancesMetadata.ProtoReflect.Descriptor instead.
func (*BatchCreateInstancesMetadata) GetInstanceStatuses
func (x *BatchCreateInstancesMetadata) GetInstanceStatuses() map[string]*BatchCreateInstanceStatusfunc (*BatchCreateInstancesMetadata) GetInstanceTargets
func (x *BatchCreateInstancesMetadata) GetInstanceTargets() []stringfunc (*BatchCreateInstancesMetadata) ProtoMessage
func (*BatchCreateInstancesMetadata) ProtoMessage()func (*BatchCreateInstancesMetadata) ProtoReflect
func (x *BatchCreateInstancesMetadata) ProtoReflect() protoreflect.Messagefunc (*BatchCreateInstancesMetadata) Reset
func (x *BatchCreateInstancesMetadata) Reset()func (*BatchCreateInstancesMetadata) String
func (x *BatchCreateInstancesMetadata) String() stringBatchCreateInstancesRequest
type BatchCreateInstancesRequest struct {
// Required. The name of the parent resource.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. Resources being created.
Requests *CreateInstanceRequests `protobuf:"bytes,2,opt,name=requests,proto3" json:"requests,omitempty"`
// Optional. An optional request ID to identify requests. Specify a unique
// request ID so that if you must retry your request, the server will know to
// ignore the request if it has already been completed. The server will
// guarantee that for at least 60 minutes since the first request.
//
// For example, consider a situation where you make an initial request and
// the request times out. If you make the request again with the same request
// ID, the server can check if original operation with the same request ID
// was received, and if so, will ignore the second request. This prevents
// clients from accidentally creating duplicate commitments.
//
// The request ID must be a valid UUID with the exception that zero UUID is
// not supported (00000000-0000-0000-0000-000000000000).
RequestId string `protobuf:"bytes,3,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
// contains filtered or unexported fields
}Message for creating a batch of instances under the specified cluster.
func (*BatchCreateInstancesRequest) Descriptor
func (*BatchCreateInstancesRequest) Descriptor() ([]byte, []int)Deprecated: Use BatchCreateInstancesRequest.ProtoReflect.Descriptor instead.
func (*BatchCreateInstancesRequest) GetParent
func (x *BatchCreateInstancesRequest) GetParent() stringfunc (*BatchCreateInstancesRequest) GetRequestId
func (x *BatchCreateInstancesRequest) GetRequestId() stringfunc (*BatchCreateInstancesRequest) GetRequests
func (x *BatchCreateInstancesRequest) GetRequests() *CreateInstanceRequestsfunc (*BatchCreateInstancesRequest) ProtoMessage
func (*BatchCreateInstancesRequest) ProtoMessage()func (*BatchCreateInstancesRequest) ProtoReflect
func (x *BatchCreateInstancesRequest) ProtoReflect() protoreflect.Messagefunc (*BatchCreateInstancesRequest) Reset
func (x *BatchCreateInstancesRequest) Reset()func (*BatchCreateInstancesRequest) String
func (x *BatchCreateInstancesRequest) String() stringBatchCreateInstancesResponse
type BatchCreateInstancesResponse struct {
// Created instances.
Instances []*Instance `protobuf:"bytes,1,rep,name=instances,proto3" json:"instances,omitempty"`
// contains filtered or unexported fields
}Message for creating batches of instances in a cluster.
func (*BatchCreateInstancesResponse) Descriptor
func (*BatchCreateInstancesResponse) Descriptor() ([]byte, []int)Deprecated: Use BatchCreateInstancesResponse.ProtoReflect.Descriptor instead.
func (*BatchCreateInstancesResponse) GetInstances
func (x *BatchCreateInstancesResponse) GetInstances() []*Instancefunc (*BatchCreateInstancesResponse) ProtoMessage
func (*BatchCreateInstancesResponse) ProtoMessage()func (*BatchCreateInstancesResponse) ProtoReflect
func (x *BatchCreateInstancesResponse) ProtoReflect() protoreflect.Messagefunc (*BatchCreateInstancesResponse) Reset
func (x *BatchCreateInstancesResponse) Reset()func (*BatchCreateInstancesResponse) String
func (x *BatchCreateInstancesResponse) String() stringCluster
type Cluster struct {
Source isCluster_Source `protobuf_oneof:"source"`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
Uid string `protobuf:"bytes,3,opt,name=uid,proto3" json:"uid,omitempty"`
CreateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
DeleteTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=delete_time,json=deleteTime,proto3" json:"delete_time,omitempty"`
Labels map[string]string "" /* 153 byte string literal not displayed */
State Cluster_State `protobuf:"varint,8,opt,name=state,proto3,enum=google.cloud.alloydb.v1beta.Cluster_State" json:"state,omitempty"`
ClusterType Cluster_ClusterType "" /* 149 byte string literal not displayed */
DatabaseVersion DatabaseVersion "" /* 156 byte string literal not displayed */
NetworkConfig *Cluster_NetworkConfig `protobuf:"bytes,29,opt,name=network_config,json=networkConfig,proto3" json:"network_config,omitempty"`
Network string `protobuf:"bytes,10,opt,name=network,proto3" json:"network,omitempty"`
Etag string `protobuf:"bytes,11,opt,name=etag,proto3" json:"etag,omitempty"`
Annotations map[string]string "" /* 164 byte string literal not displayed */
Reconciling bool `protobuf:"varint,13,opt,name=reconciling,proto3" json:"reconciling,omitempty"`
InitialUser *UserPassword `protobuf:"bytes,14,opt,name=initial_user,json=initialUser,proto3" json:"initial_user,omitempty"`
AutomatedBackupPolicy *AutomatedBackupPolicy "" /* 127 byte string literal not displayed */
SslConfig *SslConfig `protobuf:"bytes,18,opt,name=ssl_config,json=sslConfig,proto3" json:"ssl_config,omitempty"`
EncryptionConfig *EncryptionConfig `protobuf:"bytes,19,opt,name=encryption_config,json=encryptionConfig,proto3" json:"encryption_config,omitempty"`
EncryptionInfo *EncryptionInfo `protobuf:"bytes,20,opt,name=encryption_info,json=encryptionInfo,proto3" json:"encryption_info,omitempty"`
ContinuousBackupConfig *ContinuousBackupConfig "" /* 130 byte string literal not displayed */
ContinuousBackupInfo *ContinuousBackupInfo `protobuf:"bytes,28,opt,name=continuous_backup_info,json=continuousBackupInfo,proto3" json:"continuous_backup_info,omitempty"`
SecondaryConfig *Cluster_SecondaryConfig `protobuf:"bytes,22,opt,name=secondary_config,json=secondaryConfig,proto3" json:"secondary_config,omitempty"`
PrimaryConfig *Cluster_PrimaryConfig `protobuf:"bytes,23,opt,name=primary_config,json=primaryConfig,proto3" json:"primary_config,omitempty"`
}A cluster is a collection of regional AlloyDB resources. It can include a primary instance and one or more read pool instances. All cluster resources share a storage layer, which scales as needed.
func (*Cluster) Descriptor
Deprecated: Use Cluster.ProtoReflect.Descriptor instead.
func (*Cluster) GetAnnotations
func (*Cluster) GetAutomatedBackupPolicy
func (x *Cluster) GetAutomatedBackupPolicy() *AutomatedBackupPolicyfunc (*Cluster) GetBackupSource
func (x *Cluster) GetBackupSource() *BackupSourcefunc (*Cluster) GetClusterType
func (x *Cluster) GetClusterType() Cluster_ClusterTypefunc (*Cluster) GetContinuousBackupConfig
func (x *Cluster) GetContinuousBackupConfig() *ContinuousBackupConfigfunc (*Cluster) GetContinuousBackupInfo
func (x *Cluster) GetContinuousBackupInfo() *ContinuousBackupInfofunc (*Cluster) GetCreateTime
func (x *Cluster) GetCreateTime() *timestamppb.Timestampfunc (*Cluster) GetDatabaseVersion
func (x *Cluster) GetDatabaseVersion() DatabaseVersionfunc (*Cluster) GetDeleteTime
func (x *Cluster) GetDeleteTime() *timestamppb.Timestampfunc (*Cluster) GetDisplayName
func (*Cluster) GetEncryptionConfig
func (x *Cluster) GetEncryptionConfig() *EncryptionConfigfunc (*Cluster) GetEncryptionInfo
func (x *Cluster) GetEncryptionInfo() *EncryptionInfofunc (*Cluster) GetEtag
func (*Cluster) GetInitialUser
func (x *Cluster) GetInitialUser() *UserPasswordfunc (*Cluster) GetLabels
func (*Cluster) GetMigrationSource
func (x *Cluster) GetMigrationSource() *MigrationSourcefunc (*Cluster) GetName
func (*Cluster) GetNetwork
func (*Cluster) GetNetworkConfig
func (x *Cluster) GetNetworkConfig() *Cluster_NetworkConfigfunc (*Cluster) GetPrimaryConfig
func (x *Cluster) GetPrimaryConfig() *Cluster_PrimaryConfigfunc (*Cluster) GetReconciling
func (*Cluster) GetSecondaryConfig
func (x *Cluster) GetSecondaryConfig() *Cluster_SecondaryConfigfunc (*Cluster) GetSource
func (m *Cluster) GetSource() isCluster_Sourcefunc (*Cluster) GetSslConfig
Deprecated: Marked as deprecated in google/cloud/alloydb/v1beta/resources.proto.
func (*Cluster) GetState
func (x *Cluster) GetState() Cluster_Statefunc (*Cluster) GetUid
func (*Cluster) GetUpdateTime
func (x *Cluster) GetUpdateTime() *timestamppb.Timestampfunc (*Cluster) ProtoMessage
func (*Cluster) ProtoMessage()func (*Cluster) ProtoReflect
func (x *Cluster) ProtoReflect() protoreflect.Messagefunc (*Cluster) Reset
func (x *Cluster) Reset()func (*Cluster) String
ClusterView
type ClusterView int32View on Cluster. Pass this enum to rpcs that returns a cluster message to control which subsets of fields to get.
ClusterView_CLUSTER_VIEW_UNSPECIFIED, ClusterView_CLUSTER_VIEW_BASIC, ClusterView_CLUSTER_VIEW_CONTINUOUS_BACKUP
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
func (ClusterView) Descriptor() protoreflect.EnumDescriptorfunc (ClusterView) Enum
func (x ClusterView) Enum() *ClusterViewfunc (ClusterView) EnumDescriptor
func (ClusterView) EnumDescriptor() ([]byte, []int)Deprecated: Use ClusterView.Descriptor instead.
func (ClusterView) Number
func (x ClusterView) Number() protoreflect.EnumNumberfunc (ClusterView) String
func (x ClusterView) String() stringfunc (ClusterView) Type
func (ClusterView) Type() protoreflect.EnumTypeCluster_BackupSource
type Cluster_BackupSource struct {
// Output only. Cluster created from backup.
BackupSource *BackupSource `protobuf:"bytes,15,opt,name=backup_source,json=backupSource,proto3,oneof"`
}Cluster_ClusterType
type Cluster_ClusterType int32Type of Cluster
Cluster_CLUSTER_TYPE_UNSPECIFIED, Cluster_PRIMARY, Cluster_SECONDARY
const (
// The type of the cluster is unknown.
Cluster_CLUSTER_TYPE_UNSPECIFIED Cluster_ClusterType = 0
// Primary cluster that support read and write operations.
Cluster_PRIMARY Cluster_ClusterType = 1
// Secondary cluster that is replicating from another region.
// This only supports read.
Cluster_SECONDARY Cluster_ClusterType = 2
)func (Cluster_ClusterType) Descriptor
func (Cluster_ClusterType) Descriptor() protoreflect.EnumDescriptorfunc (Cluster_ClusterType) Enum
func (x Cluster_ClusterType) Enum() *Cluster_ClusterTypefunc (Cluster_ClusterType) EnumDescriptor
func (Cluster_ClusterType) EnumDescriptor() ([]byte, []int)Deprecated: Use Cluster_ClusterType.Descriptor instead.
func (Cluster_ClusterType) Number
func (x Cluster_ClusterType) Number() protoreflect.EnumNumberfunc (Cluster_ClusterType) String
func (x Cluster_ClusterType) String() stringfunc (Cluster_ClusterType) Type
func (Cluster_ClusterType) Type() protoreflect.EnumTypeCluster_MigrationSource
type Cluster_MigrationSource struct {
// Output only. Cluster created via DMS migration.
MigrationSource *MigrationSource `protobuf:"bytes,16,opt,name=migration_source,json=migrationSource,proto3,oneof"`
}Cluster_NetworkConfig
type Cluster_NetworkConfig struct {
// Required. The resource link for the VPC network in which cluster
// resources are created and from which they are accessible via Private IP.
// The network must belong to the same project as the cluster. It is
// specified in the form:
// "projects/{project_number}/global/networks/{network_id}". This is
// required to create a cluster. It can be updated, but it cannot be
// removed.
Network string `protobuf:"bytes,1,opt,name=network,proto3" json:"network,omitempty"`
// Optional. The 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 CloudSQL.
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
func (*Cluster_NetworkConfig) Descriptor() ([]byte, []int)Deprecated: Use Cluster_NetworkConfig.ProtoReflect.Descriptor instead.
func (*Cluster_NetworkConfig) GetAllocatedIpRange
func (x *Cluster_NetworkConfig) GetAllocatedIpRange() stringfunc (*Cluster_NetworkConfig) GetNetwork
func (x *Cluster_NetworkConfig) GetNetwork() stringfunc (*Cluster_NetworkConfig) ProtoMessage
func (*Cluster_NetworkConfig) ProtoMessage()func (*Cluster_NetworkConfig) ProtoReflect
func (x *Cluster_NetworkConfig) ProtoReflect() protoreflect.Messagefunc (*Cluster_NetworkConfig) Reset
func (x *Cluster_NetworkConfig) Reset()func (*Cluster_NetworkConfig) String
func (x *Cluster_NetworkConfig) String() stringCluster_PrimaryConfig
type Cluster_PrimaryConfig struct {
// Output only. Names of the clusters that are replicating from this
// cluster.
SecondaryClusterNames []string `protobuf:"bytes,1,rep,name=secondary_cluster_names,json=secondaryClusterNames,proto3" json:"secondary_cluster_names,omitempty"`
// contains filtered or unexported fields
}Configuration for the primary cluster. It has the list of clusters that are replicating from this cluster. This should be set if and only if the cluster is of type PRIMARY.
func (*Cluster_PrimaryConfig) Descriptor
func (*Cluster_PrimaryConfig) Descriptor() ([]byte, []int)Deprecated: Use Cluster_PrimaryConfig.ProtoReflect.Descriptor instead.
func (*Cluster_PrimaryConfig) GetSecondaryClusterNames
func (x *Cluster_PrimaryConfig) GetSecondaryClusterNames() []stringfunc (*Cluster_PrimaryConfig) ProtoMessage
func (*Cluster_PrimaryConfig) ProtoMessage()func (*Cluster_PrimaryConfig) ProtoReflect
func (x *Cluster_PrimaryConfig) ProtoReflect() protoreflect.Messagefunc (*Cluster_PrimaryConfig) Reset
func (x *Cluster_PrimaryConfig) Reset()func (*Cluster_PrimaryConfig) String
func (x *Cluster_PrimaryConfig) String() stringCluster_SecondaryConfig
type Cluster_SecondaryConfig struct {
// The name of the primary cluster name with the format:
// * projects/{project}/locations/{region}/clusters/{cluster_id}
PrimaryClusterName string `protobuf:"bytes,1,opt,name=primary_cluster_name,json=primaryClusterName,proto3" json:"primary_cluster_name,omitempty"`
// contains filtered or unexported fields
}Configuration information for the secondary cluster. This should be set if and only if the cluster is of type SECONDARY.
func (*Cluster_SecondaryConfig) Descriptor
func (*Cluster_SecondaryConfig) Descriptor() ([]byte, []int)Deprecated: Use Cluster_SecondaryConfig.ProtoReflect.Descriptor instead.
func (*Cluster_SecondaryConfig) GetPrimaryClusterName
func (x *Cluster_SecondaryConfig) GetPrimaryClusterName() stringfunc (*Cluster_SecondaryConfig) ProtoMessage
func (*Cluster_SecondaryConfig) ProtoMessage()func (*Cluster_SecondaryConfig) ProtoReflect
func (x *Cluster_SecondaryConfig) ProtoReflect() protoreflect.Messagefunc (*Cluster_SecondaryConfig) Reset
func (x *Cluster_SecondaryConfig) Reset()func (*Cluster_SecondaryConfig) String
func (x *Cluster_SecondaryConfig) String() stringCluster_State
type Cluster_State int32Cluster State
Cluster_STATE_UNSPECIFIED, Cluster_READY, Cluster_STOPPED, Cluster_EMPTY, Cluster_CREATING, Cluster_DELETING, Cluster_FAILED, Cluster_BOOTSTRAPPING, Cluster_MAINTENANCE, Cluster_PROMOTING
const (
// The state of the cluster is unknown.
Cluster_STATE_UNSPECIFIED Cluster_State = 0
// The cluster is active and running.
Cluster_READY Cluster_State = 1
// The cluster is stopped. All instances in the cluster are stopped.
// Customers can start a stopped cluster at any point and all their
// instances will come back to life with same names and IP resources. In
// this state, customer pays for storage.
// Associated backups could also be present in a stopped cluster.
Cluster_STOPPED Cluster_State = 2
// The cluster is empty and has no associated resources.
// All instances, associated storage and backups have been deleted.
Cluster_EMPTY Cluster_State = 3
// The cluster is being created.
Cluster_CREATING Cluster_State = 4
// The cluster is being deleted.
Cluster_DELETING Cluster_State = 5
// The creation of the cluster failed.
Cluster_FAILED Cluster_State = 6
// The cluster is bootstrapping with data from some other source.
// Direct mutations to the cluster (e.g. adding read pool) are not allowed.
Cluster_BOOTSTRAPPING Cluster_State = 7
// The cluster is under maintenance. AlloyDB regularly performs maintenance
// and upgrades on customer clusters. Updates on the cluster are
// not allowed while the cluster is in this state.
Cluster_MAINTENANCE Cluster_State = 8
// The cluster is being promoted.
Cluster_PROMOTING Cluster_State = 9
)func (Cluster_State) Descriptor
func (Cluster_State) Descriptor() protoreflect.EnumDescriptorfunc (Cluster_State) Enum
func (x Cluster_State) Enum() *Cluster_Statefunc (Cluster_State) EnumDescriptor
func (Cluster_State) EnumDescriptor() ([]byte, []int)Deprecated: Use Cluster_State.Descriptor instead.
func (Cluster_State) Number
func (x Cluster_State) Number() protoreflect.EnumNumberfunc (Cluster_State) String
func (x Cluster_State) String() stringfunc (Cluster_State) Type
func (Cluster_State) Type() protoreflect.EnumTypeConnectionInfo
type ConnectionInfo struct {
// The name of the ConnectionInfo singleton resource, e.g.:
// projects/{project}/locations/{location}/clusters/*/instances/*/connectionInfo
// This field currently has no semantic meaning.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Output only. The IP address for the Instance.
// This is the connection endpoint for an end-user application.
IpAddress string `protobuf:"bytes,2,opt,name=ip_address,json=ipAddress,proto3" json:"ip_address,omitempty"`
// Output only. The pem-encoded chain that may be used to verify the X.509
// certificate. Expected to be in issuer-to-root order according to RFC 5246.
//
// 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"`
// contains filtered or unexported fields
}ConnectionInfo singleton resource. https://google.aip.dev/156
func (*ConnectionInfo) Descriptor
func (*ConnectionInfo) Descriptor() ([]byte, []int)Deprecated: Use ConnectionInfo.ProtoReflect.Descriptor instead.
func (*ConnectionInfo) GetInstanceUid
func (x *ConnectionInfo) GetInstanceUid() stringfunc (*ConnectionInfo) GetIpAddress
func (x *ConnectionInfo) GetIpAddress() stringfunc (*ConnectionInfo) GetName
func (x *ConnectionInfo) GetName() stringfunc (*ConnectionInfo) GetPemCertificateChain
func (x *ConnectionInfo) GetPemCertificateChain() []stringDeprecated: Marked as deprecated in google/cloud/alloydb/v1beta/resources.proto.
func (*ConnectionInfo) ProtoMessage
func (*ConnectionInfo) ProtoMessage()func (*ConnectionInfo) ProtoReflect
func (x *ConnectionInfo) ProtoReflect() protoreflect.Messagefunc (*ConnectionInfo) Reset
func (x *ConnectionInfo) Reset()func (*ConnectionInfo) String
func (x *ConnectionInfo) String() stringContinuousBackupConfig
type ContinuousBackupConfig struct {
// Whether ContinuousBackup is enabled.
Enabled *bool `protobuf:"varint,1,opt,name=enabled,proto3,oneof" json:"enabled,omitempty"`
// The number of days backups and logs will be retained, which determines the
// window of time that data is recoverable for. If not set, it defaults to 14
// days.
RecoveryWindowDays int32 `protobuf:"varint,4,opt,name=recovery_window_days,json=recoveryWindowDays,proto3" json:"recovery_window_days,omitempty"`
// The encryption config can be specified to encrypt the
// backups with a customer-managed encryption key (CMEK). When this field is
// not specified, the backup will then use default encryption scheme to
// protect the user data.
EncryptionConfig *EncryptionConfig `protobuf:"bytes,3,opt,name=encryption_config,json=encryptionConfig,proto3" json:"encryption_config,omitempty"`
// contains filtered or unexported fields
}ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster.
func (*ContinuousBackupConfig) Descriptor
func (*ContinuousBackupConfig) Descriptor() ([]byte, []int)Deprecated: Use ContinuousBackupConfig.ProtoReflect.Descriptor instead.
func (*ContinuousBackupConfig) GetEnabled
func (x *ContinuousBackupConfig) GetEnabled() boolfunc (*ContinuousBackupConfig) GetEncryptionConfig
func (x *ContinuousBackupConfig) GetEncryptionConfig() *EncryptionConfigfunc (*ContinuousBackupConfig) GetRecoveryWindowDays
func (x *ContinuousBackupConfig) GetRecoveryWindowDays() int32func (*ContinuousBackupConfig) ProtoMessage
func (*ContinuousBackupConfig) ProtoMessage()func (*ContinuousBackupConfig) ProtoReflect
func (x *ContinuousBackupConfig) ProtoReflect() protoreflect.Messagefunc (*ContinuousBackupConfig) Reset
func (x *ContinuousBackupConfig) Reset()func (*ContinuousBackupConfig) String
func (x *ContinuousBackupConfig) String() stringContinuousBackupInfo
type ContinuousBackupInfo struct {
EncryptionInfo *EncryptionInfo `protobuf:"bytes,1,opt,name=encryption_info,json=encryptionInfo,proto3" json:"encryption_info,omitempty"`
EnabledTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=enabled_time,json=enabledTime,proto3" json:"enabled_time,omitempty"`
Schedule []dayofweek.DayOfWeek `protobuf:"varint,3,rep,packed,name=schedule,proto3,enum=google.type.DayOfWeek" json:"schedule,omitempty"`
EarliestRestorableTime *timestamppb.Timestamp "" /* 129 byte string literal not displayed */
}ContinuousBackupInfo describes the continuous backup properties of a cluster.
func (*ContinuousBackupInfo) Descriptor
func (*ContinuousBackupInfo) Descriptor() ([]byte, []int)Deprecated: Use ContinuousBackupInfo.ProtoReflect.Descriptor instead.
func (*ContinuousBackupInfo) GetEarliestRestorableTime
func (x *ContinuousBackupInfo) GetEarliestRestorableTime() *timestamppb.Timestampfunc (*ContinuousBackupInfo) GetEnabledTime
func (x *ContinuousBackupInfo) GetEnabledTime() *timestamppb.Timestampfunc (*ContinuousBackupInfo) GetEncryptionInfo
func (x *ContinuousBackupInfo) GetEncryptionInfo() *EncryptionInfofunc (*ContinuousBackupInfo) GetSchedule
func (x *ContinuousBackupInfo) GetSchedule() []dayofweek.DayOfWeekfunc (*ContinuousBackupInfo) ProtoMessage
func (*ContinuousBackupInfo) ProtoMessage()func (*ContinuousBackupInfo) ProtoReflect
func (x *ContinuousBackupInfo) ProtoReflect() protoreflect.Messagefunc (*ContinuousBackupInfo) Reset
func (x *ContinuousBackupInfo) Reset()func (*ContinuousBackupInfo) String
func (x *ContinuousBackupInfo) String() stringContinuousBackupSource
type ContinuousBackupSource struct {
// Required. The source cluster from which to restore. This cluster must have
// continuous backup enabled for this operation to succeed. For the required
// format, see the comment on the Cluster.name field.
Cluster string `protobuf:"bytes,1,opt,name=cluster,proto3" json:"cluster,omitempty"`
// Required. The point in time to restore to.
PointInTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=point_in_time,json=pointInTime,proto3" json:"point_in_time,omitempty"`
// contains filtered or unexported fields
}Message describing a ContinuousBackupSource.
func (*ContinuousBackupSource) Descriptor
func (*ContinuousBackupSource) Descriptor() ([]byte, []int)Deprecated: Use ContinuousBackupSource.ProtoReflect.Descriptor instead.
func (*ContinuousBackupSource) GetCluster
func (x *ContinuousBackupSource) GetCluster() stringfunc (*ContinuousBackupSource) GetPointInTime
func (x *ContinuousBackupSource) GetPointInTime() *timestamppb.Timestampfunc (*ContinuousBackupSource) ProtoMessage
func (*ContinuousBackupSource) ProtoMessage()func (*ContinuousBackupSource) ProtoReflect
func (x *ContinuousBackupSource) ProtoReflect() protoreflect.Messagefunc (*ContinuousBackupSource) Reset
func (x *ContinuousBackupSource) Reset()func (*ContinuousBackupSource) String
func (x *ContinuousBackupSource) String() stringCreateBackupRequest
type CreateBackupRequest struct {
// Required. Value for parent.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. ID of the requesting object.
BackupId string `protobuf:"bytes,2,opt,name=backup_id,json=backupId,proto3" json:"backup_id,omitempty"`
// Required. The resource being created
Backup *Backup `protobuf:"bytes,3,opt,name=backup,proto3" json:"backup,omitempty"`
// Optional. An optional request ID to identify requests. Specify a unique
// request ID so that if you must retry your request, the server will know to
// ignore the request if it has already been completed. The server will
// guarantee that for at least 60 minutes since the first request.
//
// For example, consider a situation where you make an initial request and
// the request times out. If you make the request again with the same request
// ID, the server can check if original operation with the same request ID
// was received, and if so, will ignore the second request. This prevents
// clients from accidentally creating duplicate commitments.
//
// The request ID must be a valid UUID with the exception that zero UUID is
// not supported (00000000-0000-0000-0000-000000000000).
RequestId string `protobuf:"bytes,4,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
// Optional. If set, the backend validates the request, but doesn't actually
// execute it.
ValidateOnly bool `protobuf:"varint,5,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
// contains filtered or unexported fields
}Message for creating a Backup
func (*CreateBackupRequest) Descriptor
func (*CreateBackupRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateBackupRequest.ProtoReflect.Descriptor instead.
func (*CreateBackupRequest) GetBackup
func (x *CreateBackupRequest) GetBackup() *Backupfunc (*CreateBackupRequest) GetBackupId
func (x *CreateBackupRequest) GetBackupId() stringfunc (*CreateBackupRequest) GetParent
func (x *CreateBackupRequest) GetParent() stringfunc (*CreateBackupRequest) GetRequestId
func (x *CreateBackupRequest) GetRequestId() stringfunc (*CreateBackupRequest) GetValidateOnly
func (x *CreateBackupRequest) GetValidateOnly() boolfunc (*CreateBackupRequest) ProtoMessage
func (*CreateBackupRequest) ProtoMessage()func (*CreateBackupRequest) ProtoReflect
func (x *CreateBackupRequest) ProtoReflect() protoreflect.Messagefunc (*CreateBackupRequest) Reset
func (x *CreateBackupRequest) Reset()func (*CreateBackupRequest) String
func (x *CreateBackupRequest) String() stringCreateClusterRequest
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
func (*CreateClusterRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateClusterRequest.ProtoReflect.Descriptor instead.
func (*CreateClusterRequest) GetCluster
func (x *CreateClusterRequest) GetCluster() *Clusterfunc (*CreateClusterRequest) GetClusterId
func (x *CreateClusterRequest) GetClusterId() stringfunc (*CreateClusterRequest) GetParent
func (x *CreateClusterRequest) GetParent() stringfunc (*CreateClusterRequest) GetRequestId
func (x *CreateClusterRequest) GetRequestId() stringfunc (*CreateClusterRequest) GetValidateOnly
func (x *CreateClusterRequest) GetValidateOnly() boolfunc (*CreateClusterRequest) ProtoMessage
func (*CreateClusterRequest) ProtoMessage()func (*CreateClusterRequest) ProtoReflect
func (x *CreateClusterRequest) ProtoReflect() protoreflect.Messagefunc (*CreateClusterRequest) Reset
func (x *CreateClusterRequest) Reset()func (*CreateClusterRequest) String
func (x *CreateClusterRequest) String() stringCreateInstanceRequest
type CreateInstanceRequest struct {
// Required. The name of the parent resource. For the required format, see the
// comment on the Instance.name field.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. ID of the requesting object.
InstanceId string `protobuf:"bytes,2,opt,name=instance_id,json=instanceId,proto3" json:"instance_id,omitempty"`
// Required. The resource being created
Instance *Instance `protobuf:"bytes,3,opt,name=instance,proto3" json:"instance,omitempty"`
// Optional. An optional request ID to identify requests. Specify a unique
// request ID so that if you must retry your request, the server will know to
// ignore the request if it has already been completed. The server will
// guarantee that for at least 60 minutes since the first request.
//
// For example, consider a situation where you make an initial request and
// the request times out. If you make the request again with the same request
// ID, the server can check if original operation with the same request ID
// was received, and if so, will ignore the second request. This prevents
// clients from accidentally creating duplicate commitments.
//
// The request ID must be a valid UUID with the exception that zero UUID is
// not supported (00000000-0000-0000-0000-000000000000).
RequestId string `protobuf:"bytes,4,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
// Optional. If set, performs request validation (e.g. permission checks and
// any other type of validation), but do not actually execute the create
// request.
ValidateOnly bool `protobuf:"varint,5,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
// contains filtered or unexported fields
}Message for creating a Instance
func (*CreateInstanceRequest) Descriptor
func (*CreateInstanceRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateInstanceRequest.ProtoReflect.Descriptor instead.
func (*CreateInstanceRequest) GetInstance
func (x *CreateInstanceRequest) GetInstance() *Instancefunc (*CreateInstanceRequest) GetInstanceId
func (x *CreateInstanceRequest) GetInstanceId() stringfunc (*CreateInstanceRequest) GetParent
func (x *CreateInstanceRequest) GetParent() stringfunc (*CreateInstanceRequest) GetRequestId
func (x *CreateInstanceRequest) GetRequestId() stringfunc (*CreateInstanceRequest) GetValidateOnly
func (x *CreateInstanceRequest) GetValidateOnly() boolfunc (*CreateInstanceRequest) ProtoMessage
func (*CreateInstanceRequest) ProtoMessage()func (*CreateInstanceRequest) ProtoReflect
func (x *CreateInstanceRequest) ProtoReflect() protoreflect.Messagefunc (*CreateInstanceRequest) Reset
func (x *CreateInstanceRequest) Reset()func (*CreateInstanceRequest) String
func (x *CreateInstanceRequest) String() stringCreateInstanceRequests
type CreateInstanceRequests struct {
CreateInstanceRequests []*CreateInstanceRequest "" /* 129 byte string literal not displayed */
}See usage below for notes.
func (*CreateInstanceRequests) Descriptor
func (*CreateInstanceRequests) Descriptor() ([]byte, []int)Deprecated: Use CreateInstanceRequests.ProtoReflect.Descriptor instead.
func (*CreateInstanceRequests) GetCreateInstanceRequests
func (x *CreateInstanceRequests) GetCreateInstanceRequests() []*CreateInstanceRequestfunc (*CreateInstanceRequests) ProtoMessage
func (*CreateInstanceRequests) ProtoMessage()func (*CreateInstanceRequests) ProtoReflect
func (x *CreateInstanceRequests) ProtoReflect() protoreflect.Messagefunc (*CreateInstanceRequests) Reset
func (x *CreateInstanceRequests) Reset()func (*CreateInstanceRequests) String
func (x *CreateInstanceRequests) String() stringCreateSecondaryClusterRequest
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
func (*CreateSecondaryClusterRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateSecondaryClusterRequest.ProtoReflect.Descriptor instead.
func (*CreateSecondaryClusterRequest) GetCluster
func (x *CreateSecondaryClusterRequest) GetCluster() *Clusterfunc (*CreateSecondaryClusterRequest) GetClusterId
func (x *CreateSecondaryClusterRequest) GetClusterId() stringfunc (*CreateSecondaryClusterRequest) GetParent
func (x *CreateSecondaryClusterRequest) GetParent() stringfunc (*CreateSecondaryClusterRequest) GetRequestId
func (x *CreateSecondaryClusterRequest) GetRequestId() stringfunc (*CreateSecondaryClusterRequest) GetValidateOnly
func (x *CreateSecondaryClusterRequest) GetValidateOnly() boolfunc (*CreateSecondaryClusterRequest) ProtoMessage
func (*CreateSecondaryClusterRequest) ProtoMessage()func (*CreateSecondaryClusterRequest) ProtoReflect
func (x *CreateSecondaryClusterRequest) ProtoReflect() protoreflect.Messagefunc (*CreateSecondaryClusterRequest) Reset
func (x *CreateSecondaryClusterRequest) Reset()func (*CreateSecondaryClusterRequest) String
func (x *CreateSecondaryClusterRequest) String() stringCreateSecondaryInstanceRequest
type CreateSecondaryInstanceRequest struct {
// Required. The name of the parent resource. For the required format, see the
// comment on the Instance.name field.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. ID of the requesting object.
InstanceId string `protobuf:"bytes,2,opt,name=instance_id,json=instanceId,proto3" json:"instance_id,omitempty"`
// Required. The resource being created
Instance *Instance `protobuf:"bytes,3,opt,name=instance,proto3" json:"instance,omitempty"`
// Optional. An optional request ID to identify requests. Specify a unique
// request ID so that if you must retry your request, the server will know to
// ignore the request if it has already been completed. The server will
// guarantee that for at least 60 minutes since the first request.
//
// For example, consider a situation where you make an initial request and
// the request times out. If you make the request again with the same request
// ID, the server can check if original operation with the same request ID
// was received, and if so, will ignore the second request. This prevents
// clients from accidentally creating duplicate commitments.
//
// The request ID must be a valid UUID with the exception that zero UUID is
// not supported (00000000-0000-0000-0000-000000000000).
RequestId string `protobuf:"bytes,4,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
// Optional. If set, performs request validation (e.g. permission checks and
// any other type of validation), but do not actually execute the create
// request.
ValidateOnly bool `protobuf:"varint,5,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
// contains filtered or unexported fields
}Message for creating a Secondary Instance
func (*CreateSecondaryInstanceRequest) Descriptor
func (*CreateSecondaryInstanceRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateSecondaryInstanceRequest.ProtoReflect.Descriptor instead.
func (*CreateSecondaryInstanceRequest) GetInstance
func (x *CreateSecondaryInstanceRequest) GetInstance() *Instancefunc (*CreateSecondaryInstanceRequest) GetInstanceId
func (x *CreateSecondaryInstanceRequest) GetInstanceId() stringfunc (*CreateSecondaryInstanceRequest) GetParent
func (x *CreateSecondaryInstanceRequest) GetParent() stringfunc (*CreateSecondaryInstanceRequest) GetRequestId
func (x *CreateSecondaryInstanceRequest) GetRequestId() stringfunc (*CreateSecondaryInstanceRequest) GetValidateOnly
func (x *CreateSecondaryInstanceRequest) GetValidateOnly() boolfunc (*CreateSecondaryInstanceRequest) ProtoMessage
func (*CreateSecondaryInstanceRequest) ProtoMessage()func (*CreateSecondaryInstanceRequest) ProtoReflect
func (x *CreateSecondaryInstanceRequest) ProtoReflect() protoreflect.Messagefunc (*CreateSecondaryInstanceRequest) Reset
func (x *CreateSecondaryInstanceRequest) Reset()func (*CreateSecondaryInstanceRequest) String
func (x *CreateSecondaryInstanceRequest) String() stringCreateUserRequest
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
func (*CreateUserRequest) Descriptor() ([]byte, []int)Deprecated: Use CreateUserRequest.ProtoReflect.Descriptor instead.
func (*CreateUserRequest) GetParent
func (x *CreateUserRequest) GetParent() stringfunc (*CreateUserRequest) GetRequestId
func (x *CreateUserRequest) GetRequestId() stringfunc (*CreateUserRequest) GetUser
func (x *CreateUserRequest) GetUser() *Userfunc (*CreateUserRequest) GetUserId
func (x *CreateUserRequest) GetUserId() stringfunc (*CreateUserRequest) GetValidateOnly
func (x *CreateUserRequest) GetValidateOnly() boolfunc (*CreateUserRequest) ProtoMessage
func (*CreateUserRequest) ProtoMessage()func (*CreateUserRequest) ProtoReflect
func (x *CreateUserRequest) ProtoReflect() protoreflect.Messagefunc (*CreateUserRequest) Reset
func (x *CreateUserRequest) Reset()func (*CreateUserRequest) String
func (x *CreateUserRequest) String() stringDatabaseVersion
type DatabaseVersion int32The supported database engine versions.
DatabaseVersion_DATABASE_VERSION_UNSPECIFIED, DatabaseVersion_POSTGRES_13, DatabaseVersion_POSTGRES_14
const (
// This is an unknown database version.
DatabaseVersion_DATABASE_VERSION_UNSPECIFIED DatabaseVersion = 0
// DEPRECATED - The database version is Postgres 13.
//
// Deprecated: 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
)func (DatabaseVersion) Descriptor
func (DatabaseVersion) Descriptor() protoreflect.EnumDescriptorfunc (DatabaseVersion) Enum
func (x DatabaseVersion) Enum() *DatabaseVersionfunc (DatabaseVersion) EnumDescriptor
func (DatabaseVersion) EnumDescriptor() ([]byte, []int)Deprecated: Use DatabaseVersion.Descriptor instead.
func (DatabaseVersion) Number
func (x DatabaseVersion) Number() protoreflect.EnumNumberfunc (DatabaseVersion) String
func (x DatabaseVersion) String() stringfunc (DatabaseVersion) Type
func (DatabaseVersion) Type() protoreflect.EnumTypeDeleteBackupRequest
type DeleteBackupRequest struct {
// Required. Name of the resource. For the required format, see the comment on
// the Backup.name field.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. An optional request ID to identify requests. Specify a unique
// request ID so that if you must retry your request, the server will know to
// ignore the request if it has already been completed. The server will
// guarantee that for at least 60 minutes after the first request.
//
// For example, consider a situation where you make an initial request and
// the request times out. If you make the request again with the same request
// ID, the server can check if original operation with the same request ID
// was received, and if so, will ignore the second request. This prevents
// clients from accidentally creating duplicate commitments.
//
// The request ID must be a valid UUID with the exception that zero UUID is
// not supported (00000000-0000-0000-0000-000000000000).
RequestId string `protobuf:"bytes,2,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
// Optional. If set, the backend validates the request, but doesn't actually
// execute it.
ValidateOnly bool `protobuf:"varint,3,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
// Optional. The current etag of the Backup.
// If an etag is provided and does not match the current etag of the Backup,
// deletion will be blocked and an ABORTED error will be returned.
Etag string `protobuf:"bytes,4,opt,name=etag,proto3" json:"etag,omitempty"`
// contains filtered or unexported fields
}Message for deleting a Backup
func (*DeleteBackupRequest) Descriptor
func (*DeleteBackupRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteBackupRequest.ProtoReflect.Descriptor instead.
func (*DeleteBackupRequest) GetEtag
func (x *DeleteBackupRequest) GetEtag() stringfunc (*DeleteBackupRequest) GetName
func (x *DeleteBackupRequest) GetName() stringfunc (*DeleteBackupRequest) GetRequestId
func (x *DeleteBackupRequest) GetRequestId() stringfunc (*DeleteBackupRequest) GetValidateOnly
func (x *DeleteBackupRequest) GetValidateOnly() boolfunc (*DeleteBackupRequest) ProtoMessage
func (*DeleteBackupRequest) ProtoMessage()func (*DeleteBackupRequest) ProtoReflect
func (x *DeleteBackupRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteBackupRequest) Reset
func (x *DeleteBackupRequest) Reset()func (*DeleteBackupRequest) String
func (x *DeleteBackupRequest) String() stringDeleteClusterRequest
type DeleteClusterRequest struct {
// Required. The name of the resource. For the required format, see the
// comment on the Cluster.name field.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. An optional request ID to identify requests. Specify a unique
// request ID so that if you must retry your request, the server will know to
// ignore the request if it has already been completed. The server will
// guarantee that for at least 60 minutes after the first request.
//
// For example, consider a situation where you make an initial request and
// the request times out. If you make the request again with the same request
// ID, the server can check if original operation with the same request ID
// was received, and if so, will ignore the second request. This prevents
// clients from accidentally creating duplicate commitments.
//
// The request ID must be a valid UUID with the exception that zero UUID is
// not supported (00000000-0000-0000-0000-000000000000).
RequestId string `protobuf:"bytes,2,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
// Optional. The current etag of the Cluster.
// If an etag is provided and does not match the current etag of the Cluster,
// deletion will be blocked and an ABORTED error will be returned.
Etag string `protobuf:"bytes,3,opt,name=etag,proto3" json:"etag,omitempty"`
// Optional. If set, performs request validation (e.g. permission checks and
// any other type of validation), but do not actually execute the delete.
ValidateOnly bool `protobuf:"varint,4,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
// Optional. Whether to cascade delete child instances for given cluster.
Force bool `protobuf:"varint,5,opt,name=force,proto3" json:"force,omitempty"`
// contains filtered or unexported fields
}Message for deleting a Cluster
func (*DeleteClusterRequest) Descriptor
func (*DeleteClusterRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteClusterRequest.ProtoReflect.Descriptor instead.
func (*DeleteClusterRequest) GetEtag
func (x *DeleteClusterRequest) GetEtag() stringfunc (*DeleteClusterRequest) GetForce
func (x *DeleteClusterRequest) GetForce() boolfunc (*DeleteClusterRequest) GetName
func (x *DeleteClusterRequest) GetName() stringfunc (*DeleteClusterRequest) GetRequestId
func (x *DeleteClusterRequest) GetRequestId() stringfunc (*DeleteClusterRequest) GetValidateOnly
func (x *DeleteClusterRequest) GetValidateOnly() boolfunc (*DeleteClusterRequest) ProtoMessage
func (*DeleteClusterRequest) ProtoMessage()func (*DeleteClusterRequest) ProtoReflect
func (x *DeleteClusterRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteClusterRequest) Reset
func (x *DeleteClusterRequest) Reset()func (*DeleteClusterRequest) String
func (x *DeleteClusterRequest) String() stringDeleteInstanceRequest
type DeleteInstanceRequest struct {
// Required. The name of the resource. For the required format, see the
// comment on the Instance.name field.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. An optional request ID to identify requests. Specify a unique
// request ID so that if you must retry your request, the server will know to
// ignore the request if it has already been completed. The server will
// guarantee that for at least 60 minutes after the first request.
//
// For example, consider a situation where you make an initial request and
// the request times out. If you make the request again with the same request
// ID, the server can check if original operation with the same request ID
// was received, and if so, will ignore the second request. This prevents
// clients from accidentally creating duplicate commitments.
//
// The request ID must be a valid UUID with the exception that zero UUID is
// not supported (00000000-0000-0000-0000-000000000000).
RequestId string `protobuf:"bytes,2,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
// Optional. The current etag of the Instance.
// If an etag is provided and does not match the current etag of the Instance,
// deletion will be blocked and an ABORTED error will be returned.
Etag string `protobuf:"bytes,3,opt,name=etag,proto3" json:"etag,omitempty"`
// Optional. If set, performs request validation (e.g. permission checks and
// any other type of validation), but do not actually execute the delete.
ValidateOnly bool `protobuf:"varint,4,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
// contains filtered or unexported fields
}Message for deleting a Instance
func (*DeleteInstanceRequest) Descriptor
func (*DeleteInstanceRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteInstanceRequest.ProtoReflect.Descriptor instead.
func (*DeleteInstanceRequest) GetEtag
func (x *DeleteInstanceRequest) GetEtag() stringfunc (*DeleteInstanceRequest) GetName
func (x *DeleteInstanceRequest) GetName() stringfunc (*DeleteInstanceRequest) GetRequestId
func (x *DeleteInstanceRequest) GetRequestId() stringfunc (*DeleteInstanceRequest) GetValidateOnly
func (x *DeleteInstanceRequest) GetValidateOnly() boolfunc (*DeleteInstanceRequest) ProtoMessage
func (*DeleteInstanceRequest) ProtoMessage()func (*DeleteInstanceRequest) ProtoReflect
func (x *DeleteInstanceRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteInstanceRequest) Reset
func (x *DeleteInstanceRequest) Reset()func (*DeleteInstanceRequest) String
func (x *DeleteInstanceRequest) String() stringDeleteUserRequest
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
func (*DeleteUserRequest) Descriptor() ([]byte, []int)Deprecated: Use DeleteUserRequest.ProtoReflect.Descriptor instead.
func (*DeleteUserRequest) GetName
func (x *DeleteUserRequest) GetName() stringfunc (*DeleteUserRequest) GetRequestId
func (x *DeleteUserRequest) GetRequestId() stringfunc (*DeleteUserRequest) GetValidateOnly
func (x *DeleteUserRequest) GetValidateOnly() boolfunc (*DeleteUserRequest) ProtoMessage
func (*DeleteUserRequest) ProtoMessage()func (*DeleteUserRequest) ProtoReflect
func (x *DeleteUserRequest) ProtoReflect() protoreflect.Messagefunc (*DeleteUserRequest) Reset
func (x *DeleteUserRequest) Reset()func (*DeleteUserRequest) String
func (x *DeleteUserRequest) String() stringEncryptionConfig
type EncryptionConfig struct {
// The fully-qualified resource name of the KMS key.
// Each Cloud KMS key is regionalized and has the following format:
// projects/[PROJECT]/locations/[REGION]/keyRings/[RING]/cryptoKeys/[KEY_NAME]
KmsKeyName string `protobuf:"bytes,1,opt,name=kms_key_name,json=kmsKeyName,proto3" json:"kms_key_name,omitempty"`
// contains filtered or unexported fields
}EncryptionConfig describes the encryption config of a cluster or a backup that is encrypted with a CMEK (customer-managed encryption key).
func (*EncryptionConfig) Descriptor
func (*EncryptionConfig) Descriptor() ([]byte, []int)Deprecated: Use EncryptionConfig.ProtoReflect.Descriptor instead.
func (*EncryptionConfig) GetKmsKeyName
func (x *EncryptionConfig) GetKmsKeyName() stringfunc (*EncryptionConfig) ProtoMessage
func (*EncryptionConfig) ProtoMessage()func (*EncryptionConfig) ProtoReflect
func (x *EncryptionConfig) ProtoReflect() protoreflect.Messagefunc (*EncryptionConfig) Reset
func (x *EncryptionConfig) Reset()func (*EncryptionConfig) String
func (x *EncryptionConfig) String() stringEncryptionInfo
type EncryptionInfo struct {
EncryptionType EncryptionInfo_Type "" /* 157 byte string literal not displayed */
KmsKeyVersions []string `protobuf:"bytes,2,rep,name=kms_key_versions,json=kmsKeyVersions,proto3" json:"kms_key_versions,omitempty"`
}EncryptionInfo describes the encryption information of a cluster or a backup.
func (*EncryptionInfo) Descriptor
func (*EncryptionInfo) Descriptor() ([]byte, []int)Deprecated: Use EncryptionInfo.ProtoReflect.Descriptor instead.
func (*EncryptionInfo) GetEncryptionType
func (x *EncryptionInfo) GetEncryptionType() EncryptionInfo_Typefunc (*EncryptionInfo) GetKmsKeyVersions
func (x *EncryptionInfo) GetKmsKeyVersions() []stringfunc (*EncryptionInfo) ProtoMessage
func (*EncryptionInfo) ProtoMessage()func (*EncryptionInfo) ProtoReflect
func (x *EncryptionInfo) ProtoReflect() protoreflect.Messagefunc (*EncryptionInfo) Reset
func (x *EncryptionInfo) Reset()func (*EncryptionInfo) String
func (x *EncryptionInfo) String() stringEncryptionInfo_Type
type EncryptionInfo_Type int32Possible encryption types.
EncryptionInfo_TYPE_UNSPECIFIED, EncryptionInfo_GOOGLE_DEFAULT_ENCRYPTION, EncryptionInfo_CUSTOMER_MANAGED_ENCRYPTION
const (
// Encryption type not specified. Defaults to GOOGLE_DEFAULT_ENCRYPTION.
EncryptionInfo_TYPE_UNSPECIFIED EncryptionInfo_Type = 0
// The data is encrypted at rest with a key that is fully managed by Google.
// No key version will be populated. This is the default state.
EncryptionInfo_GOOGLE_DEFAULT_ENCRYPTION EncryptionInfo_Type = 1
// The data is encrypted at rest with a key that is managed by the customer.
// KMS key versions will be populated.
EncryptionInfo_CUSTOMER_MANAGED_ENCRYPTION EncryptionInfo_Type = 2
)func (EncryptionInfo_Type) Descriptor
func (EncryptionInfo_Type) Descriptor() protoreflect.EnumDescriptorfunc (EncryptionInfo_Type) Enum
func (x EncryptionInfo_Type) Enum() *EncryptionInfo_Typefunc (EncryptionInfo_Type) EnumDescriptor
func (EncryptionInfo_Type) EnumDescriptor() ([]byte, []int)Deprecated: Use EncryptionInfo_Type.Descriptor instead.
func (EncryptionInfo_Type) Number
func (x EncryptionInfo_Type) Number() protoreflect.EnumNumberfunc (EncryptionInfo_Type) String
func (x EncryptionInfo_Type) String() stringfunc (EncryptionInfo_Type) Type
func (EncryptionInfo_Type) Type() protoreflect.EnumTypeFailoverInstanceRequest
type FailoverInstanceRequest struct {
// Required. The name of the resource. For the required format, see the
// comment on the Instance.name field.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. An optional request ID to identify requests. Specify a unique
// request ID so that if you must retry your request, the server will know to
// ignore the request if it has already been completed. The server will
// guarantee that for at least 60 minutes after the first request.
//
// For example, consider a situation where you make an initial request and
// the request times out. If you make the request again with the same request
// ID, the server can check if original operation with the same request ID
// was received, and if so, will ignore the second request. This prevents
// clients from accidentally creating duplicate commitments.
//
// The request ID must be a valid UUID with the exception that zero UUID is
// not supported (00000000-0000-0000-0000-000000000000).
RequestId string `protobuf:"bytes,2,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
// Optional. If set, performs request validation (e.g. permission checks and
// any other type of validation), but do not actually execute the failover.
ValidateOnly bool `protobuf:"varint,3,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
// contains filtered or unexported fields
}Message for triggering failover on an Instance
func (*FailoverInstanceRequest) Descriptor
func (*FailoverInstanceRequest) Descriptor() ([]byte, []int)Deprecated: Use FailoverInstanceRequest.ProtoReflect.Descriptor instead.
func (*FailoverInstanceRequest) GetName
func (x *FailoverInstanceRequest) GetName() stringfunc (*FailoverInstanceRequest) GetRequestId
func (x *FailoverInstanceRequest) GetRequestId() stringfunc (*FailoverInstanceRequest) GetValidateOnly
func (x *FailoverInstanceRequest) GetValidateOnly() boolfunc (*FailoverInstanceRequest) ProtoMessage
func (*FailoverInstanceRequest) ProtoMessage()func (*FailoverInstanceRequest) ProtoReflect
func (x *FailoverInstanceRequest) ProtoReflect() protoreflect.Messagefunc (*FailoverInstanceRequest) Reset
func (x *FailoverInstanceRequest) Reset()func (*FailoverInstanceRequest) String
func (x *FailoverInstanceRequest) String() stringGenerateClientCertificateRequest
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).
//
// 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"`
// contains filtered or unexported fields
}Message for requests to generate a client certificate signed by the Cluster CA.
func (*GenerateClientCertificateRequest) Descriptor
func (*GenerateClientCertificateRequest) Descriptor() ([]byte, []int)Deprecated: Use GenerateClientCertificateRequest.ProtoReflect.Descriptor instead.
func (*GenerateClientCertificateRequest) GetCertDuration
func (x *GenerateClientCertificateRequest) GetCertDuration() *durationpb.Durationfunc (*GenerateClientCertificateRequest) GetParent
func (x *GenerateClientCertificateRequest) GetParent() stringfunc (*GenerateClientCertificateRequest) GetPemCsr
func (x *GenerateClientCertificateRequest) GetPemCsr() stringDeprecated: Marked as deprecated in google/cloud/alloydb/v1beta/service.proto.
func (*GenerateClientCertificateRequest) GetPublicKey
func (x *GenerateClientCertificateRequest) GetPublicKey() stringfunc (*GenerateClientCertificateRequest) GetRequestId
func (x *GenerateClientCertificateRequest) GetRequestId() stringfunc (*GenerateClientCertificateRequest) ProtoMessage
func (*GenerateClientCertificateRequest) ProtoMessage()func (*GenerateClientCertificateRequest) ProtoReflect
func (x *GenerateClientCertificateRequest) ProtoReflect() protoreflect.Messagefunc (*GenerateClientCertificateRequest) Reset
func (x *GenerateClientCertificateRequest) Reset()func (*GenerateClientCertificateRequest) String
func (x *GenerateClientCertificateRequest) String() stringGenerateClientCertificateResponse
type GenerateClientCertificateResponse struct {
// Output only. The pem-encoded, signed X.509 certificate.
PemCertificate string `protobuf:"bytes,1,opt,name=pem_certificate,json=pemCertificate,proto3" json:"pem_certificate,omitempty"`
// Output only. The pem-encoded chain that may be used to verify the X.509
// certificate. Expected to be in issuer-to-root order according to RFC 5246.
PemCertificateChain []string `protobuf:"bytes,2,rep,name=pem_certificate_chain,json=pemCertificateChain,proto3" json:"pem_certificate_chain,omitempty"`
// 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
func (*GenerateClientCertificateResponse) Descriptor() ([]byte, []int)Deprecated: Use GenerateClientCertificateResponse.ProtoReflect.Descriptor instead.
func (*GenerateClientCertificateResponse) GetCaCert
func (x *GenerateClientCertificateResponse) GetCaCert() stringfunc (*GenerateClientCertificateResponse) GetPemCertificate
func (x *GenerateClientCertificateResponse) GetPemCertificate() stringfunc (*GenerateClientCertificateResponse) GetPemCertificateChain
func (x *GenerateClientCertificateResponse) GetPemCertificateChain() []stringfunc (*GenerateClientCertificateResponse) ProtoMessage
func (*GenerateClientCertificateResponse) ProtoMessage()func (*GenerateClientCertificateResponse) ProtoReflect
func (x *GenerateClientCertificateResponse) ProtoReflect() protoreflect.Messagefunc (*GenerateClientCertificateResponse) Reset
func (x *GenerateClientCertificateResponse) Reset()func (*GenerateClientCertificateResponse) String
func (x *GenerateClientCertificateResponse) String() stringGetBackupRequest
type GetBackupRequest struct {
// Required. Name of the resource
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}Message for getting a Backup
func (*GetBackupRequest) Descriptor
func (*GetBackupRequest) Descriptor() ([]byte, []int)Deprecated: Use GetBackupRequest.ProtoReflect.Descriptor instead.
func (*GetBackupRequest) GetName
func (x *GetBackupRequest) GetName() stringfunc (*GetBackupRequest) ProtoMessage
func (*GetBackupRequest) ProtoMessage()func (*GetBackupRequest) ProtoReflect
func (x *GetBackupRequest) ProtoReflect() protoreflect.Messagefunc (*GetBackupRequest) Reset
func (x *GetBackupRequest) Reset()func (*GetBackupRequest) String
func (x *GetBackupRequest) String() stringGetClusterRequest
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
func (*GetClusterRequest) Descriptor() ([]byte, []int)Deprecated: Use GetClusterRequest.ProtoReflect.Descriptor instead.
func (*GetClusterRequest) GetName
func (x *GetClusterRequest) GetName() stringfunc (*GetClusterRequest) GetView
func (x *GetClusterRequest) GetView() ClusterViewfunc (*GetClusterRequest) ProtoMessage
func (*GetClusterRequest) ProtoMessage()func (*GetClusterRequest) ProtoReflect
func (x *GetClusterRequest) ProtoReflect() protoreflect.Messagefunc (*GetClusterRequest) Reset
func (x *GetClusterRequest) Reset()func (*GetClusterRequest) String
func (x *GetClusterRequest) String() stringGetConnectionInfoRequest
type GetConnectionInfoRequest struct {
// Required. The name of the parent resource. The required format is:
// projects/{project}/locations/{location}/clusters/{cluster}/instances/{instance}
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Optional. An optional request ID to identify requests. Specify a unique
// request ID so that if you must retry your request, the server will know to
// ignore the request if it has already been completed. The server will
// guarantee that for at least 60 minutes after the first request.
//
// For example, consider a situation where you make an initial request and
// the request times out. If you make the request again with the same request
// ID, the server can check if original operation with the same request ID
// was received, and if so, will ignore the second request. This prevents
// clients from accidentally creating duplicate commitments.
//
// The request ID must be a valid UUID with the exception that zero UUID is
// not supported (00000000-0000-0000-0000-000000000000).
RequestId string `protobuf:"bytes,2,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
// contains filtered or unexported fields
}Request message for GetConnectionInfo.
func (*GetConnectionInfoRequest) Descriptor
func (*GetConnectionInfoRequest) Descriptor() ([]byte, []int)Deprecated: Use GetConnectionInfoRequest.ProtoReflect.Descriptor instead.
func (*GetConnectionInfoRequest) GetParent
func (x *GetConnectionInfoRequest) GetParent() stringfunc (*GetConnectionInfoRequest) GetRequestId
func (x *GetConnectionInfoRequest) GetRequestId() stringfunc (*GetConnectionInfoRequest) ProtoMessage
func (*GetConnectionInfoRequest) ProtoMessage()func (*GetConnectionInfoRequest) ProtoReflect
func (x *GetConnectionInfoRequest) ProtoReflect() protoreflect.Messagefunc (*GetConnectionInfoRequest) Reset
func (x *GetConnectionInfoRequest) Reset()func (*GetConnectionInfoRequest) String
func (x *GetConnectionInfoRequest) String() stringGetInstanceRequest
type GetInstanceRequest struct {
// Required. The name of the resource. For the required format, see the
// comment on the Instance.name field.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// The view of the instance to return.
View InstanceView `protobuf:"varint,2,opt,name=view,proto3,enum=google.cloud.alloydb.v1beta.InstanceView" json:"view,omitempty"`
// contains filtered or unexported fields
}Message for getting a Instance
func (*GetInstanceRequest) Descriptor
func (*GetInstanceRequest) Descriptor() ([]byte, []int)Deprecated: Use GetInstanceRequest.ProtoReflect.Descriptor instead.
func (*GetInstanceRequest) GetName
func (x *GetInstanceRequest) GetName() stringfunc (*GetInstanceRequest) GetView
func (x *GetInstanceRequest) GetView() InstanceViewfunc (*GetInstanceRequest) ProtoMessage
func (*GetInstanceRequest) ProtoMessage()func (*GetInstanceRequest) ProtoReflect
func (x *GetInstanceRequest) ProtoReflect() protoreflect.Messagefunc (*GetInstanceRequest) Reset
func (x *GetInstanceRequest) Reset()func (*GetInstanceRequest) String
func (x *GetInstanceRequest) String() stringGetUserRequest
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
func (*GetUserRequest) Descriptor() ([]byte, []int)Deprecated: Use GetUserRequest.ProtoReflect.Descriptor instead.
func (*GetUserRequest) GetName
func (x *GetUserRequest) GetName() stringfunc (*GetUserRequest) ProtoMessage
func (*GetUserRequest) ProtoMessage()func (*GetUserRequest) ProtoReflect
func (x *GetUserRequest) ProtoReflect() protoreflect.Messagefunc (*GetUserRequest) Reset
func (x *GetUserRequest) Reset()func (*GetUserRequest) String
func (x *GetUserRequest) String() stringInjectFaultRequest
type InjectFaultRequest struct {
FaultType InjectFaultRequest_FaultType "" /* 151 byte string literal not displayed */
Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
RequestId string `protobuf:"bytes,3,opt,name=request_id,json=requestId,proto3" json:"request_id,omitempty"`
ValidateOnly bool `protobuf:"varint,4,opt,name=validate_only,json=validateOnly,proto3" json:"validate_only,omitempty"`
}Message for triggering fault injection on an instance
func (*InjectFaultRequest) Descriptor
func (*InjectFaultRequest) Descriptor() ([]byte, []int)Deprecated: Use InjectFaultRequest.ProtoReflect.Descriptor instead.
func (*InjectFaultRequest) GetFaultType
func (x *InjectFaultRequest) GetFaultType() InjectFaultRequest_FaultTypefunc (*InjectFaultRequest) GetName
func (x *InjectFaultRequest) GetName() stringfunc (*InjectFaultRequest) GetRequestId
func (x *InjectFaultRequest) GetRequestId() stringfunc (*InjectFaultRequest) GetValidateOnly
func (x *InjectFaultRequest) GetValidateOnly() boolfunc (*InjectFaultRequest) ProtoMessage
func (*InjectFaultRequest) ProtoMessage()func (*InjectFaultRequest) ProtoReflect
func (x *InjectFaultRequest) ProtoReflect() protoreflect.Messagefunc (*InjectFaultRequest) Reset
func (x *InjectFaultRequest) Reset()func (*InjectFaultRequest) String
func (x *InjectFaultRequest) String() stringInjectFaultRequest_FaultType
type InjectFaultRequest_FaultType int32FaultType contains all valid types of faults that can be injected to an instance.
InjectFaultRequest_FAULT_TYPE_UNSPECIFIED, InjectFaultRequest_STOP_VM
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
func (InjectFaultRequest_FaultType) Descriptor() protoreflect.EnumDescriptorfunc (InjectFaultRequest_FaultType) Enum
func (x InjectFaultRequest_FaultType) Enum() *InjectFaultRequest_FaultTypefunc (InjectFaultRequest_FaultType) EnumDescriptor
func (InjectFaultRequest_FaultType) EnumDescriptor() ([]byte, []int)Deprecated: Use InjectFaultRequest_FaultType.Descriptor instead.
func (InjectFaultRequest_FaultType) Number
func (x InjectFaultRequest_FaultType) Number() protoreflect.EnumNumberfunc (InjectFaultRequest_FaultType) String
func (x InjectFaultRequest_FaultType) String() stringfunc (InjectFaultRequest_FaultType) Type
func (InjectFaultRequest_FaultType) Type() protoreflect.EnumTypeInstance
type Instance struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
Uid string `protobuf:"bytes,3,opt,name=uid,proto3" json:"uid,omitempty"`
CreateTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
UpdateTime *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
DeleteTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=delete_time,json=deleteTime,proto3" json:"delete_time,omitempty"`
Labels map[string]string "" /* 153 byte string literal not displayed */
State Instance_State `protobuf:"varint,8,opt,name=state,proto3,enum=google.cloud.alloydb.v1beta.Instance_State" json:"state,omitempty"`
InstanceType Instance_InstanceType "" /* 153 byte string literal not displayed */
MachineConfig *Instance_MachineConfig `protobuf:"bytes,10,opt,name=machine_config,json=machineConfig,proto3" json:"machine_config,omitempty"`
AvailabilityType Instance_AvailabilityType "" /* 170 byte string literal not displayed */
GceZone string `protobuf:"bytes,12,opt,name=gce_zone,json=gceZone,proto3" json:"gce_zone,omitempty"`
DatabaseFlags map[string]string "" /* 189 byte string literal not displayed */
WritableNode *Instance_Node `protobuf:"bytes,19,opt,name=writable_node,json=writableNode,proto3" json:"writable_node,omitempty"`
Nodes []*Instance_Node `protobuf:"bytes,20,rep,name=nodes,proto3" json:"nodes,omitempty"`
QueryInsightsConfig *Instance_QueryInsightsInstanceConfig `protobuf:"bytes,21,opt,name=query_insights_config,json=queryInsightsConfig,proto3" json:"query_insights_config,omitempty"`
ReadPoolConfig *Instance_ReadPoolConfig `protobuf:"bytes,14,opt,name=read_pool_config,json=readPoolConfig,proto3" json:"read_pool_config,omitempty"`
IpAddress string `protobuf:"bytes,15,opt,name=ip_address,json=ipAddress,proto3" json:"ip_address,omitempty"`
Reconciling bool `protobuf:"varint,16,opt,name=reconciling,proto3" json:"reconciling,omitempty"`
Etag string `protobuf:"bytes,17,opt,name=etag,proto3" json:"etag,omitempty"`
Annotations map[string]string "" /* 164 byte string literal not displayed */
UpdatePolicy *Instance_UpdatePolicy `protobuf:"bytes,22,opt,name=update_policy,json=updatePolicy,proto3" json:"update_policy,omitempty"`
}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: Use Instance.ProtoReflect.Descriptor instead.
func (*Instance) GetAnnotations
func (*Instance) GetAvailabilityType
func (x *Instance) GetAvailabilityType() Instance_AvailabilityTypefunc (*Instance) GetCreateTime
func (x *Instance) GetCreateTime() *timestamppb.Timestampfunc (*Instance) GetDatabaseFlags
func (*Instance) GetDeleteTime
func (x *Instance) GetDeleteTime() *timestamppb.Timestampfunc (*Instance) GetDisplayName
func (*Instance) GetEtag
func (*Instance) GetGceZone
func (*Instance) GetInstanceType
func (x *Instance) GetInstanceType() Instance_InstanceTypefunc (*Instance) GetIpAddress
func (*Instance) GetLabels
func (*Instance) GetMachineConfig
func (x *Instance) GetMachineConfig() *Instance_MachineConfigfunc (*Instance) GetName
func (*Instance) GetNodes
func (x *Instance) GetNodes() []*Instance_Nodefunc (*Instance) GetQueryInsightsConfig
func (x *Instance) GetQueryInsightsConfig() *Instance_QueryInsightsInstanceConfigfunc (*Instance) GetReadPoolConfig
func (x *Instance) GetReadPoolConfig() *Instance_ReadPoolConfigfunc (*Instance) GetReconciling
func (*Instance) GetState
func (x *Instance) GetState() Instance_Statefunc (*Instance) GetUid
func (*Instance) GetUpdatePolicy
func (x *Instance) GetUpdatePolicy() *Instance_UpdatePolicyfunc (*Instance) GetUpdateTime
func (x *Instance) GetUpdateTime() *timestamppb.Timestampfunc (*Instance) GetWritableNode
func (x *Instance) GetWritableNode() *Instance_Nodefunc (*Instance) ProtoMessage
func (*Instance) ProtoMessage()func (*Instance) ProtoReflect
func (x *Instance) ProtoReflect() protoreflect.Messagefunc (*Instance) Reset
func (x *Instance) Reset()func (*Instance) String
InstanceView
type InstanceView int32View on Instance. Pass this enum to rpcs that returns an Instance message to control which subsets of fields to get.
InstanceView_INSTANCE_VIEW_UNSPECIFIED, InstanceView_INSTANCE_VIEW_BASIC, InstanceView_INSTANCE_VIEW_FULL
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) Descriptor() protoreflect.EnumDescriptorfunc (InstanceView) Enum
func (x InstanceView) Enum() *InstanceViewfunc (InstanceView) EnumDescriptor
func (InstanceView) EnumDescriptor() ([]byte, []int)Deprecated: Use InstanceView.Descriptor instead.
func (InstanceView) Number
func (x InstanceView) Number() protoreflect.EnumNumberfunc (InstanceView) String
func (x InstanceView) String() stringfunc (InstanceView) Type
func (InstanceView) Type() protoreflect.EnumTypeInstance_AvailabilityType
type Instance_AvailabilityType int32The 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).
Instance_AVAILABILITY_TYPE_UNSPECIFIED, Instance_ZONAL, Instance_REGIONAL
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) Descriptor() protoreflect.EnumDescriptorfunc (Instance_AvailabilityType) Enum
func (x Instance_AvailabilityType) Enum() *Instance_AvailabilityTypefunc (Instance_AvailabilityType) EnumDescriptor
func (Instance_AvailabilityType) EnumDescriptor() ([]byte, []int)Deprecated: Use Instance_AvailabilityType.Descriptor instead.
func (Instance_AvailabilityType) Number
func (x Instance_AvailabilityType) Number() protoreflect.EnumNumberfunc (Instance_AvailabilityType) String
func (x Instance_AvailabilityType) String() stringfunc (Instance_AvailabilityType) Type
func (Instance_AvailabilityType) Type() protoreflect.EnumTypeInstance_InstanceType
type Instance_InstanceType int32Type of an Instance
Instance_INSTANCE_TYPE_UNSPECIFIED, Instance_PRIMARY, Instance_READ_POOL, Instance_SECONDARY
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) Descriptor() protoreflect.EnumDescriptorfunc (Instance_InstanceType) Enum
func (x Instance_InstanceType) Enum() *Instance_InstanceTypefunc (Instance_InstanceType) EnumDescriptor
func (Instance_InstanceType) EnumDescriptor() ([]byte, []int)Deprecated: Use Instance_InstanceType.Descriptor instead.
func (Instance_InstanceType) Number
func (x Instance_InstanceType) Number() protoreflect.EnumNumberfunc (Instance_InstanceType) String
func (x Instance_InstanceType) String() stringfunc (Instance_InstanceType) Type
func (Instance_InstanceType) Type() protoreflect.EnumTypeInstance_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
func (*Instance_MachineConfig) Descriptor() ([]byte, []int)Deprecated: Use Instance_MachineConfig.ProtoReflect.Descriptor instead.
func (*Instance_MachineConfig) GetCpuCount
func (x *Instance_MachineConfig) GetCpuCount() int32func (*Instance_MachineConfig) ProtoMessage
func (*Instance_MachineConfig) ProtoMessage()func (*Instance_MachineConfig) ProtoReflect
func (x *Instance_MachineConfig) ProtoReflect() protoreflect.Messagefunc (*Instance_MachineConfig) Reset
func (x *Instance_MachineConfig) Reset()func (*Instance_MachineConfig) String
func (x *Instance_MachineConfig) String() stringInstance_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
func (*Instance_Node) Descriptor() ([]byte, []int)Deprecated: Use Instance_Node.ProtoReflect.Descriptor instead.
func (*Instance_Node) GetId
func (x *Instance_Node) GetId() stringfunc (*Instance_Node) GetIp
func (x *Instance_Node) GetIp() stringfunc (*Instance_Node) GetState
func (x *Instance_Node) GetState() stringfunc (*Instance_Node) GetZoneId
func (x *Instance_Node) GetZoneId() stringfunc (*Instance_Node) ProtoMessage
func (*Instance_Node) ProtoMessage()func (*Instance_Node) ProtoReflect
func (x *Instance_Node) ProtoReflect() protoreflect.Messagefunc (*Instance_Node) Reset
func (x *Instance_Node) Reset()func (*Instance_Node) String
func (x *Instance_Node) String() stringInstance_QueryInsightsInstanceConfig
type Instance_QueryInsightsInstanceConfig struct {
RecordApplicationTags *bool "" /* 133 byte string literal not displayed */
RecordClientAddress *bool "" /* 127 byte string literal not displayed */
QueryStringLength uint32 `protobuf:"varint,4,opt,name=query_string_length,json=queryStringLength,proto3" json:"query_string_length,omitempty"`
QueryPlansPerMinute *uint32 "" /* 129 byte string literal not displayed */
}QueryInsights Instance specific configuration.
func (*Instance_QueryInsightsInstanceConfig) Descriptor
func (*Instance_QueryInsightsInstanceConfig) Descriptor() ([]byte, []int)Deprecated: Use Instance_QueryInsightsInstanceConfig.ProtoReflect.Descriptor instead.
func (*Instance_QueryInsightsInstanceConfig) GetQueryPlansPerMinute
func (x *Instance_QueryInsightsInstanceConfig) GetQueryPlansPerMinute() uint32func (*Instance_QueryInsightsInstanceConfig) GetQueryStringLength
func (x *Instance_QueryInsightsInstanceConfig) GetQueryStringLength() uint32func (*Instance_QueryInsightsInstanceConfig) GetRecordApplicationTags
func (x *Instance_QueryInsightsInstanceConfig) GetRecordApplicationTags() boolfunc (*Instance_QueryInsightsInstanceConfig) GetRecordClientAddress
func (x *Instance_QueryInsightsInstanceConfig) GetRecordClientAddress() boolfunc (*Instance_QueryInsightsInstanceConfig) ProtoMessage
func (*Instance_QueryInsightsInstanceConfig) ProtoMessage()func (*Instance_QueryInsightsInstanceConfig) ProtoReflect
func (x *Instance_QueryInsightsInstanceConfig) ProtoReflect() protoreflect.Messagefunc (*Instance_QueryInsightsInstanceConfig) Reset
func (x *Instance_QueryInsightsInstanceConfig) Reset()func (*Instance_QueryInsightsInstanceConfig) String
func (x *Instance_QueryInsightsInstanceConfig) String() stringInstance_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
func (*Instance_ReadPoolConfig) Descriptor() ([]byte, []int)Deprecated: Use Instance_ReadPoolConfig.ProtoReflect.Descriptor instead.
func (*Instance_ReadPoolConfig) GetNodeCount
func (x *Instance_ReadPoolConfig) GetNodeCount() int32func (*Instance_ReadPoolConfig) ProtoMessage
func (*Instance_ReadPoolConfig) ProtoMessage()func (*Instance_ReadPoolConfig) ProtoReflect
func (x *Instance_ReadPoolConfig) ProtoReflect() protoreflect.Messagefunc (*Instance_ReadPoolConfig) Reset
func (x *Instance_ReadPoolConfig) Reset()func (*Instance_ReadPoolConfig) String
func (x *Instance_ReadPoolConfig) String() stringInstance_State
type Instance_State int32Instance State
Instance_STATE_UNSPECIFIED, Instance_READY, Instance_STOPPED, Instance_CREATING, Instance_DELETING, Instance_MAINTENANCE, Instance_FAILED, Instance_BOOTSTRAPPING, Instance_PROMOTING
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) Descriptor() protoreflect.EnumDescriptorfunc (Instance_State) Enum
func (x Instance_State) Enum() *Instance_Statefunc (Instance_State) EnumDescriptor
func (Instance_State) EnumDescriptor() ([]byte, []int)Deprecated: Use Instance_State.Descriptor instead.
func (Instance_State) Number
func (x Instance_State) Number() protoreflect.EnumNumberfunc (Instance_State) String
func (x Instance_State) String() stringfunc (Instance_State) Type
func (Instance_State) Type() protoreflect.EnumTypeInstance_UpdatePolicy
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
func (*Instance_UpdatePolicy) Descriptor() ([]byte, []int)Deprecated: Use Instance_UpdatePolicy.ProtoReflect.Descriptor instead.
func (*Instance_UpdatePolicy) GetMode
func (x *Instance_UpdatePolicy) GetMode() Instance_UpdatePolicy_Modefunc (*Instance_UpdatePolicy) ProtoMessage
func (*Instance_UpdatePolicy) ProtoMessage()func (*Instance_UpdatePolicy) ProtoReflect
func (x *Instance_UpdatePolicy) ProtoReflect() protoreflect.Messagefunc (*Instance_UpdatePolicy) Reset
func (x *Instance_UpdatePolicy) Reset()func (*Instance_UpdatePolicy) String
func (x *Instance_UpdatePolicy) String() stringInstance_UpdatePolicy_Mode
type Instance_UpdatePolicy_Mode int32Specifies the available modes of update.
Instance_UpdatePolicy_MODE_UNSPECIFIED, Instance_UpdatePolicy_DEFAULT, Instance_UpdatePolicy_FORCE_APPLY
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
func (Instance_UpdatePolicy_Mode) Descriptor() protoreflect.EnumDescriptorfunc (Instance_UpdatePolicy_Mode) Enum
func (x Instance_UpdatePolicy_Mode) Enum() *Instance_UpdatePolicy_Modefunc (Instance_UpdatePolicy_Mode) EnumDescriptor
func (Instance_UpdatePolicy_Mode) EnumDescriptor() ([]byte, []int)Deprecated: Use Instance_UpdatePolicy_Mode.Descriptor instead.
func (Instance_UpdatePolicy_Mode) Number
func (x Instance_UpdatePolicy_Mode) Number() protoreflect.EnumNumberfunc (Instance_UpdatePolicy_Mode) String
func (x Instance_UpdatePolicy_Mode) String() stringfunc (Instance_UpdatePolicy_Mode) Type
func (Instance_UpdatePolicy_Mode) Type() protoreflect.EnumTypeListBackupsRequest
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
func (*ListBackupsRequest) Descriptor() ([]byte, []int)Deprecated: Use ListBackupsRequest.ProtoReflect.Descriptor instead.
func (*ListBackupsRequest) GetFilter
func (x *ListBackupsRequest) GetFilter() stringfunc (*ListBackupsRequest) GetOrderBy
func (x *ListBackupsRequest) GetOrderBy() stringfunc (*ListBackupsRequest) GetPageSize
func (x *ListBackupsRequest) GetPageSize() int32func (*ListBackupsRequest) GetPageToken
func (x *ListBackupsRequest) GetPageToken() stringfunc (*ListBackupsRequest) GetParent
func (x *ListBackupsRequest) GetParent() stringfunc (*ListBackupsRequest) ProtoMessage
func (*ListBackupsRequest) ProtoMessage()func (*ListBackupsRequest) ProtoReflect
func (x *ListBackupsRequest) ProtoReflect() protoreflect.Messagefunc (*ListBackupsRequest) Reset
func (x *ListBackupsRequest) Reset()func (*ListBackupsRequest) String
func (x *ListBackupsRequest) String() stringListBackupsResponse
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
func (*ListBackupsResponse) Descriptor() ([]byte, []int)Deprecated: Use ListBackupsResponse.ProtoReflect.Descriptor instead.
func (*ListBackupsResponse) GetBackups
func (x *ListBackupsResponse) GetBackups() []*Backupfunc (*ListBackupsResponse) GetNextPageToken
func (x *ListBackupsResponse) GetNextPageToken() stringfunc (*ListBackupsResponse) GetUnreachable
func (x *ListBackupsResponse) GetUnreachable() []stringfunc (*ListBackupsResponse) ProtoMessage
func (*ListBackupsResponse) ProtoMessage()func (*ListBackupsResponse) ProtoReflect
func (x *ListBackupsResponse) ProtoReflect() protoreflect.Messagefunc (*ListBackupsResponse) Reset
func (x *ListBackupsResponse) Reset()func (*ListBackupsResponse) String
func (x *ListBackupsResponse) String() stringListClustersRequest
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
func (*ListClustersRequest) Descriptor() ([]byte, []int)Deprecated: Use ListClustersRequest.ProtoReflect.Descriptor instead.
func (*ListClustersRequest) GetFilter
func (x *ListClustersRequest) GetFilter() stringfunc (*ListClustersRequest) GetOrderBy
func (x *ListClustersRequest) GetOrderBy() stringfunc (*ListClustersRequest) GetPageSize
func (x *ListClustersRequest) GetPageSize() int32func (*ListClustersRequest) GetPageToken
func (x *ListClustersRequest) GetPageToken() stringfunc (*ListClustersRequest) GetParent
func (x *ListClustersRequest) GetParent() stringfunc (*ListClustersRequest) ProtoMessage
func (*ListClustersRequest) ProtoMessage()func (*ListClustersRequest) ProtoReflect
func (x *ListClustersRequest) ProtoReflect() protoreflect.Messagefunc (*ListClustersRequest) Reset
func (x *ListClustersRequest) Reset()func (*ListClustersRequest) String
func (x *ListClustersRequest) String() stringListClustersResponse
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
func (*ListClustersResponse) Descriptor() ([]byte, []int)Deprecated: Use ListClustersResponse.ProtoReflect.Descriptor instead.
func (*ListClustersResponse) GetClusters
func (x *ListClustersResponse) GetClusters() []*Clusterfunc (*ListClustersResponse) GetNextPageToken
func (x *ListClustersResponse) GetNextPageToken() stringfunc (*ListClustersResponse) GetUnreachable
func (x *ListClustersResponse) GetUnreachable() []stringfunc (*ListClustersResponse) ProtoMessage
func (*ListClustersResponse) ProtoMessage()func (*ListClustersResponse) ProtoReflect
func (x *ListClustersResponse) ProtoReflect() protoreflect.Messagefunc (*ListClustersResponse) Reset
func (x *ListClustersResponse) Reset()func (*ListClustersResponse) String
func (x *ListClustersResponse) String() stringListInstancesRequest
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
func (*ListInstancesRequest) Descriptor() ([]byte, []int)Deprecated: Use ListInstancesRequest.ProtoReflect.Descriptor instead.
func (*ListInstancesRequest) GetFilter
func (x *ListInstancesRequest) GetFilter() stringfunc (*ListInstancesRequest) GetOrderBy
func (x *ListInstancesRequest) GetOrderBy() stringfunc (*ListInstancesRequest) GetPageSize
func (x *ListInstancesRequest) GetPageSize() int32func (*ListInstancesRequest) GetPageToken
func (x *ListInstancesRequest) GetPageToken() stringfunc (*ListInstancesRequest) GetParent
func (x *ListInstancesRequest) GetParent() stringfunc (*ListInstancesRequest) ProtoMessage
func (*ListInstancesRequest) ProtoMessage()func (*ListInstancesRequest) ProtoReflect
func (x *ListInstancesRequest) ProtoReflect() protoreflect.Messagefunc (*ListInstancesRequest) Reset
func (x *ListInstancesRequest) Reset()func (*ListInstancesRequest) String
func (x *ListInstancesRequest) String() stringListInstancesResponse
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
func (*ListInstancesResponse) Descriptor() ([]byte, []int)Deprecated: Use ListInstancesResponse.ProtoReflect.Descriptor instead.
func (*ListInstancesResponse) GetInstances
func (x *ListInstancesResponse) GetInstances() []*Instancefunc (*ListInstancesResponse) GetNextPageToken
func (x *ListInstancesResponse) GetNextPageToken() stringfunc (*ListInstancesResponse) GetUnreachable
func (x *ListInstancesResponse) GetUnreachable() []stringfunc (*ListInstancesResponse) ProtoMessage
func (*ListInstancesResponse) ProtoMessage()func (*ListInstancesResponse) ProtoReflect
func (x *ListInstancesResponse) ProtoReflect() protoreflect.Messagefunc (*ListInstancesResponse) Reset
func (x *ListInstancesResponse) Reset()func (*ListInstancesResponse) String
func (x *ListInstancesResponse) String() stringListSupportedDatabaseFlagsRequest
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
func (*ListSupportedDatabaseFlagsRequest) Descriptor() ([]byte, []int)Deprecated: Use ListSupportedDatabaseFlagsRequest.ProtoReflect.Descriptor instead.
func (*ListSupportedDatabaseFlagsRequest) GetPageSize
func (x *ListSupportedDatabaseFlagsRequest) GetPageSize() int32func (*ListSupportedDatabaseFlagsRequest) GetPageToken
func (x *ListSupportedDatabaseFlagsRequest) GetPageToken() stringfunc (*ListSupportedDatabaseFlagsRequest) GetParent
func (x *ListSupportedDatabaseFlagsRequest) GetParent() stringfunc (*ListSupportedDatabaseFlagsRequest) ProtoMessage
func (*ListSupportedDatabaseFlagsRequest) ProtoMessage()func (*ListSupportedDatabaseFlagsRequest) ProtoReflect
func (x *ListSupportedDatabaseFlagsRequest) ProtoReflect() protoreflect.Messagefunc (*ListSupportedDatabaseFlagsRequest) Reset
func (x *ListSupportedDatabaseFlagsRequest) Reset()func (*ListSupportedDatabaseFlagsRequest) String
func (x *ListSupportedDatabaseFlagsRequest) String() stringListSupportedDatabaseFlagsResponse
type ListSupportedDatabaseFlagsResponse struct {
SupportedDatabaseFlags []*SupportedDatabaseFlag "" /* 129 byte string literal not displayed */
NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
}Message for response to listing SupportedDatabaseFlags.
func (*ListSupportedDatabaseFlagsResponse) Descriptor
func (*ListSupportedDatabaseFlagsResponse) Descriptor() ([]byte, []int)Deprecated: Use ListSupportedDatabaseFlagsResponse.ProtoReflect.Descriptor instead.
func (*ListSupportedDatabaseFlagsResponse) GetNextPageToken
func (x *ListSupportedDatabaseFlagsResponse) GetNextPageToken() stringfunc (*ListSupportedDatabaseFlagsResponse) GetSupportedDatabaseFlags
func (x *ListSupportedDatabaseFlagsResponse) GetSupportedDatabaseFlags() []*SupportedDatabaseFlagfunc (*ListSupportedDatabaseFlagsResponse) ProtoMessage
func (*ListSupportedDatabaseFlagsResponse) ProtoMessage()func (*ListSupportedDatabaseFlagsResponse) ProtoReflect
func (x *ListSupportedDatabaseFlagsResponse) ProtoReflect() protoreflect.Messagefunc (*ListSupportedDatabaseFlagsResponse) Reset
func (x *ListSupportedDatabaseFlagsResponse) Reset()func (*ListSupportedDatabaseFlagsResponse) String
func (x *ListSupportedDatabaseFlagsResponse) String() stringListUsersRequest
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
func (*ListUsersRequest) Descriptor() ([]byte, []int)Deprecated: Use ListUsersRequest.ProtoReflect.Descriptor instead.
func (*ListUsersRequest) GetFilter
func (x *ListUsersRequest) GetFilter() stringfunc (*ListUsersRequest) GetOrderBy
func (x *ListUsersRequest) GetOrderBy() stringfunc (*ListUsersRequest) GetPageSize
func (x *ListUsersRequest) GetPageSize() int32func (*ListUsersRequest) GetPageToken
func (x *ListUsersRequest) GetPageToken() stringfunc (*ListUsersRequest) GetParent
func (x *ListUsersRequest) GetParent() stringfunc (*ListUsersRequest) ProtoMessage
func (*ListUsersRequest) ProtoMessage()func (*ListUsersRequest) ProtoReflect
func (x *ListUsersRequest) ProtoReflect() protoreflect.Messagefunc (*ListUsersRequest) Reset
func (x *ListUsersRequest) Reset()func (*ListUsersRequest) String
func (x *ListUsersRequest) String() stringListUsersResponse
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
func (*ListUsersResponse) Descriptor() ([]byte, []int)Deprecated: Use ListUsersResponse.ProtoReflect.Descriptor instead.
func (*ListUsersResponse) GetNextPageToken
func (x *ListUsersResponse) GetNextPageToken() stringfunc (*ListUsersResponse) GetUnreachable
func (x *ListUsersResponse) GetUnreachable() []stringfunc (*ListUsersResponse) GetUsers
func (x *ListUsersResponse) GetUsers() []*Userfunc (*ListUsersResponse) ProtoMessage
func (*ListUsersResponse) ProtoMessage()func (*ListUsersResponse) ProtoReflect
func (x *ListUsersResponse) ProtoReflect() protoreflect.Messagefunc (*ListUsersResponse) Reset
func (x *ListUsersResponse) Reset()func (*ListUsersResponse) String
func (x *ListUsersResponse) String() stringMigrationSource
type MigrationSource struct {
HostPort string `protobuf:"bytes,1,opt,name=host_port,json=hostPort,proto3" json:"host_port,omitempty"`
ReferenceId string `protobuf:"bytes,2,opt,name=reference_id,json=referenceId,proto3" json:"reference_id,omitempty"`
SourceType MigrationSource_MigrationSourceType "" /* 161 byte string literal not displayed */
}Subset of the source instance configuration that is available when reading the cluster resource.
func (*MigrationSource) Descriptor
func (*MigrationSource) Descriptor() ([]byte, []int)Deprecated: Use MigrationSource.ProtoReflect.Descriptor instead.
func (*MigrationSource) GetHostPort
func (x *MigrationSource) GetHostPort() stringfunc (*MigrationSource) GetReferenceId
func (x *MigrationSource) GetReferenceId() stringfunc (*MigrationSource) GetSourceType
func (x *MigrationSource) GetSourceType() MigrationSource_MigrationSourceTypefunc (*MigrationSource) ProtoMessage
func (*MigrationSource) ProtoMessage()func (*MigrationSource) ProtoReflect
func (x *MigrationSource) ProtoReflect() protoreflect.Messagefunc (*MigrationSource) Reset
func (x *MigrationSource) Reset()func (*MigrationSource) String
func (x *MigrationSource) String() stringMigrationSource_MigrationSourceType
type MigrationSource_MigrationSourceType int32Denote the type of migration source that created this cluster.
MigrationSource_MIGRATION_SOURCE_TYPE_UNSPECIFIED, MigrationSource_DMS
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) Descriptor() protoreflect.EnumDescriptorfunc (MigrationSource_MigrationSourceType) Enum
func (x MigrationSource_MigrationSourceType) Enum() *MigrationSource_MigrationSourceTypefunc (MigrationSource_MigrationSourceType) EnumDescriptor
func (MigrationSource_MigrationSourceType) EnumDescriptor() ([]byte, []int)Deprecated: Use MigrationSource_MigrationSourceType.Descriptor instead.
func (MigrationSource_MigrationSourceType) Number
func (x MigrationSource_MigrationSourceType) Number() protoreflect.EnumNumberfunc (MigrationSource_MigrationSourceType) String
func (x MigrationSource_MigrationSourceType) String() stringfunc (MigrationSource_MigrationSourceType) Type
func (MigrationSource_MigrationSourceType) Type() protoreflect.EnumTypeOperationMetadata
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
func (*OperationMetadata) Descriptor() ([]byte, []int)Deprecated: Use OperationMetadata.ProtoReflect.Descriptor instead.
func (*OperationMetadata) GetApiVersion
func (x *OperationMetadata) GetApiVersion() stringfunc (*OperationMetadata) GetBatchCreateInstancesMetadata
func (x *OperationMetadata) GetBatchCreateInstancesMetadata() *BatchCreateInstancesMetadatafunc (*OperationMetadata) GetCreateTime
func (x *OperationMetadata) GetCreateTime() *timestamppb.Timestampfunc (*OperationMetadata) GetEndTime
func (x *OperationMetadata) GetEndTime() *timestamppb.Timestampfunc (*OperationMetadata) GetRequestSpecific
func (m *OperationMetadata) GetRequestSpecific() isOperationMetadata_RequestSpecificfunc (*OperationMetadata) GetRequestedCancellation
func (x *OperationMetadata) GetRequestedCancellation() boolfunc (*OperationMetadata) GetStatusMessage
func (x *OperationMetadata) GetStatusMessage() stringfunc (*OperationMetadata) GetTarget
func (x *OperationMetadata) GetTarget() stringfunc (*OperationMetadata) GetVerb
func (x *OperationMetadata) GetVerb() stringfunc (*OperationMetadata) ProtoMessage
func (*OperationMetadata) ProtoMessage()func (*OperationMetadata) ProtoReflect
func (x *OperationMetadata) ProtoReflect() protoreflect.Messagefunc (*OperationMetadata) Reset
func (x *OperationMetadata) Reset()func (*OperationMetadata) String
func (x *OperationMetadata) String() stringOperationMetadata_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"`
}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
func (*PromoteClusterRequest) Descriptor() ([]byte, []int)Deprecated: Use PromoteClusterRequest.ProtoReflect.Descriptor instead.
func (*PromoteClusterRequest) GetEtag
func (x *PromoteClusterRequest) GetEtag() stringfunc (*PromoteClusterRequest) GetName
func (x *PromoteClusterRequest) GetName() stringfunc (*PromoteClusterRequest) GetRequestId
func (x *PromoteClusterRequest) GetRequestId() stringfunc (*PromoteClusterRequest) GetValidateOnly
func (x *PromoteClusterRequest) GetValidateOnly() boolfunc (*PromoteClusterRequest) ProtoMessage
func (*PromoteClusterRequest) ProtoMessage()func (*PromoteClusterRequest) ProtoReflect
func (x *PromoteClusterRequest) ProtoReflect() protoreflect.Messagefunc (*PromoteClusterRequest) Reset
func (x *PromoteClusterRequest) Reset()func (*PromoteClusterRequest) String
func (x *PromoteClusterRequest) String() stringRestartInstanceRequest
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
func (*RestartInstanceRequest) Descriptor() ([]byte, []int)Deprecated: Use RestartInstanceRequest.ProtoReflect.Descriptor instead.
func (*RestartInstanceRequest) GetName
func (x *RestartInstanceRequest) GetName() stringfunc (*RestartInstanceRequest) GetRequestId
func (x *RestartInstanceRequest) GetRequestId() stringfunc (*RestartInstanceRequest) GetValidateOnly
func (x *RestartInstanceRequest) GetValidateOnly() boolfunc (*RestartInstanceRequest) ProtoMessage
func (*RestartInstanceRequest) ProtoMessage()func (*RestartInstanceRequest) ProtoReflect
func (x *RestartInstanceRequest) ProtoReflect() protoreflect.Messagefunc (*RestartInstanceRequest) Reset
func (x *RestartInstanceRequest) Reset()func (*RestartInstanceRequest) String
func (x *RestartInstanceRequest) String() stringRestoreClusterRequest
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
func (*RestoreClusterRequest) Descriptor() ([]byte, []int)Deprecated: Use RestoreClusterRequest.ProtoReflect.Descriptor instead.
func (*RestoreClusterRequest) GetBackupSource
func (x *RestoreClusterRequest) GetBackupSource() *BackupSourcefunc (*RestoreClusterRequest) GetCluster
func (x *RestoreClusterRequest) GetCluster() *Clusterfunc (*RestoreClusterRequest) GetClusterId
func (x *RestoreClusterRequest) GetClusterId() stringfunc (*RestoreClusterRequest) GetContinuousBackupSource
func (x *RestoreClusterRequest) GetContinuousBackupSource() *ContinuousBackupSourcefunc (*RestoreClusterRequest) GetParent
func (x *RestoreClusterRequest) GetParent() stringfunc (*RestoreClusterRequest) GetRequestId
func (x *RestoreClusterRequest) GetRequestId() stringfunc (*RestoreClusterRequest) GetSource
func (m *RestoreClusterRequest) GetSource() isRestoreClusterRequest_Sourcefunc (*RestoreClusterRequest) GetValidateOnly
func (x *RestoreClusterRequest) GetValidateOnly() boolfunc (*RestoreClusterRequest) ProtoMessage
func (*RestoreClusterRequest) ProtoMessage()func (*RestoreClusterRequest) ProtoReflect
func (x *RestoreClusterRequest) ProtoReflect() protoreflect.Messagefunc (*RestoreClusterRequest) Reset
func (x *RestoreClusterRequest) Reset()func (*RestoreClusterRequest) String
func (x *RestoreClusterRequest) String() stringRestoreClusterRequest_BackupSource
type RestoreClusterRequest_BackupSource struct {
// Backup source.
BackupSource *BackupSource `protobuf:"bytes,4,opt,name=backup_source,json=backupSource,proto3,oneof"`
}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"`
}SslConfig
type SslConfig struct {
SslMode SslConfig_SslMode "" /* 134 byte string literal not displayed */
CaSource SslConfig_CaSource "" /* 138 byte string literal not displayed */
}SSL configuration.
func (*SslConfig) Descriptor
Deprecated: Use SslConfig.ProtoReflect.Descriptor instead.
func (*SslConfig) GetCaSource
func (x *SslConfig) GetCaSource() SslConfig_CaSourcefunc (*SslConfig) GetSslMode
func (x *SslConfig) GetSslMode() SslConfig_SslModefunc (*SslConfig) ProtoMessage
func (*SslConfig) ProtoMessage()func (*SslConfig) ProtoReflect
func (x *SslConfig) ProtoReflect() protoreflect.Messagefunc (*SslConfig) Reset
func (x *SslConfig) Reset()func (*SslConfig) String
SslConfig_CaSource
type SslConfig_CaSource int32Certificate Authority (CA) source for SSL/TLS certificates.
SslConfig_CA_SOURCE_UNSPECIFIED, SslConfig_CA_SOURCE_MANAGED
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) Descriptor() protoreflect.EnumDescriptorfunc (SslConfig_CaSource) Enum
func (x SslConfig_CaSource) Enum() *SslConfig_CaSourcefunc (SslConfig_CaSource) EnumDescriptor
func (SslConfig_CaSource) EnumDescriptor() ([]byte, []int)Deprecated: Use SslConfig_CaSource.Descriptor instead.
func (SslConfig_CaSource) Number
func (x SslConfig_CaSource) Number() protoreflect.EnumNumberfunc (SslConfig_CaSource) String
func (x SslConfig_CaSource) String() stringfunc (SslConfig_CaSource) Type
func (SslConfig_CaSource) Type() protoreflect.EnumTypeSslConfig_SslMode
type SslConfig_SslMode int32SSL mode options.
SslConfig_SSL_MODE_UNSPECIFIED, SslConfig_SSL_MODE_ALLOW, SslConfig_SSL_MODE_REQUIRE, SslConfig_SSL_MODE_VERIFY_CA, SslConfig_ALLOW_UNENCRYPTED_AND_ENCRYPTED, SslConfig_ENCRYPTED_ONLY
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) Descriptor() protoreflect.EnumDescriptorfunc (SslConfig_SslMode) Enum
func (x SslConfig_SslMode) Enum() *SslConfig_SslModefunc (SslConfig_SslMode) EnumDescriptor
func (SslConfig_SslMode) EnumDescriptor() ([]byte, []int)Deprecated: Use SslConfig_SslMode.Descriptor instead.
func (SslConfig_SslMode) Number
func (x SslConfig_SslMode) Number() protoreflect.EnumNumberfunc (SslConfig_SslMode) String
func (x SslConfig_SslMode) String() stringfunc (SslConfig_SslMode) Type
func (SslConfig_SslMode) Type() protoreflect.EnumTypeSupportedDatabaseFlag
type SupportedDatabaseFlag struct {
Restrictions isSupportedDatabaseFlag_Restrictions `protobuf_oneof:"restrictions"`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
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 */
AcceptsMultipleValues bool "" /* 127 byte string literal not displayed */
SupportedDbVersions []DatabaseVersion "" /* 177 byte string literal not displayed */
RequiresDbRestart bool `protobuf:"varint,6,opt,name=requires_db_restart,json=requiresDbRestart,proto3" json:"requires_db_restart,omitempty"`
}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
func (*SupportedDatabaseFlag) Descriptor() ([]byte, []int)Deprecated: Use SupportedDatabaseFlag.ProtoReflect.Descriptor instead.
func (*SupportedDatabaseFlag) GetAcceptsMultipleValues
func (x *SupportedDatabaseFlag) GetAcceptsMultipleValues() boolfunc (*SupportedDatabaseFlag) GetFlagName
func (x *SupportedDatabaseFlag) GetFlagName() stringfunc (*SupportedDatabaseFlag) GetIntegerRestrictions
func (x *SupportedDatabaseFlag) GetIntegerRestrictions() *SupportedDatabaseFlag_IntegerRestrictionsfunc (*SupportedDatabaseFlag) GetName
func (x *SupportedDatabaseFlag) GetName() stringfunc (*SupportedDatabaseFlag) GetRequiresDbRestart
func (x *SupportedDatabaseFlag) GetRequiresDbRestart() boolfunc (*SupportedDatabaseFlag) GetRestrictions
func (m *SupportedDatabaseFlag) GetRestrictions() isSupportedDatabaseFlag_Restrictionsfunc (*SupportedDatabaseFlag) GetStringRestrictions
func (x *SupportedDatabaseFlag) GetStringRestrictions() *SupportedDatabaseFlag_StringRestrictionsfunc (*SupportedDatabaseFlag) GetSupportedDbVersions
func (x *SupportedDatabaseFlag) GetSupportedDbVersions() []DatabaseVersionfunc (*SupportedDatabaseFlag) GetValueType
func (x *SupportedDatabaseFlag) GetValueType() SupportedDatabaseFlag_ValueTypefunc (*SupportedDatabaseFlag) ProtoMessage
func (*SupportedDatabaseFlag) ProtoMessage()func (*SupportedDatabaseFlag) ProtoReflect
func (x *SupportedDatabaseFlag) ProtoReflect() protoreflect.Messagefunc (*SupportedDatabaseFlag) Reset
func (x *SupportedDatabaseFlag) Reset()func (*SupportedDatabaseFlag) String
func (x *SupportedDatabaseFlag) String() stringSupportedDatabaseFlag_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
func (*SupportedDatabaseFlag_IntegerRestrictions) Descriptor() ([]byte, []int)Deprecated: Use SupportedDatabaseFlag_IntegerRestrictions.ProtoReflect.Descriptor instead.
func (*SupportedDatabaseFlag_IntegerRestrictions) GetMaxValue
func (x *SupportedDatabaseFlag_IntegerRestrictions) GetMaxValue() *wrapperspb.Int64Valuefunc (*SupportedDatabaseFlag_IntegerRestrictions) GetMinValue
func (x *SupportedDatabaseFlag_IntegerRestrictions) GetMinValue() *wrapperspb.Int64Valuefunc (*SupportedDatabaseFlag_IntegerRestrictions) ProtoMessage
func (*SupportedDatabaseFlag_IntegerRestrictions) ProtoMessage()func (*SupportedDatabaseFlag_IntegerRestrictions) ProtoReflect
func (x *SupportedDatabaseFlag_IntegerRestrictions) ProtoReflect() protoreflect.Messagefunc (*SupportedDatabaseFlag_IntegerRestrictions) Reset
func (x *SupportedDatabaseFlag_IntegerRestrictions) Reset()func (*SupportedDatabaseFlag_IntegerRestrictions) String
func (x *SupportedDatabaseFlag_IntegerRestrictions) String() stringSupportedDatabaseFlag_IntegerRestrictions_
type SupportedDatabaseFlag_IntegerRestrictions_ struct {
// Restriction on INTEGER type value.
IntegerRestrictions *SupportedDatabaseFlag_IntegerRestrictions `protobuf:"bytes,8,opt,name=integer_restrictions,json=integerRestrictions,proto3,oneof"`
}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
func (*SupportedDatabaseFlag_StringRestrictions) Descriptor() ([]byte, []int)Deprecated: Use SupportedDatabaseFlag_StringRestrictions.ProtoReflect.Descriptor instead.
func (*SupportedDatabaseFlag_StringRestrictions) GetAllowedValues
func (x *SupportedDatabaseFlag_StringRestrictions) GetAllowedValues() []stringfunc (*SupportedDatabaseFlag_StringRestrictions) ProtoMessage
func (*SupportedDatabaseFlag_StringRestrictions) ProtoMessage()func (*SupportedDatabaseFlag_StringRestrictions) ProtoReflect
func (x *SupportedDatabaseFlag_StringRestrictions) ProtoReflect() protoreflect.Messagefunc (*SupportedDatabaseFlag_StringRestrictions) Reset
func (x *SupportedDatabaseFlag_StringRestrictions) Reset()func (*SupportedDatabaseFlag_StringRestrictions) String
func (x *SupportedDatabaseFlag_StringRestrictions) String() stringSupportedDatabaseFlag_StringRestrictions_
type SupportedDatabaseFlag_StringRestrictions_ struct {
// Restriction on STRING type value.
StringRestrictions *SupportedDatabaseFlag_StringRestrictions `protobuf:"bytes,7,opt,name=string_restrictions,json=stringRestrictions,proto3,oneof"`
}SupportedDatabaseFlag_ValueType
type SupportedDatabaseFlag_ValueType int32ValueType 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".
SupportedDatabaseFlag_VALUE_TYPE_UNSPECIFIED, SupportedDatabaseFlag_STRING, SupportedDatabaseFlag_INTEGER, SupportedDatabaseFlag_FLOAT, SupportedDatabaseFlag_NONE
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) Descriptor() protoreflect.EnumDescriptorfunc (SupportedDatabaseFlag_ValueType) Enum
func (x SupportedDatabaseFlag_ValueType) Enum() *SupportedDatabaseFlag_ValueTypefunc (SupportedDatabaseFlag_ValueType) EnumDescriptor
func (SupportedDatabaseFlag_ValueType) EnumDescriptor() ([]byte, []int)Deprecated: Use SupportedDatabaseFlag_ValueType.Descriptor instead.
func (SupportedDatabaseFlag_ValueType) Number
func (x SupportedDatabaseFlag_ValueType) Number() protoreflect.EnumNumberfunc (SupportedDatabaseFlag_ValueType) String
func (x SupportedDatabaseFlag_ValueType) String() stringfunc (SupportedDatabaseFlag_ValueType) Type
func (SupportedDatabaseFlag_ValueType) Type() protoreflect.EnumTypeUnimplementedAlloyDBAdminServer
type UnimplementedAlloyDBAdminServer struct {
}UnimplementedAlloyDBAdminServer can be embedded to have forward compatible implementations.
func (*UnimplementedAlloyDBAdminServer) BatchCreateInstances
func (*UnimplementedAlloyDBAdminServer) BatchCreateInstances(context.Context, *BatchCreateInstancesRequest) (*longrunningpb.Operation, error)func (*UnimplementedAlloyDBAdminServer) CreateBackup
func (*UnimplementedAlloyDBAdminServer) CreateBackup(context.Context, *CreateBackupRequest) (*longrunningpb.Operation, error)func (*UnimplementedAlloyDBAdminServer) CreateCluster
func (*UnimplementedAlloyDBAdminServer) CreateCluster(context.Context, *CreateClusterRequest) (*longrunningpb.Operation, error)func (*UnimplementedAlloyDBAdminServer) CreateInstance
func (*UnimplementedAlloyDBAdminServer) CreateInstance(context.Context, *CreateInstanceRequest) (*longrunningpb.Operation, error)func (*UnimplementedAlloyDBAdminServer) CreateSecondaryCluster
func (*UnimplementedAlloyDBAdminServer) CreateSecondaryCluster(context.Context, *CreateSecondaryClusterRequest) (*longrunningpb.Operation, error)func (*UnimplementedAlloyDBAdminServer) CreateSecondaryInstance
func (*UnimplementedAlloyDBAdminServer) CreateSecondaryInstance(context.Context, *CreateSecondaryInstanceRequest) (*longrunningpb.Operation, error)func (*UnimplementedAlloyDBAdminServer) CreateUser
func (*UnimplementedAlloyDBAdminServer) CreateUser(context.Context, *CreateUserRequest) (*User, error)func (*UnimplementedAlloyDBAdminServer) DeleteBackup
func (*UnimplementedAlloyDBAdminServer) DeleteBackup(context.Context, *DeleteBackupRequest) (*longrunningpb.Operation, error)func (*UnimplementedAlloyDBAdminServer) DeleteCluster
func (*UnimplementedAlloyDBAdminServer) DeleteCluster(context.Context, *DeleteClusterRequest) (*longrunningpb.Operation, error)func (*UnimplementedAlloyDBAdminServer) DeleteInstance
func (*UnimplementedAlloyDBAdminServer) DeleteInstance(context.Context, *DeleteInstanceRequest) (*longrunningpb.Operation, error)func (*UnimplementedAlloyDBAdminServer) DeleteUser
func (*UnimplementedAlloyDBAdminServer) DeleteUser(context.Context, *DeleteUserRequest) (*emptypb.Empty, error)func (*UnimplementedAlloyDBAdminServer) FailoverInstance
func (*UnimplementedAlloyDBAdminServer) FailoverInstance(context.Context, *FailoverInstanceRequest) (*longrunningpb.Operation, error)func (*UnimplementedAlloyDBAdminServer) GenerateClientCertificate
func (*UnimplementedAlloyDBAdminServer) GenerateClientCertificate(context.Context, *GenerateClientCertificateRequest) (*GenerateClientCertificateResponse, error)func (*UnimplementedAlloyDBAdminServer) GetBackup
func (*UnimplementedAlloyDBAdminServer) GetBackup(context.Context, *GetBackupRequest) (*Backup, error)func (*UnimplementedAlloyDBAdminServer) GetCluster
func (*UnimplementedAlloyDBAdminServer) GetCluster(context.Context, *GetClusterRequest) (*Cluster, error)func (*UnimplementedAlloyDBAdminServer) GetConnectionInfo
func (*UnimplementedAlloyDBAdminServer) GetConnectionInfo(context.Context, *GetConnectionInfoRequest) (*ConnectionInfo, error)func (*UnimplementedAlloyDBAdminServer) GetInstance
func (*UnimplementedAlloyDBAdminServer) GetInstance(context.Context, *GetInstanceRequest) (*Instance, error)func (*UnimplementedAlloyDBAdminServer) GetUser
func (*UnimplementedAlloyDBAdminServer) GetUser(context.Context, *GetUserRequest) (*User, error)func (*UnimplementedAlloyDBAdminServer) InjectFault
func (*UnimplementedAlloyDBAdminServer) InjectFault(context.Context, *InjectFaultRequest) (*longrunningpb.Operation, error)func (*UnimplementedAlloyDBAdminServer) ListBackups
func (*UnimplementedAlloyDBAdminServer) ListBackups(context.Context, *ListBackupsRequest) (*ListBackupsResponse, error)func (*UnimplementedAlloyDBAdminServer) ListClusters
func (*UnimplementedAlloyDBAdminServer) ListClusters(context.Context, *ListClustersRequest) (*ListClustersResponse, error)func (*UnimplementedAlloyDBAdminServer) ListInstances
func (*UnimplementedAlloyDBAdminServer) ListInstances(context.Context, *ListInstancesRequest) (*ListInstancesResponse, error)func (*UnimplementedAlloyDBAdminServer) ListSupportedDatabaseFlags
func (*UnimplementedAlloyDBAdminServer) ListSupportedDatabaseFlags(context.Context, *ListSupportedDatabaseFlagsRequest) (*ListSupportedDatabaseFlagsResponse, error)func (*UnimplementedAlloyDBAdminServer) ListUsers
func (*UnimplementedAlloyDBAdminServer) ListUsers(context.Context, *ListUsersRequest) (*ListUsersResponse, error)func (*UnimplementedAlloyDBAdminServer) PromoteCluster
func (*UnimplementedAlloyDBAdminServer) PromoteCluster(context.Context, *PromoteClusterRequest) (*longrunningpb.Operation, error)func (*UnimplementedAlloyDBAdminServer) RestartInstance
func (*UnimplementedAlloyDBAdminServer) RestartInstance(context.Context, *RestartInstanceRequest) (*longrunningpb.Operation, error)func (*UnimplementedAlloyDBAdminServer) RestoreCluster
func (*UnimplementedAlloyDBAdminServer) RestoreCluster(context.Context, *RestoreClusterRequest) (*longrunningpb.Operation, error)func (*UnimplementedAlloyDBAdminServer) UpdateBackup
func (*UnimplementedAlloyDBAdminServer) UpdateBackup(context.Context, *UpdateBackupRequest) (*longrunningpb.Operation, error)func (*UnimplementedAlloyDBAdminServer) UpdateCluster
func (*UnimplementedAlloyDBAdminServer) UpdateCluster(context.Context, *UpdateClusterRequest) (*longrunningpb.Operation, error)func (*UnimplementedAlloyDBAdminServer) UpdateInstance
func (*UnimplementedAlloyDBAdminServer) UpdateInstance(context.Context, *UpdateInstanceRequest) (*longrunningpb.Operation, error)func (*UnimplementedAlloyDBAdminServer) UpdateUser
func (*UnimplementedAlloyDBAdminServer) UpdateUser(context.Context, *UpdateUserRequest) (*User, error)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
func (*UpdateBackupRequest) Descriptor() ([]byte, []int)Deprecated: Use UpdateBackupRequest.ProtoReflect.Descriptor instead.
func (*UpdateBackupRequest) GetAllowMissing
func (x *UpdateBackupRequest) GetAllowMissing() boolfunc (*UpdateBackupRequest) GetBackup
func (x *UpdateBackupRequest) GetBackup() *Backupfunc (*UpdateBackupRequest) GetRequestId
func (x *UpdateBackupRequest) GetRequestId() stringfunc (*UpdateBackupRequest) GetUpdateMask
func (x *UpdateBackupRequest) GetUpdateMask() *fieldmaskpb.FieldMaskfunc (*UpdateBackupRequest) GetValidateOnly
func (x *UpdateBackupRequest) GetValidateOnly() boolfunc (*UpdateBackupRequest) ProtoMessage
func (*UpdateBackupRequest) ProtoMessage()func (*UpdateBackupRequest) ProtoReflect
func (x *UpdateBackupRequest) ProtoReflect() protoreflect.Messagefunc (*UpdateBackupRequest) Reset
func (x *UpdateBackupRequest) Reset()func (*UpdateBackupRequest) String
func (x *UpdateBackupRequest) String() stringUpdateClusterRequest
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
func (*UpdateClusterRequest) Descriptor() ([]byte, []int)Deprecated: Use UpdateClusterRequest.ProtoReflect.Descriptor instead.
func (*UpdateClusterRequest) GetAllowMissing
func (x *UpdateClusterRequest) GetAllowMissing() boolfunc (*UpdateClusterRequest) GetCluster
func (x *UpdateClusterRequest) GetCluster() *Clusterfunc (*UpdateClusterRequest) GetRequestId
func (x *UpdateClusterRequest) GetRequestId() stringfunc (*UpdateClusterRequest) GetUpdateMask
func (x *UpdateClusterRequest) GetUpdateMask() *fieldmaskpb.FieldMaskfunc (*UpdateClusterRequest) GetValidateOnly
func (x *UpdateClusterRequest) GetValidateOnly() boolfunc (*UpdateClusterRequest) ProtoMessage
func (*UpdateClusterRequest) ProtoMessage()func (*UpdateClusterRequest) ProtoReflect
func (x *UpdateClusterRequest) ProtoReflect() protoreflect.Messagefunc (*UpdateClusterRequest) Reset
func (x *UpdateClusterRequest) Reset()func (*UpdateClusterRequest) String
func (x *UpdateClusterRequest) String() stringUpdateInstanceRequest
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
func (*UpdateInstanceRequest) Descriptor() ([]byte, []int)Deprecated: Use UpdateInstanceRequest.ProtoReflect.Descriptor instead.
func (*UpdateInstanceRequest) GetAllowMissing
func (x *UpdateInstanceRequest) GetAllowMissing() boolfunc (*UpdateInstanceRequest) GetInstance
func (x *UpdateInstanceRequest) GetInstance() *Instancefunc (*UpdateInstanceRequest) GetRequestId
func (x *UpdateInstanceRequest) GetRequestId() stringfunc (*UpdateInstanceRequest) GetUpdateMask
func (x *UpdateInstanceRequest) GetUpdateMask() *fieldmaskpb.FieldMaskfunc (*UpdateInstanceRequest) GetValidateOnly
func (x *UpdateInstanceRequest) GetValidateOnly() boolfunc (*UpdateInstanceRequest) ProtoMessage
func (*UpdateInstanceRequest) ProtoMessage()func (*UpdateInstanceRequest) ProtoReflect
func (x *UpdateInstanceRequest) ProtoReflect() protoreflect.Messagefunc (*UpdateInstanceRequest) Reset
func (x *UpdateInstanceRequest) Reset()func (*UpdateInstanceRequest) String
func (x *UpdateInstanceRequest) String() stringUpdateUserRequest
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
func (*UpdateUserRequest) Descriptor() ([]byte, []int)Deprecated: Use UpdateUserRequest.ProtoReflect.Descriptor instead.
func (*UpdateUserRequest) GetAllowMissing
func (x *UpdateUserRequest) GetAllowMissing() boolfunc (*UpdateUserRequest) GetRequestId
func (x *UpdateUserRequest) GetRequestId() stringfunc (*UpdateUserRequest) GetUpdateMask
func (x *UpdateUserRequest) GetUpdateMask() *fieldmaskpb.FieldMaskfunc (*UpdateUserRequest) GetUser
func (x *UpdateUserRequest) GetUser() *Userfunc (*UpdateUserRequest) GetValidateOnly
func (x *UpdateUserRequest) GetValidateOnly() boolfunc (*UpdateUserRequest) ProtoMessage
func (*UpdateUserRequest) ProtoMessage()func (*UpdateUserRequest) ProtoReflect
func (x *UpdateUserRequest) ProtoReflect() protoreflect.Messagefunc (*UpdateUserRequest) Reset
func (x *UpdateUserRequest) Reset()func (*UpdateUserRequest) String
func (x *UpdateUserRequest) String() stringUser
type User struct {
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
Password string `protobuf:"bytes,2,opt,name=password,proto3" json:"password,omitempty"`
DatabaseRoles []string `protobuf:"bytes,4,rep,name=database_roles,json=databaseRoles,proto3" json:"database_roles,omitempty"`
UserType User_UserType "" /* 133 byte string literal not displayed */
}Message describing User object.
func (*User) Descriptor
Deprecated: Use User.ProtoReflect.Descriptor instead.
func (*User) GetDatabaseRoles
func (*User) GetName
func (*User) GetPassword
func (*User) GetUserType
func (x *User) GetUserType() User_UserTypefunc (*User) ProtoMessage
func (*User) ProtoMessage()func (*User) ProtoReflect
func (x *User) ProtoReflect() protoreflect.Messagefunc (*User) Reset
func (x *User) Reset()func (*User) String
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
func (*UserPassword) Descriptor() ([]byte, []int)Deprecated: Use UserPassword.ProtoReflect.Descriptor instead.
func (*UserPassword) GetPassword
func (x *UserPassword) GetPassword() stringfunc (*UserPassword) GetUser
func (x *UserPassword) GetUser() stringfunc (*UserPassword) ProtoMessage
func (*UserPassword) ProtoMessage()func (*UserPassword) ProtoReflect
func (x *UserPassword) ProtoReflect() protoreflect.Messagefunc (*UserPassword) Reset
func (x *UserPassword) Reset()func (*UserPassword) String
func (x *UserPassword) String() stringUser_UserType
type User_UserType int32Enum that details the user type.
User_USER_TYPE_UNSPECIFIED, User_ALLOYDB_BUILT_IN, User_ALLOYDB_IAM_USER
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
func (User_UserType) Descriptor() protoreflect.EnumDescriptorfunc (User_UserType) Enum
func (x User_UserType) Enum() *User_UserTypefunc (User_UserType) EnumDescriptor
func (User_UserType) EnumDescriptor() ([]byte, []int)Deprecated: Use User_UserType.Descriptor instead.
func (User_UserType) Number
func (x User_UserType) Number() protoreflect.EnumNumberfunc (User_UserType) String
func (x User_UserType) String() stringfunc (User_UserType) Type
func (User_UserType) Type() protoreflect.EnumType