google-cloud-alloy_db-v1 1.1.0 → 1.3.0

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

@@ -181,8 +181,7 @@ module Google
         #   @return [::Google::Cloud::AlloyDB::V1::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.
+        #     not specified, the backup will use the cluster's encryption config.
         # @!attribute [rw] location
         #   @return [::String]
         #     The location where the backup will be stored. Currently, the only supported
@@ -265,8 +264,7 @@ module Google
         #   @return [::Google::Cloud::AlloyDB::V1::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.
+        #     not specified, the backup will use the cluster's encryption config.
         class ContinuousBackupConfig
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -284,12 +282,19 @@ module Google
         #     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.
+        #     Output only. Days of the week on which a continuous backup is taken.
         # @!attribute [r] earliest_restorable_time
         #   @return [::Google::Protobuf::Timestamp]
-        #     Output only. The earliest restorable time that can be restored to. Output
-        #     only field.
+        #     Output only. The earliest restorable time that can be restored to. If
+        #     continuous backups and recovery was recently enabled, the earliest
+        #     restorable time is the creation time of the earliest eligible backup within
+        #     this cluster's continuous backup recovery window. After a cluster has had
+        #     continuous backups enabled for the duration of its recovery window, the
+        #     earliest restorable time becomes "now minus the recovery window". For
+        #     example, assuming a point in time recovery is attempted at 04/16/2025
+        #     3:23:00PM with a 14d recovery window, the earliest restorable time would be
+        #     04/02/2025 3:23:00PM. This field is only visible if the
+        #     CLUSTER_VIEW_CONTINUOUS_BACKUP cluster view is provided.
         class ContinuousBackupInfo
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -328,6 +333,9 @@ module Google
         # @!attribute [rw] maintenance_windows
         #   @return [::Array<::Google::Cloud::AlloyDB::V1::MaintenanceUpdatePolicy::MaintenanceWindow>]
         #     Preferred windows to perform maintenance. Currently limited to 1.
+        # @!attribute [rw] deny_maintenance_periods
+        #   @return [::Array<::Google::Cloud::AlloyDB::V1::MaintenanceUpdatePolicy::DenyMaintenancePeriod>]
+        #     Periods to deny maintenance. Currently limited to 1.
         class MaintenanceUpdatePolicy
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -344,6 +352,32 @@ module Google
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
+
+          # DenyMaintenancePeriod definition. Excepting emergencies, maintenance
+          # will not be scheduled to start within this deny period. The start_date must
+          # be less than the end_date.
+          # @!attribute [rw] start_date
+          #   @return [::Google::Type::Date]
+          #     Deny period start date.
+          #     This can be:
+          #     * A full date, with non-zero year, month and day values OR
+          #     * A month and day value, with a zero year for recurring
+          # @!attribute [rw] end_date
+          #   @return [::Google::Type::Date]
+          #     Deny period end date.
+          #     This can be:
+          #     * A full date, with non-zero year, month and day values OR
+          #     * A month and day value, with a zero year for recurring
+          # @!attribute [rw] time
+          #   @return [::Google::Type::TimeOfDay]
+          #     Time in UTC when the deny period starts on start_date and ends on
+          #     end_date. This can be:
+          #     * Full time OR
+          #     * All zeros for 00:00:00 UTC
+          class DenyMaintenancePeriod
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
         end
 
         # MaintenanceSchedule stores the maintenance schedule generated from
@@ -366,12 +400,17 @@ module Google
         #   @return [::Google::Cloud::AlloyDB::V1::BackupSource]
         #     Output only. Cluster created from backup.
         #
-        #     Note: The following fields are mutually exclusive: `backup_source`, `migration_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        #     Note: The following fields are mutually exclusive: `backup_source`, `migration_source`, `cloudsql_backup_run_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [r] migration_source
         #   @return [::Google::Cloud::AlloyDB::V1::MigrationSource]
         #     Output only. Cluster created via DMS migration.
         #
-        #     Note: The following fields are mutually exclusive: `migration_source`, `backup_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        #     Note: The following fields are mutually exclusive: `migration_source`, `backup_source`, `cloudsql_backup_run_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [r] cloudsql_backup_run_source
+        #   @return [::Google::Cloud::AlloyDB::V1::CloudSQLBackupRunSource]
+        #     Output only. Cluster created from CloudSQL snapshot.
+        #
+        #     Note: The following fields are mutually exclusive: `cloudsql_backup_run_source`, `backup_source`, `migration_source`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [r] name
         #   @return [::String]
         #     Output only. The name of the cluster resource with the format:
@@ -562,6 +601,10 @@ module Google
           #   @return [::Boolean]
           #     Optional. Create an instance that allows connections from Private Service
           #     Connect endpoints to the instance.
+          # @!attribute [r] service_owned_project_number
+          #   @return [::Integer]
+          #     Output only. The project number that needs to be allowlisted on the
+          #     network attachment to enable outbound connectivity.
           class PscConfig
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -727,11 +770,13 @@ module Google
         #     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.
+        #     Database flags. Set at the instance level.
+        #     They are copied from the primary instance on secondary instance creation.
+        #     Flags that have restrictions default to the value at primary
+        #     instance on read instances during creation. Read instances can set new
+        #     flags or override existing flags that are relevant for reads, for example,
+        #     for enabling columnar cache on a read instance. Flags set on read instance
+        #     might or might not be present on the primary instance.
         #
         #
         #     This is a list of "key": "value" pairs.
@@ -752,6 +797,9 @@ module Google
         # @!attribute [rw] query_insights_config
         #   @return [::Google::Cloud::AlloyDB::V1::Instance::QueryInsightsInstanceConfig]
         #     Configuration for query insights.
+        # @!attribute [rw] observability_config
+        #   @return [::Google::Cloud::AlloyDB::V1::Instance::ObservabilityInstanceConfig]
+        #     Configuration for observability.
         # @!attribute [rw] read_pool_config
         #   @return [::Google::Cloud::AlloyDB::V1::Instance::ReadPoolConfig]
         #     Read pool instance configuration.
@@ -796,6 +844,15 @@ module Google
         # @!attribute [r] outbound_public_ip_addresses
         #   @return [::Array<::String>]
         #     Output only. All outbound public IP addresses configured for the instance.
+        # @!attribute [rw] activation_policy
+        #   @return [::Google::Cloud::AlloyDB::V1::Instance::ActivationPolicy]
+        #     Optional. Specifies whether an instance needs to spin up. Once the instance
+        #     is active, the activation policy can be updated to the `NEVER` to stop the
+        #     instance. Likewise, the activation policy can be updated to `ALWAYS` to
+        #     start the instance.
+        #     There are restrictions around when an instance can/cannot be activated (for
+        #     example, a read pool instance should be stopped before stopping primary
+        #     etc.). Please refer to the API documentation for more details.
         class Instance
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -804,27 +861,33 @@ module Google
           # @!attribute [rw] cpu_count
           #   @return [::Integer]
           #     The number of CPU's in the VM instance.
+          # @!attribute [rw] machine_type
+          #   @return [::String]
+          #     Machine type of the VM instance. E.g. "n2-highmem-4",
+          #     "n2-highmem-8", "c4a-highmem-4-lssd".
+          #     cpu_count must match the number of vCPUs in the machine type.
           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
+          # Nodes in an AlloyDB instance are ephemeral, they can change during
           # update, failover, autohealing and resize operations.
-          # @!attribute [rw] zone_id
+          # @!attribute [r] zone_id
           #   @return [::String]
-          #     The Compute Engine zone of the VM e.g. "us-central1-b".
-          # @!attribute [rw] id
+          #     Output only. The Compute Engine zone of the VM e.g. "us-central1-b".
+          # @!attribute [r] id
           #   @return [::String]
-          #     The identifier of the VM e.g. "test-read-0601-407e52be-ms3l".
-          # @!attribute [rw] ip
+          #     Output only. The identifier of the VM e.g.
+          #     "test-read-0601-407e52be-ms3l".
+          # @!attribute [r] ip
           #   @return [::String]
-          #     The private IP address of the VM e.g. "10.57.0.34".
-          # @!attribute [rw] state
+          #     Output only. The private IP address of the VM e.g. "10.57.0.34".
+          # @!attribute [r] state
           #   @return [::String]
-          #     Determined by state of the compute VM and postgres-service health.
-          #     Compute VM state can have values listed in
+          #     Output only. 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
@@ -855,6 +918,47 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
+          # Observability Instance specific configuration.
+          # @!attribute [rw] enabled
+          #   @return [::Boolean]
+          #     Observability feature status for an instance.
+          #     This flag is turned "off" by default.
+          # @!attribute [rw] preserve_comments
+          #   @return [::Boolean]
+          #     Preserve comments in query string for an instance.
+          #     This flag is turned "off" by default.
+          # @!attribute [rw] track_wait_events
+          #   @return [::Boolean]
+          #     Track wait events during query execution for an instance.
+          #     This flag is turned "on" by default but tracking is enabled only after
+          #     observability enabled flag is also turned on.
+          # @!attribute [r] track_wait_event_types
+          #   @return [::Boolean]
+          #     Output only. Track wait event types during query execution for an
+          #     instance. This flag is turned "on" by default but tracking is enabled
+          #     only after observability enabled flag is also turned on. This is
+          #     read-only flag and only modifiable by internal API.
+          # @!attribute [rw] max_query_string_length
+          #   @return [::Integer]
+          #     Query string length. The default value is 10k.
+          # @!attribute [rw] record_application_tags
+          #   @return [::Boolean]
+          #     Record application tags for an instance.
+          #     This flag is turned "off" by default.
+          # @!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 200.
+          #     Any integer between 0 to 200 is considered valid.
+          # @!attribute [rw] track_active_queries
+          #   @return [::Boolean]
+          #     Track actively running queries on the instance.
+          #     If not set, this flag is "off" by default.
+          class ObservabilityInstanceConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
           # Configuration for a read pool instance.
           # @!attribute [rw] node_count
           #   @return [::Integer]
@@ -877,6 +981,69 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
+          # Configuration for setting up a PSC interface to enable outbound
+          # connectivity.
+          # @!attribute [rw] network_attachment_resource
+          #   @return [::String]
+          #     The network attachment resource created in the consumer network to which
+          #     the PSC interface will be linked. This is of the format:
+          #     "projects/$\\{CONSUMER_PROJECT}/regions/$\\{REGION}/networkAttachments/$\\{NETWORK_ATTACHMENT_NAME}".
+          #     The network attachment must be in the same region as the instance.
+          class PscInterfaceConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Configuration for setting up PSC service automation. Consumer projects in
+          # the configs will be allowlisted automatically for the instance.
+          # @!attribute [rw] consumer_project
+          #   @return [::String]
+          #     The consumer project to which the PSC service automation endpoint will
+          #     be created.
+          # @!attribute [rw] consumer_network
+          #   @return [::String]
+          #     The consumer network for the PSC service automation, example:
+          #     "projects/vpc-host-project/global/networks/default".
+          #     The consumer network might be hosted a different project than the
+          #     consumer project.
+          # @!attribute [r] ip_address
+          #   @return [::String]
+          #     Output only. The IP address of the PSC service automation endpoint.
+          # @!attribute [r] status
+          #   @return [::String]
+          #     Output only. The status of the PSC service automation connection.
+          #     Possible values:
+          #       "STATE_UNSPECIFIED" - An invalid state as the default case.
+          #       "ACTIVE" - The connection has been created successfully.
+          #       "FAILED" - The connection is not functional since some resources on the
+          #     connection fail to be created.
+          #       "CREATING" - The connection is being created.
+          #       "DELETING" - The connection is being deleted.
+          #       "CREATE_REPAIRING" - The connection is being repaired to complete
+          #     creation.
+          #       "DELETE_REPAIRING" - The connection is being repaired to complete
+          #     deletion.
+          # @!attribute [r] consumer_network_status
+          #   @return [::String]
+          #     Output only. The status of the service connection policy.
+          #     Possible values:
+          #       "STATE_UNSPECIFIED" - Default state, when Connection Map is created
+          #     initially.
+          #       "VALID" - Set when policy and map configuration is valid, and their
+          #     matching can lead to allowing creation of PSC Connections subject to
+          #     other constraints like connections limit.
+          #       "CONNECTION_POLICY_MISSING" - No Service Connection Policy found for
+          #     this network and Service Class
+          #       "POLICY_LIMIT_REACHED" - Service Connection Policy limit reached for
+          #       this network and Service Class
+          #       "CONSUMER_INSTANCE_PROJECT_NOT_ALLOWLISTED" - The consumer instance
+          #     project is not in AllowedGoogleProducersResourceHierarchyLevels of the
+          #     matching ServiceConnectionPolicy.
+          class PscAutoConnectionConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
           # PscInstanceConfig contains PSC related configuration at an
           # instance level.
           # @!attribute [r] service_attachment_link
@@ -893,6 +1060,15 @@ module Google
           #   @return [::String]
           #     Output only. The DNS name of the instance for PSC connectivity.
           #     Name convention: <uid>.<uid>.<region>.alloydb-psc.goog
+          # @!attribute [rw] psc_interface_configs
+          #   @return [::Array<::Google::Cloud::AlloyDB::V1::Instance::PscInterfaceConfig>]
+          #     Optional. Configurations for setting up PSC interfaces attached to the
+          #     instance which are used for outbound connectivity. Only primary instances
+          #     can have PSC interface attached. Currently we only support 0 or 1 PSC
+          #     interface.
+          # @!attribute [rw] psc_auto_connections
+          #   @return [::Array<::Google::Cloud::AlloyDB::V1::Instance::PscAutoConnectionConfig>]
+          #     Optional. Configurations for setting up PSC service automation.
           class PscInstanceConfig
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -909,6 +1085,22 @@ module Google
           #   @return [::Boolean]
           #     Optional. Enabling an outbound public IP address to support a database
           #     server sending requests out into the internet.
+          # @!attribute [r] network
+          #   @return [::String]
+          #     Output only. The resource link for the VPC network in which instance
+          #     resources are created and from which they are accessible via Private IP.
+          #     This will be the same value as the parent cluster's network. It is
+          #     specified in the form: //
+          #     `projects/{project_number}/global/networks/{network_id}`.
+          # @!attribute [rw] allocated_ip_range_override
+          #   @return [::String]
+          #     Optional. Name of the allocated IP range for the private IP AlloyDB
+          #     instance, for example: "google-managed-services-default". If set, the
+          #     instance IPs will be created from this allocated range and will override
+          #     the IP range used by the parent cluster. The range name must comply with
+          #     [RFC 1035](http://datatracker.ietf.org/doc/html/rfc1035). Specifically,
+          #     the name must be 1-63 characters long and match the regular expression
+          #     [a-z]([-a-z0-9]*[a-z0-9])?.
           class InstanceNetworkConfig
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1022,6 +1214,18 @@ module Google
             # Regional (or Highly) available instance.
             REGIONAL = 2
           end
+
+          # Specifies whether an instance needs to spin up.
+          module ActivationPolicy
+            # The policy is not specified.
+            ACTIVATION_POLICY_UNSPECIFIED = 0
+
+            # The instance is running.
+            ALWAYS = 1
+
+            # The instance is not running.
+            NEVER = 2
+          end
         end
 
         # ConnectionInfo singleton resource.
@@ -1074,9 +1278,15 @@ module Google
         # @!attribute [r] update_time
         #   @return [::Google::Protobuf::Timestamp]
         #     Output only. Update time stamp
+        #
+        #     Users should not infer any meaning from this field. Its value is generally
+        #     unrelated to the timing of the backup creation operation.
         # @!attribute [r] delete_time
         #   @return [::Google::Protobuf::Timestamp]
         #     Output only. Delete time stamp
+        # @!attribute [r] create_completion_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Timestamp when the resource finished being created.
         # @!attribute [rw] labels
         #   @return [::Google::Protobuf::Map{::String => ::String}]
         #     Labels as key value pairs
@@ -1258,6 +1468,16 @@ module Google
         #     Restriction on INTEGER type value.
         #
         #     Note: The following fields are mutually exclusive: `integer_restrictions`, `string_restrictions`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] recommended_string_value
+        #   @return [::String]
+        #     The recommended value for a STRING flag.
+        #
+        #     Note: The following fields are mutually exclusive: `recommended_string_value`, `recommended_integer_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
+        # @!attribute [rw] recommended_integer_value
+        #   @return [::Google::Protobuf::Int64Value]
+        #     The recommended value for an INTEGER flag.
+        #
+        #     Note: The following fields are mutually exclusive: `recommended_integer_value`, `recommended_string_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] name
         #   @return [::String]
         #     The name of the flag resource, following Google Cloud conventions, e.g.:
@@ -1282,6 +1502,9 @@ module Google
         #     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).
+        # @!attribute [rw] scope
+        #   @return [::Google::Cloud::AlloyDB::V1::SupportedDatabaseFlag::Scope]
+        #     The scope of the flag.
         class SupportedDatabaseFlag
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1327,6 +1550,18 @@ module Google
             # Denotes that the flag does not accept any values.
             NONE = 4
           end
+
+          # The scope of the flag.
+          module Scope
+            # The scope of the flag is not specified. Default is DATABASE.
+            SCOPE_UNSPECIFIED = 0
+
+            # The flag is a database flag.
+            DATABASE = 1
+
+            # The flag is a connection pool flag.
+            CONNECTION_POOL = 2
+          end
         end
 
         # Message describing User object.