google-cloud-gke_backup-v1 0.3.0 → 0.5.0

data/proto_docs/google/api/client.rb

@@ -35,7 +35,9 @@ module Google
     # Details about how and where to publish client libraries.
     # @!attribute [rw] version
     #   @return [::String]
-    #     Version of the API to apply these settings to.
+    #     Version of the API to apply these settings to. This is the full protobuf
+    #     package for the API, ending in the version element.
+    #     Examples: "google.cloud.speech.v1" and "google.spanner.admin.database.v1".
     # @!attribute [rw] launch_stage
     #   @return [::Google::Api::LaunchStage]
     #     Launch stage of this version of the API.
@@ -81,7 +83,7 @@ module Google
     #     long-running operation pattern.
     # @!attribute [rw] new_issue_uri
     #   @return [::String]
-    #     Link to a place that API users can report issues.  Example:
+    #     Link to a *public* URI where users can report issues.  Example:
     #     https://issuetracker.google.com/issues/new?component=190865&template=1161103
     # @!attribute [rw] documentation_uri
     #   @return [::String]
@@ -111,6 +113,10 @@ module Google
     #     Client library settings.  If the same version string appears multiple
     #     times in this list, then the last one wins.  Settings from earlier
     #     settings with the same version string are discarded.
+    # @!attribute [rw] proto_reference_documentation_uri
+    #   @return [::String]
+    #     Optional link to proto reference documentation.  Example:
+    #     https://cloud.google.com/pubsub/lite/docs/reference/rpc
     class Publishing
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -203,9 +209,57 @@ module Google
     # @!attribute [rw] common
     #   @return [::Google::Api::CommonLanguageSettings]
     #     Some settings.
+    # @!attribute [rw] renamed_services
+    #   @return [::Google::Protobuf::Map{::String => ::String}]
+    #     Map from original service names to renamed versions.
+    #     This is used when the default generated types
+    #     would cause a naming conflict. (Neither name is
+    #     fully-qualified.)
+    #     Example: Subscriber to SubscriberServiceApi.
+    # @!attribute [rw] renamed_resources
+    #   @return [::Google::Protobuf::Map{::String => ::String}]
+    #     Map from full resource types to the effective short name
+    #     for the resource. This is used when otherwise resource
+    #     named from different services would cause naming collisions.
+    #     Example entry:
+    #     "datalabeling.googleapis.com/Dataset": "DataLabelingDataset"
+    # @!attribute [rw] ignored_resources
+    #   @return [::Array<::String>]
+    #     List of full resource types to ignore during generation.
+    #     This is typically used for API-specific Location resources,
+    #     which should be handled by the generator as if they were actually
+    #     the common Location resources.
+    #     Example entry: "documentai.googleapis.com/Location"
+    # @!attribute [rw] forced_namespace_aliases
+    #   @return [::Array<::String>]
+    #     Namespaces which must be aliased in snippets due to
+    #     a known (but non-generator-predictable) naming collision
+    # @!attribute [rw] handwritten_signatures
+    #   @return [::Array<::String>]
+    #     Method signatures (in the form "service.method(signature)")
+    #     which are provided separately, so shouldn't be generated.
+    #     Snippets *calling* these methods are still generated, however.
     class DotnetSettings
       include ::Google::Protobuf::MessageExts
       extend ::Google::Protobuf::MessageExts::ClassMethods
+
+      # @!attribute [rw] key
+      #   @return [::String]
+      # @!attribute [rw] value
+      #   @return [::String]
+      class RenamedServicesEntry
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
+
+      # @!attribute [rw] key
+      #   @return [::String]
+      # @!attribute [rw] value
+      #   @return [::String]
+      class RenamedResourcesEntry
+        include ::Google::Protobuf::MessageExts
+        extend ::Google::Protobuf::MessageExts::ClassMethods
+      end
     end
 
     # Settings for Ruby client libraries.
@@ -240,8 +294,8 @@ module Google
     #     Example of a YAML configuration::
     #
     #      publishing:
-    #        method_behavior:
-    #          - selector: CreateAdDomain
+    #        method_settings:
+    #          - selector: google.cloud.speech.v2.Speech.BatchRecognize
     #            long_running:
     #              initial_poll_delay:
     #                seconds: 60 # 1 minute
@@ -299,6 +353,15 @@ module Google
 
       # Street View Org.
       STREET_VIEW = 4
+
+      # Shopping Org.
+      SHOPPING = 5
+
+      # Geo Org.
+      GEO = 6
+
+      # Generative AI - https://developers.generativeai.google
+      GENERATIVE_AI = 7
     end
 
     # To where should client libraries be published?

data/proto_docs/google/cloud/gkebackup/v1/backup.rb

@@ -29,7 +29,7 @@ module Google
         # @!attribute [r] name
         #   @return [::String]
         #     Output only. The fully qualified name of the Backup.
-        #     projects/*/locations/*/backupPlans/*/backups/*
+        #     `projects/*/locations/*/backupPlans/*/backups/*`
         # @!attribute [r] uid
         #   @return [::String]
         #     Output only. Server generated global unique identifier of
@@ -42,9 +42,9 @@ module Google
         #     Output only. The timestamp when this Backup resource was last updated.
         # @!attribute [r] manual
         #   @return [::Boolean]
-        #     Output only. This flag indicates whether this Backup resource was created manually
-        #     by a user or via a schedule in the BackupPlan. A value of True means that
-        #     the Backup was created manually.
+        #     Output only. This flag indicates whether this Backup resource was created
+        #     manually by a user or via a schedule in the BackupPlan. A value of True
+        #     means that the Backup was created manually.
         # @!attribute [rw] labels
         #   @return [::Google::Protobuf::Map{::String => ::String}]
         #     A set of custom labels supplied by user.
@@ -62,75 +62,87 @@ module Google
         #     (either at creation time or in a subsequent update).
         # @!attribute [r] delete_lock_expire_time
         #   @return [::Google::Protobuf::Timestamp]
-        #     Output only. The time at which an existing delete lock will expire for this backup
-        #     (calculated from create_time + {::Google::Cloud::GkeBackup::V1::Backup#delete_lock_days delete_lock_days}).
+        #     Output only. The time at which an existing delete lock will expire for this
+        #     backup (calculated from create_time +
+        #     {::Google::Cloud::GkeBackup::V1::Backup#delete_lock_days delete_lock_days}).
         # @!attribute [rw] retain_days
         #   @return [::Integer]
         #     The age (in days) after which this Backup will be automatically deleted.
         #     Must be an integer value >= 0:
         #
         #     - If 0, no automatic deletion will occur for this Backup.
-        #     - If not 0, this must be >= {::Google::Cloud::GkeBackup::V1::Backup#delete_lock_days delete_lock_days}.
+        #     - If not 0, this must be >=
+        #     {::Google::Cloud::GkeBackup::V1::Backup#delete_lock_days delete_lock_days} and
+        #     <= 365.
         #
         #     Once a Backup is created, this value may only be increased.
         #
         #     Defaults to the parent BackupPlan's
-        #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_retain_days backup_retain_days} value.
+        #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_retain_days backup_retain_days}
+        #     value.
         # @!attribute [r] retain_expire_time
         #   @return [::Google::Protobuf::Timestamp]
-        #     Output only. The time at which this Backup will be automatically deleted (calculated
-        #     from create_time + {::Google::Cloud::GkeBackup::V1::Backup#retain_days retain_days}).
+        #     Output only. The time at which this Backup will be automatically deleted
+        #     (calculated from create_time +
+        #     {::Google::Cloud::GkeBackup::V1::Backup#retain_days retain_days}).
         # @!attribute [r] encryption_key
         #   @return [::Google::Cloud::GkeBackup::V1::EncryptionKey]
-        #     Output only. The customer managed encryption key that was used to encrypt the Backup's
-        #     artifacts.  Inherited from the parent BackupPlan's
-        #     {::Google::Cloud::GkeBackup::V1::BackupPlan::BackupConfig#encryption_key encryption_key} value.
+        #     Output only. The customer managed encryption key that was used to encrypt
+        #     the Backup's artifacts.  Inherited from the parent BackupPlan's
+        #     {::Google::Cloud::GkeBackup::V1::BackupPlan::BackupConfig#encryption_key encryption_key}
+        #     value.
         # @!attribute [r] all_namespaces
         #   @return [::Boolean]
         #     Output only. If True, all namespaces were included in the Backup.
         # @!attribute [r] selected_namespaces
         #   @return [::Google::Cloud::GkeBackup::V1::Namespaces]
-        #     Output only. If set, the list of namespaces that were included in the Backup.
+        #     Output only. If set, the list of namespaces that were included in the
+        #     Backup.
         # @!attribute [r] selected_applications
         #   @return [::Google::Cloud::GkeBackup::V1::NamespacedNames]
-        #     Output only. If set, the list of ProtectedApplications whose resources were included
-        #     in the Backup.
+        #     Output only. If set, the list of ProtectedApplications whose resources
+        #     were included in the Backup.
         # @!attribute [r] contains_volume_data
         #   @return [::Boolean]
-        #     Output only. Whether or not the Backup contains volume data.  Controlled by the parent
-        #     BackupPlan's
-        #     {::Google::Cloud::GkeBackup::V1::BackupPlan::BackupConfig#include_volume_data include_volume_data} value.
+        #     Output only. Whether or not the Backup contains volume data.  Controlled by
+        #     the parent BackupPlan's
+        #     {::Google::Cloud::GkeBackup::V1::BackupPlan::BackupConfig#include_volume_data include_volume_data}
+        #     value.
         # @!attribute [r] contains_secrets
         #   @return [::Boolean]
-        #     Output only. Whether or not the Backup contains Kubernetes Secrets.  Controlled by the
-        #     parent BackupPlan's
-        #     {::Google::Cloud::GkeBackup::V1::BackupPlan::BackupConfig#include_secrets include_secrets} value.
+        #     Output only. Whether or not the Backup contains Kubernetes Secrets.
+        #     Controlled by the parent BackupPlan's
+        #     {::Google::Cloud::GkeBackup::V1::BackupPlan::BackupConfig#include_secrets include_secrets}
+        #     value.
         # @!attribute [r] cluster_metadata
         #   @return [::Google::Cloud::GkeBackup::V1::Backup::ClusterMetadata]
-        #     Output only. Information about the GKE cluster from which this Backup was created.
+        #     Output only. Information about the GKE cluster from which this Backup was
+        #     created.
         # @!attribute [r] state
         #   @return [::Google::Cloud::GkeBackup::V1::Backup::State]
         #     Output only. Current state of the Backup
         # @!attribute [r] state_reason
         #   @return [::String]
-        #     Output only. Human-readable description of why the backup is in the current `state`.
+        #     Output only. Human-readable description of why the backup is in the current
+        #     `state`.
         # @!attribute [r] complete_time
         #   @return [::Google::Protobuf::Timestamp]
         #     Output only. Completion time of the Backup
         # @!attribute [r] resource_count
         #   @return [::Integer]
-        #     Output only. The total number of Kubernetes resources included in the Backup.
+        #     Output only. The total number of Kubernetes resources included in the
+        #     Backup.
         # @!attribute [r] volume_count
         #   @return [::Integer]
         #     Output only. The total number of volume backups contained in the Backup.
         # @!attribute [r] size_bytes
         #   @return [::Integer]
-        #     Output only. The total size of the Backup in bytes = config backup size + sum(volume
-        #     backup sizes)
+        #     Output only. The total size of the Backup in bytes = config backup size +
+        #     sum(volume backup sizes)
         # @!attribute [r] etag
         #   @return [::String]
-        #     Output only. `etag` is used for optimistic concurrency control as a way to help
-        #     prevent simultaneous updates of a backup from overwriting each other.
+        #     Output only. `etag` is used for optimistic concurrency control as a way to
+        #     help prevent simultaneous updates of a backup from overwriting each other.
         #     It is strongly suggested that systems make use of the `etag` in the
         #     read-modify-write cycle to perform backup updates in order to avoid
         #     race conditions: An `etag` is returned in the response to `GetBackup`,
@@ -156,8 +168,8 @@ module Google
           #     The source cluster from which this Backup was created.
           #     Valid formats:
           #
-          #       - projects/*/locations/*/clusters/*
-          #       - projects/*/zones/*/clusters/*
+          #       - `projects/*/locations/*/clusters/*`
+          #       - `projects/*/zones/*/clusters/*`
           #
           #     This is inherited from the parent BackupPlan's
           #     {::Google::Cloud::GkeBackup::V1::BackupPlan#cluster cluster} field.

data/proto_docs/google/cloud/gkebackup/v1/backup_plan.rb

@@ -25,7 +25,7 @@ module Google
         # @!attribute [r] name
         #   @return [::String]
         #     Output only. The full name of the BackupPlan resource.
-        #     Format: projects/*/locations/*/backupPlans/*
+        #     Format: `projects/*/locations/*/backupPlans/*`
         # @!attribute [r] uid
         #   @return [::String]
         #     Output only. Server generated global unique identifier of
@@ -42,12 +42,11 @@ module Google
         #     User specified descriptive string for this BackupPlan.
         # @!attribute [rw] cluster
         #   @return [::String]
-        #     Required. Immutable. The source cluster from which Backups will be created via
-        #     this BackupPlan.
-        #     Valid formats:
+        #     Required. Immutable. The source cluster from which Backups will be created
+        #     via this BackupPlan. Valid formats:
         #
-        #     - projects/*/locations/*/clusters/*
-        #     - projects/*/zones/*/clusters/*
+        #     - `projects/*/locations/*/clusters/*`
+        #     - `projects/*/zones/*/clusters/*`
         # @!attribute [rw] retention_policy
         #   @return [::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy]
         #     RetentionPolicy governs lifecycle of Backups created under this plan.
@@ -59,9 +58,9 @@ module Google
         #     Defines a schedule for automatic Backup creation via this BackupPlan.
         # @!attribute [r] etag
         #   @return [::String]
-        #     Output only. `etag` is used for optimistic concurrency control as a way to help
-        #     prevent simultaneous updates of a backup plan from overwriting each other.
-        #     It is strongly suggested that systems make use of the 'etag' in the
+        #     Output only. `etag` is used for optimistic concurrency control as a way to
+        #     help prevent simultaneous updates of a backup plan from overwriting each
+        #     other. It is strongly suggested that systems make use of the 'etag' in the
         #     read-modify-write cycle to perform BackupPlan updates in order to avoid
         #     race conditions: An `etag` is returned in the response to `GetBackupPlan`,
         #     and systems are expected to put that etag in the request to
@@ -83,6 +82,16 @@ module Google
         #   @return [::Integer]
         #     Output only. The number of Kubernetes Pods backed up in the
         #     last successful Backup created via this BackupPlan.
+        # @!attribute [r] state
+        #   @return [::Google::Cloud::GkeBackup::V1::BackupPlan::State]
+        #     Output only. State of the BackupPlan. This State field reflects the
+        #     various stages a BackupPlan can be in
+        #     during the Create operation. It will be set to "DEACTIVATED"
+        #     if the BackupPlan is deactivated on an Update
+        # @!attribute [r] state_reason
+        #   @return [::String]
+        #     Output only. Human-readable description of why BackupPlan is in the current
+        #     `state`
         class BackupPlan
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -102,7 +111,7 @@ module Google
           # @!attribute [rw] backup_retain_days
           #   @return [::Integer]
           #     The default maximum age of a Backup created via this BackupPlan.
-          #     This field MUST be an integer value >= 0.
+          #     This field MUST be an integer value >= 0 and <= 365.
           #     If specified, a Backup created under this BackupPlan will be
           #     automatically deleted after its age reaches (create_time +
           #     backup_retain_days).
@@ -111,7 +120,12 @@ module Google
           #     Updating this field does NOT affect existing Backups under it. Backups
           #     created AFTER a successful update will automatically pick up the new
           #     value.
-          #     NOTE: backup_retain_days must be >= {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_delete_lock_days backup_delete_lock_days}.
+          #     NOTE: backup_retain_days must be >=
+          #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_delete_lock_days backup_delete_lock_days}.
+          #     If
+          #     {::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule#cron_schedule cron_schedule}
+          #     is defined, then this must be
+          #     <= 360 * the creation interval.
           #
           #     Default: 0 (no automatic deletion)
           # @!attribute [rw] locked
@@ -126,12 +140,15 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
-          # Schedule defines scheduling parameters for automatically creating Backups
+          # Defines scheduling parameters for automatically creating Backups
           # via this BackupPlan.
           # @!attribute [rw] cron_schedule
           #   @return [::String]
           #     A standard [cron](https://wikipedia.com/wiki/cron) string that defines a
-          #     repeating schedule for creating Backups via this BackupPlan.
+          #     repeating schedule for creating Backups via this BackupPlan. If this is
+          #     defined, then
+          #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_retain_days backup_retain_days}
+          #     must also be defined.
           #
           #     Default (empty): no automatic backup creation will occur.
           # @!attribute [rw] paused
@@ -189,6 +206,30 @@ module Google
             include ::Google::Protobuf::MessageExts
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
+
+          # State
+          module State
+            # Default first value for Enums.
+            STATE_UNSPECIFIED = 0
+
+            # Waiting for cluster state to be RUNNING.
+            CLUSTER_PENDING = 1
+
+            # The BackupPlan is in the process of being created.
+            PROVISIONING = 2
+
+            # The BackupPlan has successfully been created and is ready for Backups.
+            READY = 3
+
+            # BackupPlan creation has failed.
+            FAILED = 4
+
+            # The BackupPlan has been deactivated.
+            DEACTIVATED = 5
+
+            # The BackupPlan is in the process of being deleted.
+            DELETING = 6
+          end
         end
       end
     end

data/proto_docs/google/cloud/gkebackup/v1/common.rb

@@ -56,7 +56,7 @@ module Google
         # @!attribute [rw] gcp_kms_encryption_key
         #   @return [::String]
         #     Google Cloud KMS encryption key. Format:
-        #     projects/*/locations/*/keyRings/*/cryptoKeys/*
+        #     `projects/*/locations/*/keyRings/*/cryptoKeys/*`
         class EncryptionKey
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods