google-cloud-gke_backup-v1 1.0.0 → 1.1.0

data/proto_docs/google/api/field_info.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+# Copyright 2025 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 Api
+    # Rich semantic information of an API field beyond basic typing.
+    # @!attribute [rw] format
+    #   @return [::Google::Api::FieldInfo::Format]
+    #     The standard format of a field value. This does not explicitly configure
+    #     any API consumer, just documents the API's format for the field it is
+    #     applied to.
+    # @!attribute [rw] referenced_types
+    #   @return [::Array<::Google::Api::TypeReference>]
+    #     The type(s) that the annotated, generic field may represent.
+    #
+    #     Currently, this must only be used on fields of type `google.protobuf.Any`.
+    #     Supporting other generic types may be considered in the future.
+    class FieldInfo
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+
+      # The standard format of a field value. The supported formats are all backed
+      # by either an RFC defined by the IETF or a Google-defined AIP.
+      module Format
+        # Default, unspecified value.
+        FORMAT_UNSPECIFIED = 0
+
+        # Universally Unique Identifier, version 4, value as defined by
+        # https://datatracker.ietf.org/doc/html/rfc4122. The value may be
+        # normalized to entirely lowercase letters. For example, the value
+        # `F47AC10B-58CC-0372-8567-0E02B2C3D479` would be normalized to
+        # `f47ac10b-58cc-0372-8567-0e02b2c3d479`.
+        UUID4 = 1
+
+        # Internet Protocol v4 value as defined by [RFC
+        # 791](https://datatracker.ietf.org/doc/html/rfc791). The value may be
+        # condensed, with leading zeros in each octet stripped. For example,
+        # `001.022.233.040` would be condensed to `1.22.233.40`.
+        IPV4 = 2
+
+        # Internet Protocol v6 value as defined by [RFC
+        # 2460](https://datatracker.ietf.org/doc/html/rfc2460). The value may be
+        # normalized to entirely lowercase letters with zeros compressed, following
+        # [RFC 5952](https://datatracker.ietf.org/doc/html/rfc5952). For example,
+        # the value `2001:0DB8:0::0` would be normalized to `2001:db8::`.
+        IPV6 = 3
+
+        # An IP address in either v4 or v6 format as described by the individual
+        # values defined herein. See the comments on the IPV4 and IPV6 types for
+        # allowed normalizations of each.
+        IPV4_OR_IPV6 = 4
+      end
+    end
+
+    # A reference to a message type, for use in {::Google::Api::FieldInfo FieldInfo}.
+    # @!attribute [rw] type_name
+    #   @return [::String]
+    #     The name of the type that the annotated, generic field may represent.
+    #     If the type is in the same protobuf package, the value can be the simple
+    #     message name e.g., `"MyMessage"`. Otherwise, the value must be the
+    #     fully-qualified message name e.g., `"google.library.v1.Book"`.
+    #
+    #     If the type(s) are unknown to the service (e.g. the field accepts generic
+    #     user input), use the wildcard `"*"` to denote this behavior.
+    #
+    #     See [AIP-202](https://google.aip.dev/202#type-references) for more details.
+    class TypeReference
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

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

@@ -129,7 +129,8 @@ module Google
         # @!attribute [r] state_reason
         #   @return [::String]
         #     Output only. Human-readable description of why the backup is in the current
-        #     `state`.
+        #     `state`. This field is only meant for human readability and should not be
+        #     used programmatically as this field is not guaranteed to be consistent.
         # @!attribute [r] complete_time
         #   @return [::Google::Protobuf::Timestamp]
         #     Output only. Completion time of the Backup
@@ -172,6 +173,12 @@ module Google
         #     Inherited from the parent BackupPlan's
         #     {::Google::Cloud::GkeBackup::V1::BackupPlan::BackupConfig#permissive_mode permissive_mode}
         #     value.
+        # @!attribute [r] satisfies_pzs
+        #   @return [::Boolean]
+        #     Output only. [Output Only] Reserved for future use.
+        # @!attribute [r] satisfies_pzi
+        #   @return [::Boolean]
+        #     Output only. [Output Only] Reserved for future use.
         class Backup
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+# Copyright 2025 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 GkeBackup
+      module V1
+        # A BackupChannel imposes constraints on where clusters can be backed up.
+        # The BackupChannel should be in the same project and region
+        # as the cluster being backed up.
+        # The backup can be created only in destination_project.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Identifier. The fully qualified name of the BackupChannel.
+        #     `projects/*/locations/*/backupChannels/*`
+        # @!attribute [rw] destination_project
+        #   @return [::String]
+        #     Required. Immutable. The project where Backups are allowed to be stored.
+        #     The format is `projects/{project}`.
+        #     Currently, \\{project} can only be the project number. Support for project
+        #     IDs will be added in the future.
+        # @!attribute [r] uid
+        #   @return [::String]
+        #     Output only. Server generated global unique identifier of
+        #     [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) format.
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The timestamp when this BackupChannel resource was created.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The timestamp when this BackupChannel resource was last
+        #     updated.
+        # @!attribute [rw] labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Optional. A set of custom labels supplied by user.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     Optional. User specified descriptive string for this BackupChannel.
+        # @!attribute [r] etag
+        #   @return [::String]
+        #     Output only. `etag` is used for optimistic concurrency control as a way to
+        #     help prevent simultaneous updates of a BackupChannel from overwriting each
+        #     other. It is strongly suggested that systems make use of the 'etag' in the
+        #     read-modify-write cycle to perform BackupChannel updates in order to
+        #     avoid race conditions: An `etag` is returned in the response to
+        #     `GetBackupChannel`, and systems are expected to put that etag in the
+        #     request to `UpdateBackupChannel` or `DeleteBackupChannel` to
+        #     ensure that their change will be applied to the same version of the
+        #     resource.
+        # @!attribute [r] destination_project_id
+        #   @return [::String]
+        #     Output only. The project_id where Backups are allowed to be stored.
+        #     Example Project ID: "my-project-id".
+        #     This will be an OUTPUT_ONLY field to return the project_id of the
+        #     destination project.
+        class BackupChannel
+          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
+        end
+      end
+    end
+  end
+end

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

@@ -93,7 +93,8 @@ module Google
         # @!attribute [r] state_reason
         #   @return [::String]
         #     Output only. Human-readable description of why BackupPlan is in the current
-        #     `state`
+        #     `state`. This field is only meant for human readability and should not be
+        #     used programmatically as this field is not guaranteed to be consistent.
         # @!attribute [r] rpo_risk_level
         #   @return [::Integer]
         #     Output only. A number that represents the current risk level of this
@@ -103,6 +104,12 @@ module Google
         #   @return [::String]
         #     Output only. Human-readable description of why the BackupPlan is in the
         #     current rpo_risk_level and action items if any.
+        # @!attribute [r] last_successful_backup_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. Completion time of the last successful Backup. This is sourced
+        #     from a successful Backup's complete_time field. This field is added to
+        #     maintain consistency with BackupPlanBinding to display last successful
+        #     backup time.
         class BackupPlan
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

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

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+# Copyright 2025 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 GkeBackup
+      module V1
+        # A BackupPlanBinding binds a BackupPlan with a BackupChannel.
+        # This resource is created automatically when a BackupPlan is created using a
+        # BackupChannel. This also serves as a holder for cross-project fields
+        # that need to be displayed in the current project.
+        # @!attribute [rw] name
+        #   @return [::String]
+        #     Identifier. The fully qualified name of the BackupPlanBinding.
+        #     `projects/*/locations/*/backupChannels/*/backupPlanBindings/*`
+        # @!attribute [r] uid
+        #   @return [::String]
+        #     Output only. Server generated global unique identifier of
+        #     [UUID4](https://en.wikipedia.org/wiki/Universally_unique_identifier)
+        # @!attribute [r] create_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The timestamp when this binding was created.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The timestamp when this binding was created.
+        # @!attribute [r] backup_plan
+        #   @return [::String]
+        #     Output only. Immutable. The fully qualified name of the BackupPlan bound
+        #     with the parent BackupChannel.
+        #     `projects/*/locations/*/backupPlans/{backup_plan}`
+        # @!attribute [r] cluster
+        #   @return [::String]
+        #     Output only. Immutable. The fully qualified name of the cluster that is
+        #     being backed up Valid formats:
+        #
+        #     - `projects/*/locations/*/clusters/*`
+        #     - `projects/*/zones/*/clusters/*`
+        # @!attribute [r] backup_plan_details
+        #   @return [::Google::Cloud::GkeBackup::V1::BackupPlanBinding::BackupPlanDetails]
+        #     Output only. Contains details about the backup plan/backup.
+        # @!attribute [r] etag
+        #   @return [::String]
+        #     Output only. `etag` is used for optimistic concurrency control as a way to
+        #     help prevent simultaneous updates of a BackupPlanBinding from overwriting
+        #     each other. It is strongly suggested that systems make use of the 'etag' in
+        #     the read-modify-write cycle to perform BackupPlanBinding updates in
+        #     order to avoid race conditions: An `etag` is returned in the response to
+        #     `GetBackupPlanBinding`, and systems are expected to put that etag in
+        #     the request to `UpdateBackupPlanBinding` or
+        #     `DeleteBackupPlanBinding` to ensure that their change will be applied
+        #     to the same version of the resource.
+        class BackupPlanBinding
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Contains metadata about the backup plan/backup.
+          # @!attribute [r] protected_pod_count
+          #   @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::BackupPlanBinding::BackupPlanDetails::State]
+          #     Output only. State of the BackupPlan.
+          # @!attribute [r] last_successful_backup_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Output only. Completion time of the last successful Backup. This is
+          #     sourced from a successful Backup's complete_time field.
+          # @!attribute [r] next_scheduled_backup_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Output only. Start time of next scheduled backup under this BackupPlan by
+          #     either cron_schedule or rpo config. This is sourced from BackupPlan.
+          # @!attribute [r] rpo_risk_level
+          #   @return [::Integer]
+          #     Output only. A number that represents the current risk level of this
+          #     BackupPlan from RPO perspective with 1 being no risk and 5 being highest
+          #     risk.
+          # @!attribute [r] last_successful_backup
+          #   @return [::String]
+          #     Output only. The fully qualified name of the last successful Backup
+          #     created under this BackupPlan.
+          #     `projects/*/locations/*/backupPlans/*/backups/*`
+          class BackupPlanDetails
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # 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
+    end
+  end
+end

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

@@ -21,10 +21,10 @@ module Google
   module Cloud
     module GkeBackup
       module V1
-        # A list of Kubernetes Namespaces
+        # A list of Kubernetes Namespaces.
         # @!attribute [rw] namespaces
         #   @return [::Array<::String>]
-        #     Optional. A list of Kubernetes Namespaces
+        #     Optional. A list of Kubernetes Namespaces.
         class Namespaces
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods