google-cloud-alloy_db-v1beta 0.a → 0.1.0

data/proto_docs/google/cloud/alloydb/v1beta/resources.rb

@@ -0,0 +1,1068 @@
+# frozen_string_literal: true
+
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module AlloyDB
+      module V1beta
+        # The username/password for a database user. Used for specifying initial
+        # users at cluster creation time.
+        # @!attribute [rw] user
+        #   @return [::String]
+        #     The database username.
+        # @!attribute [rw] password
+        #   @return [::String]
+        #     The initial password for the user.
+        class UserPassword
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Subset of the source instance configuration that is available when reading
+        # the cluster resource.
+        # @!attribute [r] host_port
+        #   @return [::String]
+        #     Output only. The host and port of the on-premises instance in host:port
+        #     format
+        # @!attribute [r] reference_id
+        #   @return [::String]
+        #     Output only. Place holder for the external source identifier(e.g DMS job
+        #     name) that created the cluster.
+        # @!attribute [r] source_type
+        #   @return [::Google::Cloud::AlloyDB::V1beta::MigrationSource::MigrationSourceType]
+        #     Output only. Type of migration source.
+        class MigrationSource
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Denote the type of migration source that created this cluster.
+          module MigrationSourceType
+            # Migration source is unknown.
+            MIGRATION_SOURCE_TYPE_UNSPECIFIED = 0
+
+            # DMS source means the cluster was created via DMS migration job.
+            DMS = 1
+          end
+        end
+
+        # EncryptionConfig describes the encryption config of a cluster or a backup
+        # that is encrypted with a CMEK (customer-managed encryption key).
+        # @!attribute [rw] kms_key_name
+        #   @return [::String]
+        #     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]
+        class EncryptionConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # EncryptionInfo describes the encryption information of a cluster or a backup.
+        # @!attribute [r] encryption_type
+        #   @return [::Google::Cloud::AlloyDB::V1beta::EncryptionInfo::Type]
+        #     Output only. Type of encryption.
+        # @!attribute [r] kms_key_versions
+        #   @return [::Array<::String>]
+        #     Output only. Cloud KMS key versions that are being used to protect the
+        #     database or the backup.
+        class EncryptionInfo
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Possible encryption types.
+          module Type
+            # Encryption type not specified. Defaults to GOOGLE_DEFAULT_ENCRYPTION.
+            TYPE_UNSPECIFIED = 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.
+            GOOGLE_DEFAULT_ENCRYPTION = 1
+
+            # The data is encrypted at rest with a key that is managed by the customer.
+            # KMS key versions will be populated.
+            CUSTOMER_MANAGED_ENCRYPTION = 2
+          end
+        end
+
+        # SSL configuration for an AlloyDB Cluster.
+        # @!attribute [rw] ssl_mode
+        #   @return [::Google::Cloud::AlloyDB::V1beta::SslConfig::SslMode]
+        #     Optional. SSL mode. Specifies client-server SSL/TLS connection behavior.
+        # @!attribute [rw] ca_source
+        #   @return [::Google::Cloud::AlloyDB::V1beta::SslConfig::CaSource]
+        #     Optional. Certificate Authority (CA) source. Only CA_SOURCE_MANAGED is
+        #     supported currently, and is the default value.
+        class SslConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # SSL mode options.
+          module SslMode
+            # SSL mode not specified. Defaults to SSL_MODE_ALLOW.
+            SSL_MODE_UNSPECIFIED = 0
+
+            # SSL connections are optional. CA verification not enforced.
+            SSL_MODE_ALLOW = 1
+
+            # SSL connections are required. CA verification not enforced.
+            # Clients may use locally self-signed certificates (default psql client
+            # behavior).
+            SSL_MODE_REQUIRE = 2
+
+            # SSL connections are required. CA verification enforced.
+            # Clients must have certificates signed by a Cluster CA, e.g. via
+            # GenerateClientCertificate.
+            SSL_MODE_VERIFY_CA = 3
+          end
+
+          # Certificate Authority (CA) source for SSL/TLS certificates.
+          module CaSource
+            # Certificate Authority (CA) source not specified. Defaults to
+            # CA_SOURCE_MANAGED.
+            CA_SOURCE_UNSPECIFIED = 0
+
+            # Certificate Authority (CA) managed by the AlloyDB Cluster.
+            CA_SOURCE_MANAGED = 1
+          end
+        end
+
+        # 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.
+        # @!attribute [rw] weekly_schedule
+        #   @return [::Google::Cloud::AlloyDB::V1beta::AutomatedBackupPolicy::WeeklySchedule]
+        #     Weekly schedule for the Backup.
+        # @!attribute [rw] time_based_retention
+        #   @return [::Google::Cloud::AlloyDB::V1beta::AutomatedBackupPolicy::TimeBasedRetention]
+        #     Time-based Backup retention policy.
+        # @!attribute [rw] quantity_based_retention
+        #   @return [::Google::Cloud::AlloyDB::V1beta::AutomatedBackupPolicy::QuantityBasedRetention]
+        #     Quantity-based Backup retention policy to retain recent backups.
+        # @!attribute [rw] enabled
+        #   @return [::Boolean]
+        #     Whether automated automated backups are enabled. If not set, defaults to
+        #     true.
+        # @!attribute [rw] backup_window
+        #   @return [::Google::Protobuf::Duration]
+        #     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.
+        # @!attribute [rw] encryption_config
+        #   @return [::Google::Cloud::AlloyDB::V1beta::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.
+        # @!attribute [rw] location
+        #   @return [::String]
+        #     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.
+        # @!attribute [rw] labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Labels to apply to backups created using this configuration.
+        class AutomatedBackupPolicy
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # 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.
+          # @!attribute [rw] start_times
+          #   @return [::Array<::Google::Type::TimeOfDay>]
+          #     The times during the day to start a backup. The start times are assumed
+          #     to be in UTC and to be an exact hour (e.g., 04:00:00).
+          #
+          #     If no start times are provided, a single fixed start time is chosen
+          #     arbitrarily.
+          # @!attribute [rw] days_of_week
+          #   @return [::Array<::Google::Type::DayOfWeek>]
+          #     The days of the week to perform a backup.
+          #
+          #     If this field is left empty, the default of every day of the week is
+          #     used.
+          class WeeklySchedule
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # A time based retention policy specifies that all backups within a certain
+          # time period should be retained.
+          # @!attribute [rw] retention_period
+          #   @return [::Google::Protobuf::Duration]
+          #     The retention period.
+          class TimeBasedRetention
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # A quantity based policy specifies that a certain number of the most recent
+          # successful backups should be retained.
+          # @!attribute [rw] count
+          #   @return [::Integer]
+          #     The number of backups to retain.
+          class QuantityBasedRetention
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class LabelsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # ContinuousBackupConfig describes the continuous backups recovery
+        # configurations of a cluster.
+        # @!attribute [rw] enabled
+        #   @return [::Boolean]
+        #     Whether ContinuousBackup is enabled.
+        # @!attribute [rw] recovery_window_days
+        #   @return [::Integer]
+        #     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.
+        # @!attribute [rw] encryption_config
+        #   @return [::Google::Cloud::AlloyDB::V1beta::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.
+        class ContinuousBackupConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # ContinuousBackupInfo describes the continuous backup properties of a
+        # cluster.
+        # @!attribute [r] encryption_info
+        #   @return [::Google::Cloud::AlloyDB::V1beta::EncryptionInfo]
+        #     Output only. The encryption information for the WALs and backups required
+        #     for ContinuousBackup.
+        # @!attribute [r] enabled_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. When ContinuousBackup was most recently enabled. Set to null
+        #     if ContinuousBackup is not enabled.
+        # @!attribute [r] schedule
+        #   @return [::Array<::Google::Type::DayOfWeek>]
+        #     Output only. Days of the week on which a continuous backup is taken. Output
+        #     only field. Ignored if passed into the request.
+        class ContinuousBackupInfo
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Message describing a BackupSource.
+        # @!attribute [r] backup_uid
+        #   @return [::String]
+        #     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.
+        # @!attribute [rw] backup_name
+        #   @return [::String]
+        #     Required. The name of the backup resource with the format:
+        #      * projects/\\{project}/locations/\\{region}/backups/\\{backup_id}
+        class BackupSource
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Message describing a ContinuousBackupSource.
+        # @!attribute [rw] cluster
+        #   @return [::String]
+        #     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.
+        # @!attribute [rw] point_in_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Required. The point in time to restore to.
+        class ContinuousBackupSource
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # 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.
+        # @!attribute [r] backup_source
+        #   @return [::Google::Cloud::AlloyDB::V1beta::BackupSource]
+        #     Output only. Cluster created from backup.
+        # @!attribute [r] migration_source
+        #   @return [::Google::Cloud::AlloyDB::V1beta::MigrationSource]
+        #     Output only. Cluster created via DMS migration.
+        # @!attribute [r] name
+        #   @return [::String]
+        #     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}
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     User-settable and human-readable display name for the Cluster.
+        # @!attribute [r] uid
+        #   @return [::String]
+        #     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.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Create time stamp
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Update time stamp
+        # @!attribute [r] delete_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Delete time stamp
+        # @!attribute [rw] labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Labels as key value pairs
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::AlloyDB::V1beta::Cluster::State]
+        #     Output only. The current serving state of the cluster.
+        # @!attribute [r] cluster_type
+        #   @return [::Google::Cloud::AlloyDB::V1beta::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`
+        # @!attribute [r] database_version
+        #   @return [::Google::Cloud::AlloyDB::V1beta::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.
+        # @!attribute [rw] network
+        #   @return [::String]
+        #     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.
+        # @!attribute [rw] etag
+        #   @return [::String]
+        #     For Resource freshness validation (https://google.aip.dev/154)
+        # @!attribute [rw] annotations
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Annotations to allow client tools to store small amount of arbitrary data.
+        #     This is distinct from labels.
+        #     https://google.aip.dev/128
+        # @!attribute [r] reconciling
+        #   @return [::Boolean]
+        #     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.
+        # @!attribute [rw] initial_user
+        #   @return [::Google::Cloud::AlloyDB::V1beta::UserPassword]
+        #     Input only. Initial user to setup during cluster creation. Required.
+        #     If used in `RestoreCluster` this is ignored.
+        # @!attribute [rw] automated_backup_policy
+        #   @return [::Google::Cloud::AlloyDB::V1beta::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.
+        # @!attribute [rw] ssl_config
+        #   @return [::Google::Cloud::AlloyDB::V1beta::SslConfig]
+        #     SSL configuration for this AlloyDB Cluster.
+        # @!attribute [rw] encryption_config
+        #   @return [::Google::Cloud::AlloyDB::V1beta::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.
+        # @!attribute [r] encryption_info
+        #   @return [::Google::Cloud::AlloyDB::V1beta::EncryptionInfo]
+        #     Output only. The encryption information for the cluster.
+        # @!attribute [rw] continuous_backup_config
+        #   @return [::Google::Cloud::AlloyDB::V1beta::ContinuousBackupConfig]
+        #     Optional. Continuous backup configuration for this cluster.
+        # @!attribute [r] continuous_backup_info
+        #   @return [::Google::Cloud::AlloyDB::V1beta::ContinuousBackupInfo]
+        #     Output only. Continuous backup properties for this cluster.
+        # @!attribute [rw] secondary_config
+        #   @return [::Google::Cloud::AlloyDB::V1beta::Cluster::SecondaryConfig]
+        #     Cross Region replication config specific to SECONDARY cluster.
+        # @!attribute [r] primary_config
+        #   @return [::Google::Cloud::AlloyDB::V1beta::Cluster::PrimaryConfig]
+        #     Output only. Cross Region replication config specific to PRIMARY cluster.
+        class Cluster
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Configuration information for the secondary cluster. This should be set
+          # if and only if the cluster is of type SECONDARY.
+          # @!attribute [rw] primary_cluster_name
+          #   @return [::String]
+          #     The name of the primary cluster name with the format:
+          #     * projects/\\{project}/locations/\\{region}/clusters/\\{cluster_id}
+          class SecondaryConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # 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.
+          # @!attribute [r] secondary_cluster_names
+          #   @return [::Array<::String>]
+          #     Output only. Names of the clusters that are replicating from this
+          #     cluster.
+          class PrimaryConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class LabelsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class AnnotationsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Cluster State
+          module State
+            # The state of the cluster is unknown.
+            STATE_UNSPECIFIED = 0
+
+            # The cluster is active and running.
+            READY = 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.
+            STOPPED = 2
+
+            # The cluster is empty and has no associated resources.
+            # All instances, associated storage and backups have been deleted.
+            EMPTY = 3
+
+            # The cluster is being created.
+            CREATING = 4
+
+            # The cluster is being deleted.
+            DELETING = 5
+
+            # The creation of the cluster failed.
+            FAILED = 6
+
+            # The cluster is bootstrapping with data from some other source.
+            # Direct mutations to the cluster (e.g. adding read pool) are not allowed.
+            BOOTSTRAPPING = 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.
+            MAINTENANCE = 8
+
+            # The cluster is being promoted.
+            PROMOTING = 9
+          end
+
+          # Type of Cluster
+          module ClusterType
+            # The type of the cluster is unknown.
+            CLUSTER_TYPE_UNSPECIFIED = 0
+
+            # Primary cluster that support read and write operations.
+            PRIMARY = 1
+
+            # Secondary cluster that is replicating from another region.
+            # This only supports read.
+            SECONDARY = 2
+          end
+        end
+
+        # An Instance is a computing unit that an end customer can connect to.
+        # It's the main unit of computing resources in AlloyDB.
+        # @!attribute [r] name
+        #   @return [::String]
+        #     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}
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     User-settable and human-readable display name for the Instance.
+        # @!attribute [r] uid
+        #   @return [::String]
+        #     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.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Create time stamp
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Update time stamp
+        # @!attribute [r] delete_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Delete time stamp
+        # @!attribute [rw] labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Labels as key value pairs
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::AlloyDB::V1beta::Instance::State]
+        #     Output only. The current serving state of the instance.
+        # @!attribute [rw] instance_type
+        #   @return [::Google::Cloud::AlloyDB::V1beta::Instance::InstanceType]
+        #     Required. The type of the instance. Specified at creation time.
+        # @!attribute [rw] machine_config
+        #   @return [::Google::Cloud::AlloyDB::V1beta::Instance::MachineConfig]
+        #     Configurations for the machines that host the underlying
+        #     database engine.
+        # @!attribute [rw] availability_type
+        #   @return [::Google::Cloud::AlloyDB::V1beta::Instance::AvailabilityType]
+        #     Availability type of an Instance.
+        #     Defaults to REGIONAL for both primary and read instances.
+        #     Note that primary and read instances can have different availability types.
+        # @!attribute [rw] gce_zone
+        #   @return [::String]
+        #     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.
+        # @!attribute [rw] database_flags
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     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.
+        # @!attribute [r] writable_node
+        #   @return [::Google::Cloud::AlloyDB::V1beta::Instance::Node]
+        #     Output only. This is set for the read-write VM of the PRIMARY instance
+        #     only.
+        # @!attribute [r] nodes
+        #   @return [::Array<::Google::Cloud::AlloyDB::V1beta::Instance::Node>]
+        #     Output only. List of available read-only VMs in this instance, including
+        #     the standby for a PRIMARY instance.
+        # @!attribute [rw] query_insights_config
+        #   @return [::Google::Cloud::AlloyDB::V1beta::Instance::QueryInsightsInstanceConfig]
+        #     Configuration for query insights.
+        # @!attribute [rw] read_pool_config
+        #   @return [::Google::Cloud::AlloyDB::V1beta::Instance::ReadPoolConfig]
+        #     Read pool specific config.
+        # @!attribute [r] ip_address
+        #   @return [::String]
+        #     Output only. The IP address for the Instance.
+        #     This is the connection endpoint for an end-user application.
+        # @!attribute [r] reconciling
+        #   @return [::Boolean]
+        #     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.
+        # @!attribute [rw] etag
+        #   @return [::String]
+        #     For Resource freshness validation (https://google.aip.dev/154)
+        # @!attribute [rw] annotations
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Annotations to allow client tools to store small amount of arbitrary data.
+        #     This is distinct from labels.
+        #     https://google.aip.dev/128
+        class Instance
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # MachineConfig describes the configuration of a machine.
+          # @!attribute [rw] cpu_count
+          #   @return [::Integer]
+          #     The number of CPU's in the VM instance.
+          class MachineConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # 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.
+          # @!attribute [rw] zone_id
+          #   @return [::String]
+          #     The Compute Engine zone of the VM e.g. "us-central1-b".
+          # @!attribute [rw] id
+          #   @return [::String]
+          #     The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
+          # @!attribute [rw] ip
+          #   @return [::String]
+          #     The private IP address of the VM e.g. "10.57.0.34".
+          # @!attribute [rw] state
+          #   @return [::String]
+          #     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.
+          class Node
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # QueryInsights Instance specific configuration.
+          # @!attribute [rw] record_application_tags
+          #   @return [::Boolean]
+          #     Record application tags for an instance.
+          #     This flag is turned "on" by default.
+          # @!attribute [rw] record_client_address
+          #   @return [::Boolean]
+          #     Record client address for an instance. Client address is PII information.
+          #     This flag is turned "on" by default.
+          # @!attribute [rw] query_string_length
+          #   @return [::Integer]
+          #     Query string length. The default value is 1024.
+          #     Any integer between 256 and 4500 is considered valid.
+          # @!attribute [rw] query_plans_per_minute
+          #   @return [::Integer]
+          #     Number of query execution plans captured by Insights per minute
+          #     for all queries combined. The default value is 5.
+          #     Any integer between 0 and 20 is considered valid.
+          class QueryInsightsInstanceConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Configuration for a read pool instance.
+          # @!attribute [rw] node_count
+          #   @return [::Integer]
+          #     Read capacity, i.e. number of nodes in a read pool instance.
+          class ReadPoolConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class LabelsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class DatabaseFlagsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class AnnotationsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Instance State
+          module State
+            # The state of the instance is unknown.
+            STATE_UNSPECIFIED = 0
+
+            # The instance is active and running.
+            READY = 1
+
+            # The instance is stopped. Instance name and IP resources are preserved.
+            STOPPED = 2
+
+            # The instance is being created.
+            CREATING = 3
+
+            # The instance is being deleted.
+            DELETING = 4
+
+            # The instance is down for maintenance.
+            MAINTENANCE = 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.
+            FAILED = 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.
+            BOOTSTRAPPING = 8
+
+            # The instance is being promoted.
+            PROMOTING = 9
+          end
+
+          # Type of an Instance
+          module InstanceType
+            # The type of the instance is unknown.
+            INSTANCE_TYPE_UNSPECIFIED = 0
+
+            # PRIMARY instances support read and write operations.
+            PRIMARY = 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).
+            READ_POOL = 2
+
+            # SECONDARY instances support read operations only. SECONDARY instance
+            # is a cross-region read replica
+            SECONDARY = 3
+          end
+
+          # The Availability type of an instance. Potential values:
+          #   <br><b>ZONAL</b>: The instance serves data from only one zone.
+          # Outages in that zone affect instance availability.
+          #   <br><b>REGIONAL</b>: The instance can serve data from more than one zone
+          #   in a region (it is highly available).
+          module AvailabilityType
+            # This is an unknown Availability type.
+            AVAILABILITY_TYPE_UNSPECIFIED = 0
+
+            # Zonal available instance.
+            ZONAL = 1
+
+            # Regional (or Highly) available instance.
+            REGIONAL = 2
+          end
+        end
+
+        # ConnectionInfo singleton resource.
+        # https://google.aip.dev/156
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     The name of the ConnectionInfo singleton resource, e.g.:
+        #     projects/\\{project}/locations/\\{location}/clusters/*/instances/*/connectionInfo
+        #     This field currently has no semantic meaning.
+        # @!attribute [r] ip_address
+        #   @return [::String]
+        #     Output only. The IP address for the Instance.
+        #     This is the connection endpoint for an end-user application.
+        # @!attribute [r] pem_certificate_chain
+        #   @return [::Array<::String>]
+        #     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.
+        # @!attribute [r] instance_uid
+        #   @return [::String]
+        #     Output only. The unique ID of the Instance.
+        class ConnectionInfo
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Message describing Backup object
+        # @!attribute [r] name
+        #   @return [::String]
+        #     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}
+        # @!attribute [rw] display_name
+        #   @return [::String]
+        #     User-settable and human-readable display name for the Backup.
+        # @!attribute [r] uid
+        #   @return [::String]
+        #     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.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Create time stamp
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Update time stamp
+        # @!attribute [r] delete_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Delete time stamp
+        # @!attribute [rw] labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Labels as key value pairs
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::AlloyDB::V1beta::Backup::State]
+        #     Output only. The current state of the backup.
+        # @!attribute [rw] type
+        #   @return [::Google::Cloud::AlloyDB::V1beta::Backup::Type]
+        #     The backup type, which suggests the trigger for the backup.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     User-provided description of the backup.
+        # @!attribute [r] cluster_uid
+        #   @return [::String]
+        #     Output only. The system-generated UID of the cluster which was used to
+        #     create this resource.
+        # @!attribute [rw] cluster_name
+        #   @return [::String]
+        #     Required. The full resource name of the backup source cluster
+        #     (e.g., projects/<project>/locations/<location>/clusters/<cluster_id>).
+        # @!attribute [r] reconciling
+        #   @return [::Boolean]
+        #     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.
+        # @!attribute [rw] encryption_config
+        #   @return [::Google::Cloud::AlloyDB::V1beta::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.
+        # @!attribute [r] encryption_info
+        #   @return [::Google::Cloud::AlloyDB::V1beta::EncryptionInfo]
+        #     Output only. The encryption information for the backup.
+        # @!attribute [rw] etag
+        #   @return [::String]
+        #     For Resource freshness validation (https://google.aip.dev/154)
+        # @!attribute [rw] annotations
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Annotations to allow client tools to store small amount of arbitrary data.
+        #     This is distinct from labels.
+        #     https://google.aip.dev/128
+        # @!attribute [r] size_bytes
+        #   @return [::Integer]
+        #     Output only. The size of the backup in bytes.
+        # @!attribute [r] expiry_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     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.
+        class Backup
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class LabelsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class AnnotationsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Backup State
+          module State
+            # The state of the backup is unknown.
+            STATE_UNSPECIFIED = 0
+
+            # The backup is ready.
+            READY = 1
+
+            # The backup is creating.
+            CREATING = 2
+
+            # The backup failed.
+            FAILED = 3
+
+            # The backup is being deleted.
+            DELETING = 4
+          end
+
+          # Backup Type
+          module Type
+            # Backup Type is unknown.
+            TYPE_UNSPECIFIED = 0
+
+            # ON_DEMAND backups that were triggered by the customer (e.g., not
+            # AUTOMATED).
+            ON_DEMAND = 1
+
+            # AUTOMATED backups triggered by the automated backups scheduler pursuant
+            # to an automated backup policy.
+            AUTOMATED = 2
+
+            # CONTINUOUS backups triggered by the automated backups scheduler
+            # due to a continuous backup policy.
+            CONTINUOUS = 3
+          end
+        end
+
+        # 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.
+        # @!attribute [rw] string_restrictions
+        #   @return [::Google::Cloud::AlloyDB::V1beta::SupportedDatabaseFlag::StringRestrictions]
+        #     Restriction on STRING type value.
+        # @!attribute [rw] integer_restrictions
+        #   @return [::Google::Cloud::AlloyDB::V1beta::SupportedDatabaseFlag::IntegerRestrictions]
+        #     Restriction on INTEGER type value.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     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.
+        # @!attribute [rw] flag_name
+        #   @return [::String]
+        #     The name of the database flag, e.g. "max_allowed_packets".
+        #     The is a possibly key for the Instance.database_flags map field.
+        # @!attribute [rw] value_type
+        #   @return [::Google::Cloud::AlloyDB::V1beta::SupportedDatabaseFlag::ValueType]
+        # @!attribute [rw] accepts_multiple_values
+        #   @return [::Boolean]
+        #     Whether the database flag accepts multiple values. If true,
+        #     a comma-separated list of stringified values may be specified.
+        # @!attribute [rw] supported_db_versions
+        #   @return [::Array<::Google::Cloud::AlloyDB::V1beta::DatabaseVersion>]
+        #     Major database engine versions for which this flag is supported.
+        # @!attribute [rw] requires_db_restart
+        #   @return [::Boolean]
+        #     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).
+        class SupportedDatabaseFlag
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Restrictions on STRING type values
+          # @!attribute [rw] allowed_values
+          #   @return [::Array<::String>]
+          #     The list of allowed values, if bounded. This field will be empty
+          #     if there is a unbounded number of allowed values.
+          class StringRestrictions
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Restrictions on INTEGER type values.
+          # @!attribute [rw] min_value
+          #   @return [::Google::Protobuf::Int64Value]
+          #     The minimum value that can be specified, if applicable.
+          # @!attribute [rw] max_value
+          #   @return [::Google::Protobuf::Int64Value]
+          #     The maximum value that can be specified, if applicable.
+          class IntegerRestrictions
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # ValueType describes the semantic type of the value that the flag accepts.
+          # Regardless of the ValueType, the Instance.database_flags field accepts the
+          # stringified version of the value, i.e. "20" or "3.14".
+          module ValueType
+            # This is an unknown flag type.
+            VALUE_TYPE_UNSPECIFIED = 0
+
+            # String type flag.
+            STRING = 1
+
+            # Integer type flag.
+            INTEGER = 2
+
+            # Float type flag.
+            FLOAT = 3
+
+            # Denotes that the flag does not accept any values.
+            NONE = 4
+          end
+        end
+
+        # The supported database engine versions.
+        module DatabaseVersion
+          # This is an unknown database version.
+          DATABASE_VERSION_UNSPECIFIED = 0
+
+          # DEPRECATED - The database version is Postgres 13.
+          POSTGRES_13 = 1
+
+          # The database version is Postgres 14.
+          POSTGRES_14 = 2
+        end
+
+        # View on Instance. Pass this enum to rpcs that returns an Instance message to
+        # control which subsets of fields to get.
+        module InstanceView
+          # INSTANCE_VIEW_UNSPECIFIED Not specified, equivalent to BASIC.
+          INSTANCE_VIEW_UNSPECIFIED = 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.
+          INSTANCE_VIEW_BASIC = 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.
+          INSTANCE_VIEW_FULL = 2
+        end
+      end
+    end
+  end
+end