Type Members

1.  final case class AutomatedBackupPolicy(schedule: Schedule = com.google.cloud.alloydb.v1.resources.AutomatedBackupPolicy.Schedule.Empty, retention: Retention = com.google.cloud.alloydb.v1.resources.AutomatedBackupPolicy.Retention.Empty, enabled: Option[Boolean] = _root_.scala.None, backupWindow: Option[Duration] = _root_.scala.None, encryptionConfig: Option[EncryptionConfig] = _root_.scala.None, location: String = "", labels: Map[String, String] = _root_.scala.collection.immutable.Map.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[AutomatedBackupPolicy] with Product with Serializable

   Message describing the user-specified automated backup policy.

   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.

   enabled

   Whether automated automated backups are enabled. If not set, defaults to true.

   backupWindow

   The length of the time window during which a backup can be taken. If a backup does not succeed within this time window, it will be canceled and considered failed. The backup window must be at least 5 minutes long. There is no upper bound on the window. If not set, it defaults to 1 hour.

   encryptionConfig

   Optional. The encryption config can be specified to encrypt the backups with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.

   location

   The location where the backup will be stored. Currently, the only supported option is to store the backup in the same region as the cluster. If empty, defaults to the region of the cluster.

   labels

   Labels to apply to backups created using this configuration.

   Annotations

   @SerialVersionUID()

2.  final case class Backup(name: String = "", displayName: String = "", uid: String = "", createTime: Option[Timestamp] = _root_.scala.None, updateTime: Option[Timestamp] = _root_.scala.None, deleteTime: Option[Timestamp] = _root_.scala.None, labels: Map[String, String] = _root_.scala.collection.immutable.Map.empty, state: State = com.google.cloud.alloydb.v1.resources.Backup.State.STATE_UNSPECIFIED, type: Type = com.google.cloud.alloydb.v1.resources.Backup.Type.TYPE_UNSPECIFIED, description: String = "", clusterUid: String = "", clusterName: String = "", reconciling: Boolean = false, encryptionConfig: Option[EncryptionConfig] = _root_.scala.None, encryptionInfo: Option[EncryptionInfo] = _root_.scala.None, etag: String = "", annotations: Map[String, String] = _root_.scala.collection.immutable.Map.empty, sizeBytes: Long = 0L, expiryTime: Option[Timestamp] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Backup] with Product with Serializable

   Message describing Backup object

   Message describing Backup object

   name

   Output only. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id} where the cluster and backup ID segments should satisfy the regex expression [a-z]([a-z0-9-]{0,61}[a-z0-9])?, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the backup resource name is the name of the parent resource: * projects/{project}/locations/{region}

   displayName

   User-settable and human-readable display name for the Backup.

   uid

   Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.

   createTime

   Output only. Create time stamp

   updateTime

   Output only. Update time stamp

   deleteTime

   Output only. Delete time stamp

   labels

   Labels as key value pairs

   state

   Output only. The current state of the backup.

   type

   The backup type, which suggests the trigger for the backup.

   description

   User-provided description of the backup.

   clusterUid

   Output only. The system-generated UID of the cluster which was used to create this resource.

   clusterName

   Required. The full resource name of the backup source cluster (e.g., projects/{project}/locations/{region}/clusters/{cluster_id}).

   reconciling

   Output only. Reconciling (https://google.aip.dev/128#reconciliation), if true, indicates that the service is actively updating the resource. This can happen due to user-triggered updates or system actions like failover or maintenance.

   encryptionConfig

   Optional. The encryption config can be specified to encrypt the backup with a customer-managed encryption key (CMEK). When this field is not specified, the backup will then use default encryption scheme to protect the user data.

   encryptionInfo

   Output only. The encryption information for the backup.

   etag

   For Resource freshness validation (https://google.aip.dev/154)

   annotations

   Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

   sizeBytes

   Output only. The size of the backup in bytes.

   expiryTime

   Output only. The time at which after the backup is eligible to be garbage collected. It is the duration specified by the backup's retention policy, added to the backup's create_time.

   Annotations

   @SerialVersionUID()

3.  final case class BackupSource(backupUid: String = "", backupName: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[BackupSource] with Product with Serializable

   Message describing a BackupSource.

   Message describing a BackupSource.

   backupUid

   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.

   backupName

   Required. The name of the backup resource with the format: * projects/{project}/locations/{region}/backups/{backup_id}

   Annotations

   @SerialVersionUID()

4.  final case class Cluster(source: Source = com.google.cloud.alloydb.v1.resources.Cluster.Source.Empty, name: String = "", displayName: String = "", uid: String = "", createTime: Option[Timestamp] = _root_.scala.None, updateTime: Option[Timestamp] = _root_.scala.None, deleteTime: Option[Timestamp] = _root_.scala.None, labels: Map[String, String] = _root_.scala.collection.immutable.Map.empty, state: State = com.google.cloud.alloydb.v1.resources.Cluster.State.STATE_UNSPECIFIED, clusterType: ClusterType = com.google.cloud.alloydb.v1.resources.Cluster.ClusterType.CLUSTER_TYPE_UNSPECIFIED, databaseVersion: DatabaseVersion = com.google.cloud.alloydb.v1.resources.DatabaseVersion.DATABASE_VERSION_UNSPECIFIED, network: String = "", etag: String = "", annotations: Map[String, String] = _root_.scala.collection.immutable.Map.empty, reconciling: Boolean = false, initialUser: Option[UserPassword] = _root_.scala.None, automatedBackupPolicy: Option[AutomatedBackupPolicy] = _root_.scala.None, sslConfig: Option[SslConfig] = _root_.scala.None, encryptionConfig: Option[EncryptionConfig] = _root_.scala.None, encryptionInfo: Option[EncryptionInfo] = _root_.scala.None, continuousBackupConfig: Option[ContinuousBackupConfig] = _root_.scala.None, continuousBackupInfo: Option[ContinuousBackupInfo] = _root_.scala.None, secondaryConfig: Option[SecondaryConfig] = _root_.scala.None, primaryConfig: Option[PrimaryConfig] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Cluster] with Product with Serializable

   A cluster is a collection of regional AlloyDB resources.

   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.

   name

   Output only. The name of the cluster resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id} where the cluster ID segment should satisfy the regex expression [a-z0-9-]+. For more details see https://google.aip.dev/122. The prefix of the cluster resource name is the name of the parent resource: * projects/{project}/locations/{region}

   displayName

   User-settable and human-readable display name for the Cluster.

   uid

   Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.

   createTime

   Output only. Create time stamp

   updateTime

   Output only. Update time stamp

   deleteTime

   Output only. Delete time stamp

   labels

   Labels as key value pairs

   state

   Output only. The current serving state of the cluster.

   clusterType

   Output only. The type of the cluster. This is an output-only field and it's populated at the Cluster creation time or the Cluster promotion time. The cluster type is determined by which RPC was used to create the cluster (i.e. CreateCluster vs. CreateSecondaryCluster

   databaseVersion

   Output only. The database engine major version. This is an output-only field and it's populated at the Cluster creation time. This field cannot be changed after cluster creation.

   network

   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.

   etag

   For Resource freshness validation (https://google.aip.dev/154)

   annotations

   Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

   reconciling

   Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Cluster does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.

   initialUser

   Input only. Initial user to setup during cluster creation. Required. If used in RestoreCluster this is ignored.

   automatedBackupPolicy

   The automated backup policy for this cluster. If no policy is provided then the default policy will be used. If backups are supported for the cluster, the default policy takes one backup a day, has a backup window of 1 hour, and retains backups for 14 days. For more information on the defaults, consult the documentation for the message type.

   sslConfig

   SSL configuration for this AlloyDB cluster.

   encryptionConfig

   Optional. The encryption config can be specified to encrypt the data disks and other persistent data resources of a cluster with a customer-managed encryption key (CMEK). When this field is not specified, the cluster will then use default encryption scheme to protect the user data.

   encryptionInfo

   Output only. The encryption information for the cluster.

   continuousBackupConfig

   Optional. Continuous backup configuration for this cluster.

   continuousBackupInfo

   Output only. Continuous backup properties for this cluster.

   secondaryConfig

   Cross Region replication config specific to SECONDARY cluster.

   primaryConfig

   Output only. Cross Region replication config specific to PRIMARY cluster.

   Annotations

   @SerialVersionUID()

5.  sealed abstract class ClusterView extends GeneratedEnum

   View on Cluster.

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

6.  final case class ContinuousBackupConfig(enabled: Option[Boolean] = _root_.scala.None, recoveryWindowDays: Int = 0, encryptionConfig: Option[EncryptionConfig] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ContinuousBackupConfig] with Product with Serializable

   ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster.

   ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster.

   enabled

   Whether ContinuousBackup is enabled.

   recoveryWindowDays

   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.

   encryptionConfig

   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.

   Annotations

   @SerialVersionUID()

7.  final case class ContinuousBackupInfo(encryptionInfo: Option[EncryptionInfo] = _root_.scala.None, enabledTime: Option[Timestamp] = _root_.scala.None, schedule: Seq[DayOfWeek] = _root_.scala.Seq.empty, earliestRestorableTime: Option[Timestamp] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ContinuousBackupInfo] with Product with Serializable

   ContinuousBackupInfo describes the continuous backup properties of a cluster.

   ContinuousBackupInfo describes the continuous backup properties of a cluster.

   encryptionInfo

   Output only. The encryption information for the WALs and backups required for ContinuousBackup.

   enabledTime

   Output only. When ContinuousBackup was most recently enabled. Set to null if ContinuousBackup is not enabled.

   schedule

   Output only. Days of the week on which a continuous backup is taken. Output only field. Ignored if passed into the request.

   earliestRestorableTime

   Output only. The earliest restorable time that can be restored to. Output only field.

   Annotations

   @SerialVersionUID()

8.  final case class ContinuousBackupSource(cluster: String = "", pointInTime: Option[Timestamp] = _root_.scala.None, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[ContinuousBackupSource] with Product with Serializable

   Message describing a ContinuousBackupSource.

   Message describing a ContinuousBackupSource.

   cluster

   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.

   pointInTime

   Required. The point in time to restore to.

   Annotations

   @SerialVersionUID()

9.  sealed abstract class DatabaseVersion extends GeneratedEnum

   The supported database engine versions.

10.  final case class EncryptionConfig(kmsKeyName: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[EncryptionConfig] with Product with Serializable

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

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

    kmsKeyName

    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]

    Annotations

    @SerialVersionUID()

11.  final case class EncryptionInfo(encryptionType: Type = com.google.cloud.alloydb.v1.resources.EncryptionInfo.Type.TYPE_UNSPECIFIED, kmsKeyVersions: Seq[String] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[EncryptionInfo] with Product with Serializable

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

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

    encryptionType

    Output only. Type of encryption.

    kmsKeyVersions

    Output only. Cloud KMS key versions that are being used to protect the database or the backup.

    Annotations

    @SerialVersionUID()

12.  final case class Instance(name: String = "", displayName: String = "", uid: String = "", createTime: Option[Timestamp] = _root_.scala.None, updateTime: Option[Timestamp] = _root_.scala.None, deleteTime: Option[Timestamp] = _root_.scala.None, labels: Map[String, String] = _root_.scala.collection.immutable.Map.empty, state: State = com.google.cloud.alloydb.v1.resources.Instance.State.STATE_UNSPECIFIED, instanceType: InstanceType = com.google.cloud.alloydb.v1.resources.Instance.InstanceType.INSTANCE_TYPE_UNSPECIFIED, machineConfig: Option[MachineConfig] = _root_.scala.None, availabilityType: AvailabilityType = com.google.cloud.alloydb.v1.resources.Instance.AvailabilityType.AVAILABILITY_TYPE_UNSPECIFIED, gceZone: String = "", databaseFlags: Map[String, String] = _root_.scala.collection.immutable.Map.empty, writableNode: Option[Node] = _root_.scala.None, nodes: Seq[Node] = _root_.scala.Seq.empty, queryInsightsConfig: Option[QueryInsightsInstanceConfig] = _root_.scala.None, readPoolConfig: Option[ReadPoolConfig] = _root_.scala.None, ipAddress: String = "", reconciling: Boolean = false, etag: String = "", annotations: Map[String, String] = _root_.scala.collection.immutable.Map.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[Instance] with Product with Serializable

    An Instance is a computing unit that an end customer can connect to.

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

    name

    Output only. The name of the instance resource with the format: * projects/{project}/locations/{region}/clusters/{cluster_id}/instances/{instance_id} where the cluster and instance ID segments should satisfy the regex expression [a-z]([a-z0-9-]{0,61}[a-z0-9])?, e.g. 1-63 characters of lowercase letters, numbers, and dashes, starting with a letter, and ending with a letter or number. For more details see https://google.aip.dev/122. The prefix of the instance resource name is the name of the parent resource: * projects/{project}/locations/{region}/clusters/{cluster_id}

    displayName

    User-settable and human-readable display name for the Instance.

    uid

    Output only. The system-generated UID of the resource. The UID is assigned when the resource is created, and it is retained until it is deleted.

    createTime

    Output only. Create time stamp

    updateTime

    Output only. Update time stamp

    deleteTime

    Output only. Delete time stamp

    labels

    Labels as key value pairs

    state

    Output only. The current serving state of the instance.

    instanceType

    Required. The type of the instance. Specified at creation time.

    machineConfig

    Configurations for the machines that host the underlying database engine.

    availabilityType

    Availability type of an Instance. If empty, defaults to REGIONAL for primary instances. For read pools, availability_type is always UNSPECIFIED. Instances in the read pools are evenly distributed across available zones within the region (i.e. read pools with more than one node will have a node in at least two zones).

    gceZone

    The Compute Engine zone that the instance should serve from, per https://cloud.google.com/compute/docs/regions-zones This can ONLY be specified for ZONAL instances. If present for a REGIONAL instance, an error will be thrown. If this is absent for a ZONAL instance, instance is created in a random zone with available capacity.

    databaseFlags

    Database flags. Set at instance level. * They are copied from primary instance on read instance creation. * Read instances can set new or override existing flags that are relevant for reads, e.g. for enabling columnar cache on a read instance. Flags set on read instance may or may not be present on primary. This is a list of "key": "value" pairs. "key": The name of the flag. These flags are passed at instance setup time, so include both server options and system variables for Postgres. Flags are specified with underscores, not hyphens. "value": The value of the flag. Booleans are set to **on** for true and **off** for false. This field must be omitted if the flag doesn't take a value.

    writableNode

    Output only. This is set for the read-write VM of the PRIMARY instance only.

    nodes

    Output only. List of available read-only VMs in this instance, including the standby for a PRIMARY instance.

    queryInsightsConfig

    Configuration for query insights.

    readPoolConfig

    Read pool specific config.

    ipAddress

    Output only. The IP address for the Instance. This is the connection endpoint for an end-user application.

    reconciling

    Output only. Reconciling (https://google.aip.dev/128#reconciliation). Set to true if the current state of Instance does not match the user's intended state, and the service is actively updating the resource to reconcile them. This can happen due to user-triggered updates or system actions like failover or maintenance.

    etag

    For Resource freshness validation (https://google.aip.dev/154)

    annotations

    Annotations to allow client tools to store small amount of arbitrary data. This is distinct from labels. https://google.aip.dev/128

    Annotations

    @SerialVersionUID()

13.  sealed abstract class InstanceView extends GeneratedEnum

    View on Instance.

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

14.  final case class MigrationSource(hostPort: String = "", referenceId: String = "", sourceType: MigrationSourceType = com.google.cloud.alloydb.v1.resources.MigrationSource.MigrationSourceType.MIGRATION_SOURCE_TYPE_UNSPECIFIED, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[MigrationSource] with Product with Serializable

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

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

    hostPort

    Output only. The host and port of the on-premises instance in host:port format

    referenceId

    Output only. Place holder for the external source identifier(e.g DMS job name) that created the cluster.

    sourceType

    Output only. Type of migration source.

    Annotations

    @SerialVersionUID()

15.  final case class SslConfig(sslMode: SslMode = com.google.cloud.alloydb.v1.resources.SslConfig.SslMode.SSL_MODE_UNSPECIFIED, caSource: CaSource = com.google.cloud.alloydb.v1.resources.SslConfig.CaSource.CA_SOURCE_UNSPECIFIED, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SslConfig] with Product with Serializable

    SSL configuration.

    SSL configuration.

    sslMode

    Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.

    caSource

    Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is supported currently, and is the default value.

    Annotations

    @SerialVersionUID()

16.  final case class SupportedDatabaseFlag(restrictions: Restrictions = com.google.cloud.alloydb.v1.resources.SupportedDatabaseFlag.Restrictions.Empty, name: String = "", flagName: String = "", valueType: ValueTypeEnum = com.google.cloud.alloydb.v1.resources.SupportedDatabaseFlag.ValueTypeEnum.VALUE_TYPE_UNSPECIFIED, acceptsMultipleValues: Boolean = false, supportedDbVersions: Seq[DatabaseVersion] = _root_.scala.Seq.empty, requiresDbRestart: Boolean = false, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[SupportedDatabaseFlag] with Product with Serializable

    SupportedDatabaseFlag gives general information about a database flag, like type and allowed values.

    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.

    name

    The name of the flag resource, following Google Cloud conventions, e.g.: * projects/{project}/locations/{location}/flags/{flag} This field currently has no semantic meaning.

    flagName

    The name of the database flag, e.g. "max_allowed_packets". The is a possibly key for the Instance.database_flags map field.

    acceptsMultipleValues

    Whether the database flag accepts multiple values. If true, a comma-separated list of stringified values may be specified.

    supportedDbVersions

    Major database engine versions for which this flag is supported.

    requiresDbRestart

    Whether setting or updating this flag on an Instance requires a database restart. If a flag that requires database restart is set, the backend will automatically restart the database (making sure to satisfy any availability SLO's).

    Annotations

    @SerialVersionUID()

17.  final case class User(name: String = "", password: String = "", databaseRoles: Seq[String] = _root_.scala.Seq.empty, userType: UserType = com.google.cloud.alloydb.v1.resources.User.UserType.USER_TYPE_UNSPECIFIED, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[User] with Product with Serializable

    Message describing User object.

    Message describing User object.

    name

    Output only. Name of the resource in the form of projects/{project}/locations/{location}/cluster/{cluster}/users/{user}.

    password

    Input only. Password for the user.

    databaseRoles

    Optional. List of database roles this user has. The database role strings are subject to the PostgreSQL naming conventions.

    userType

    Optional. Type of this user.

    Annotations

    @SerialVersionUID()

18.  final case class UserPassword(user: String = "", password: String = "", unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[UserPassword] with Product with Serializable

    The username/password for a database user.

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

    user

    The database username.

    password

    The initial password for the user.

    Annotations

    @SerialVersionUID()