google-cloud-gke_backup-v1 0.a → 0.1.0

data/proto_docs/google/api/resource.rb

@@ -0,0 +1,222 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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
+    # A simple descriptor of a resource type.
+    #
+    # ResourceDescriptor annotates a resource message (either by means of a
+    # protobuf annotation or use in the service config), and associates the
+    # resource's schema, the resource type, and the pattern of the resource name.
+    #
+    # Example:
+    #
+    #     message Topic {
+    #       // Indicates this message defines a resource schema.
+    #       // Declares the resource type in the format of {service}/{kind}.
+    #       // For Kubernetes resources, the format is {api group}/{kind}.
+    #       option (google.api.resource) = {
+    #         type: "pubsub.googleapis.com/Topic"
+    #         pattern: "projects/{project}/topics/{topic}"
+    #       };
+    #     }
+    #
+    # The ResourceDescriptor Yaml config will look like:
+    #
+    #     resources:
+    #     - type: "pubsub.googleapis.com/Topic"
+    #       pattern: "projects/{project}/topics/{topic}"
+    #
+    # Sometimes, resources have multiple patterns, typically because they can
+    # live under multiple parents.
+    #
+    # Example:
+    #
+    #     message LogEntry {
+    #       option (google.api.resource) = {
+    #         type: "logging.googleapis.com/LogEntry"
+    #         pattern: "projects/{project}/logs/{log}"
+    #         pattern: "folders/{folder}/logs/{log}"
+    #         pattern: "organizations/{organization}/logs/{log}"
+    #         pattern: "billingAccounts/{billing_account}/logs/{log}"
+    #       };
+    #     }
+    #
+    # The ResourceDescriptor Yaml config will look like:
+    #
+    #     resources:
+    #     - type: 'logging.googleapis.com/LogEntry'
+    #       pattern: "projects/{project}/logs/{log}"
+    #       pattern: "folders/{folder}/logs/{log}"
+    #       pattern: "organizations/{organization}/logs/{log}"
+    #       pattern: "billingAccounts/{billing_account}/logs/{log}"
+    # @!attribute [rw] type
+    #   @return [::String]
+    #     The resource type. It must be in the format of
+    #     \\{service_name}/\\{resource_type_kind}. The `resource_type_kind` must be
+    #     singular and must not include version numbers.
+    #
+    #     Example: `storage.googleapis.com/Bucket`
+    #
+    #     The value of the resource_type_kind must follow the regular expression
+    #     /[A-Za-z][a-zA-Z0-9]+/. It should start with an upper case character and
+    #     should use PascalCase (UpperCamelCase). The maximum number of
+    #     characters allowed for the `resource_type_kind` is 100.
+    # @!attribute [rw] pattern
+    #   @return [::Array<::String>]
+    #     Optional. The relative resource name pattern associated with this resource
+    #     type. The DNS prefix of the full resource name shouldn't be specified here.
+    #
+    #     The path pattern must follow the syntax, which aligns with HTTP binding
+    #     syntax:
+    #
+    #         Template = Segment { "/" Segment } ;
+    #         Segment = LITERAL | Variable ;
+    #         Variable = "{" LITERAL "}" ;
+    #
+    #     Examples:
+    #
+    #         - "projects/\\{project}/topics/\\{topic}"
+    #         - "projects/\\{project}/knowledgeBases/\\{knowledge_base}"
+    #
+    #     The components in braces correspond to the IDs for each resource in the
+    #     hierarchy. It is expected that, if multiple patterns are provided,
+    #     the same component name (e.g. "project") refers to IDs of the same
+    #     type of resource.
+    # @!attribute [rw] name_field
+    #   @return [::String]
+    #     Optional. The field on the resource that designates the resource name
+    #     field. If omitted, this is assumed to be "name".
+    # @!attribute [rw] history
+    #   @return [::Google::Api::ResourceDescriptor::History]
+    #     Optional. The historical or future-looking state of the resource pattern.
+    #
+    #     Example:
+    #
+    #         // The InspectTemplate message originally only supported resource
+    #         // names with organization, and project was added later.
+    #         message InspectTemplate {
+    #           option (google.api.resource) = {
+    #             type: "dlp.googleapis.com/InspectTemplate"
+    #             pattern:
+    #             "organizations/{organization}/inspectTemplates/{inspect_template}"
+    #             pattern: "projects/{project}/inspectTemplates/{inspect_template}"
+    #             history: ORIGINALLY_SINGLE_PATTERN
+    #           };
+    #         }
+    # @!attribute [rw] plural
+    #   @return [::String]
+    #     The plural name used in the resource name and permission names, such as
+    #     'projects' for the resource name of 'projects/\\{project}' and the permission
+    #     name of 'cloudresourcemanager.googleapis.com/projects.get'. It is the same
+    #     concept of the `plural` field in k8s CRD spec
+    #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
+    #
+    #     Note: The plural form is required even for singleton resources. See
+    #     https://aip.dev/156
+    # @!attribute [rw] singular
+    #   @return [::String]
+    #     The same concept of the `singular` field in k8s CRD spec
+    #     https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/
+    #     Such as "project" for the `resourcemanager.googleapis.com/Project` type.
+    # @!attribute [rw] style
+    #   @return [::Array<::Google::Api::ResourceDescriptor::Style>]
+    #     Style flag(s) for this resource.
+    #     These indicate that a resource is expected to conform to a given
+    #     style. See the specific style flags for additional information.
+    class ResourceDescriptor
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+
+      # A description of the historical or future-looking state of the
+      # resource pattern.
+      module History
+        # The "unset" value.
+        HISTORY_UNSPECIFIED = 0
+
+        # The resource originally had one pattern and launched as such, and
+        # additional patterns were added later.
+        ORIGINALLY_SINGLE_PATTERN = 1
+
+        # The resource has one pattern, but the API owner expects to add more
+        # later. (This is the inverse of ORIGINALLY_SINGLE_PATTERN, and prevents
+        # that from being necessary once there are multiple patterns.)
+        FUTURE_MULTI_PATTERN = 2
+      end
+
+      # A flag representing a specific style that a resource claims to conform to.
+      module Style
+        # The unspecified value. Do not use.
+        STYLE_UNSPECIFIED = 0
+
+        # This resource is intended to be "declarative-friendly".
+        #
+        # Declarative-friendly resources must be more strictly consistent, and
+        # setting this to true communicates to tools that this resource should
+        # adhere to declarative-friendly expectations.
+        #
+        # Note: This is used by the API linter (linter.aip.dev) to enable
+        # additional checks.
+        DECLARATIVE_FRIENDLY = 1
+      end
+    end
+
+    # Defines a proto annotation that describes a string field that refers to
+    # an API resource.
+    # @!attribute [rw] type
+    #   @return [::String]
+    #     The resource type that the annotated field references.
+    #
+    #     Example:
+    #
+    #         message Subscription {
+    #           string topic = 2 [(google.api.resource_reference) = {
+    #             type: "pubsub.googleapis.com/Topic"
+    #           }];
+    #         }
+    #
+    #     Occasionally, a field may reference an arbitrary resource. In this case,
+    #     APIs use the special value * in their resource reference.
+    #
+    #     Example:
+    #
+    #         message GetIamPolicyRequest {
+    #           string resource = 2 [(google.api.resource_reference) = {
+    #             type: "*"
+    #           }];
+    #         }
+    # @!attribute [rw] child_type
+    #   @return [::String]
+    #     The resource type of a child collection that the annotated field
+    #     references. This is useful for annotating the `parent` field that
+    #     doesn't have a fixed resource type.
+    #
+    #     Example:
+    #
+    #         message ListLogEntriesRequest {
+    #           string parent = 1 [(google.api.resource_reference) = {
+    #             child_type: "logging.googleapis.com/LogEntry"
+    #           };
+    #         }
+    class ResourceReference
+      include ::Google::Protobuf::MessageExts
+      extend ::Google::Protobuf::MessageExts::ClassMethods
+    end
+  end
+end

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

@@ -0,0 +1,226 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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
+        # Represents a request to perform a single point-in-time capture of
+        # some portion of the state of a GKE cluster, the record of the backup
+        # operation itself, and an anchor for the underlying artifacts that
+        # comprise the Backup (the config backup and VolumeBackups).
+        # Next id: 28
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. The fully qualified name of the Backup.
+        #     projects/*/locations/*/backupPlans/*/backups/*
+        # @!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 Backup resource was created.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     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.
+        # @!attribute [rw] labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     A set of custom labels supplied by user.
+        # @!attribute [rw] delete_lock_days
+        #   @return [::Integer]
+        #     Minimum age for this Backup (in days). If this field is set to a non-zero
+        #     value, the Backup will be "locked" against deletion (either manual or
+        #     automatic deletion) for the number of days provided (measured from the
+        #     creation time of the Backup).  MUST be an integer value between 0-90
+        #     (inclusive).
+        #
+        #     Defaults to parent BackupPlan's
+        #     {::Google::Cloud::GkeBackup::V1::BackupPlan::RetentionPolicy#backup_delete_lock_days backup_delete_lock_days}
+        #     setting and may only be increased
+        #     (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}).
+        # @!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}.
+        #
+        #     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.
+        # @!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}).
+        # @!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.
+        # @!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.
+        # @!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.
+        # @!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.
+        # @!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.
+        # @!attribute [r] cluster_metadata
+        #   @return [::Google::Cloud::GkeBackup::V1::Backup::ClusterMetadata]
+        #     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`.
+        # @!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.
+        # @!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)
+        # @!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.
+        #     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`,
+        #     and systems are expected to put that etag in the request to
+        #     `UpdateBackup` or `DeleteBackup` to ensure that their change will be
+        #     applied to the same version of the resource.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     User specified descriptive string for this Backup.
+        # @!attribute [r] pod_count
+        #   @return [::Integer]
+        #     Output only. The total number of Kubernetes Pods contained in the Backup.
+        # @!attribute [r] config_backup_size_bytes
+        #   @return [::Integer]
+        #     Output only. The size of the config backup in bytes.
+        class Backup
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Information about the GKE cluster from which this Backup was created.
+          # @!attribute [rw] cluster
+          #   @return [::String]
+          #     The source cluster from which this Backup was created.
+          #     Valid formats:
+          #
+          #       - projects/*/locations/*/clusters/*
+          #       - projects/*/zones/*/clusters/*
+          #
+          #     This is inherited from the parent BackupPlan's
+          #     {::Google::Cloud::GkeBackup::V1::BackupPlan#cluster cluster} field.
+          # @!attribute [rw] k8s_version
+          #   @return [::String]
+          #     The Kubernetes server version of the source cluster.
+          # @!attribute [rw] backup_crd_versions
+          #   @return [::Google::Protobuf::Map{::String => ::String}]
+          #     A list of the Backup for GKE CRD versions found in the cluster.
+          # @!attribute [rw] gke_version
+          #   @return [::String]
+          #     GKE version
+          # @!attribute [rw] anthos_version
+          #   @return [::String]
+          #     Anthos version
+          class ClusterMetadata
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # @!attribute [rw] key
+            #   @return [::String]
+            # @!attribute [rw] value
+            #   @return [::String]
+            class BackupCrdVersionsEntry
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+
+          # @!attribute [rw] key
+          #   @return [::String]
+          # @!attribute [rw] value
+          #   @return [::String]
+          class LabelsEntry
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # State
+          module State
+            # The Backup resource is in the process of being created.
+            STATE_UNSPECIFIED = 0
+
+            # The Backup resource has been created and the associated BackupJob
+            # Kubernetes resource has been injected into the source cluster.
+            CREATING = 1
+
+            # The gkebackup agent in the cluster has begun executing the backup
+            # operation.
+            IN_PROGRESS = 2
+
+            # The backup operation has completed successfully.
+            SUCCEEDED = 3
+
+            # The backup operation has failed.
+            FAILED = 4
+
+            # This Backup resource (and its associated artifacts) is in the process
+            # of being deleted.
+            DELETING = 5
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,196 @@
+# frozen_string_literal: true
+
+# Copyright 2022 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
+        # Defines the configuration and scheduling for a "line" of Backups.
+        # @!attribute [r] name
+        #   @return [::String]
+        #     Output only. The full name of the BackupPlan resource.
+        #     Format: projects/*/locations/*/backupPlans/*
+        # @!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 BackupPlan resource was created.
+        # @!attribute [r] update_time
+        #   @return [::Google::Protobuf::Timestamp]
+        #     Output only. The timestamp when this BackupPlan resource was last
+        #     updated.
+        # @!attribute [rw] description
+        #   @return [::String]
+        #     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:
+        #
+        #     - 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.
+        # @!attribute [rw] labels
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     A set of custom labels supplied by user.
+        # @!attribute [rw] backup_schedule
+        #   @return [::Google::Cloud::GkeBackup::V1::BackupPlan::Schedule]
+        #     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
+        #     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
+        #     `UpdateBackupPlan` or `DeleteBackupPlan` to ensure that their change
+        #     will be applied to the same version of the resource.
+        # @!attribute [rw] deactivated
+        #   @return [::Boolean]
+        #     This flag indicates whether this BackupPlan has been deactivated.
+        #     Setting this field to True locks the BackupPlan such that no further
+        #     updates will be allowed (except deletes), including the deactivated field
+        #     itself. It also prevents any new Backups from being created via this
+        #     BackupPlan (including scheduled Backups).
+        #
+        #     Default: False
+        # @!attribute [rw] backup_config
+        #   @return [::Google::Cloud::GkeBackup::V1::BackupPlan::BackupConfig]
+        #     Defines the configuration of Backups created via this BackupPlan.
+        # @!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.
+        class BackupPlan
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # RetentionPolicy defines a Backup retention policy for a BackupPlan.
+          # @!attribute [rw] backup_delete_lock_days
+          #   @return [::Integer]
+          #     Minimum age for Backups created via this BackupPlan (in days).
+          #     This field MUST be an integer value between 0-90 (inclusive).
+          #     A Backup created under this BackupPlan will NOT be deletable until it
+          #     reaches Backup's (create_time + backup_delete_lock_days).
+          #     Updating this field of a BackupPlan does NOT affect existing Backups
+          #     under it. Backups created AFTER a successful update will inherit
+          #     the new value.
+          #
+          #     Default: 0 (no delete blocking)
+          # @!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.
+          #     If specified, a Backup created under this BackupPlan will be
+          #     automatically deleted after its age reaches (create_time +
+          #     backup_retain_days).
+          #     If not specified, Backups created under this BackupPlan will NOT be
+          #     subject to automatic deletion.
+          #     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}.
+          #
+          #     Default: 0 (no automatic deletion)
+          # @!attribute [rw] locked
+          #   @return [::Boolean]
+          #     This flag denotes whether the retention policy of this BackupPlan is
+          #     locked.  If set to True, no further update is allowed on this policy,
+          #     including the `locked` field itself.
+          #
+          #     Default: False
+          class RetentionPolicy
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # Schedule 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.
+          #
+          #     Default (empty): no automatic backup creation will occur.
+          # @!attribute [rw] paused
+          #   @return [::Boolean]
+          #     This flag denotes whether automatic Backup creation is paused for this
+          #     BackupPlan.
+          #
+          #     Default: False
+          class Schedule
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
+          # BackupConfig defines the configuration of Backups created via this
+          # BackupPlan.
+          # @!attribute [rw] all_namespaces
+          #   @return [::Boolean]
+          #     If True, include all namespaced resources
+          # @!attribute [rw] selected_namespaces
+          #   @return [::Google::Cloud::GkeBackup::V1::Namespaces]
+          #     If set, include just the resources in the listed namespaces.
+          # @!attribute [rw] selected_applications
+          #   @return [::Google::Cloud::GkeBackup::V1::NamespacedNames]
+          #     If set, include just the resources referenced by the listed
+          #     ProtectedApplications.
+          # @!attribute [rw] include_volume_data
+          #   @return [::Boolean]
+          #     This flag specifies whether volume data should be backed up when
+          #     PVCs are included in the scope of a Backup.
+          #
+          #     Default: False
+          # @!attribute [rw] include_secrets
+          #   @return [::Boolean]
+          #     This flag specifies whether Kubernetes Secret resources should be
+          #     included when they fall into the scope of Backups.
+          #
+          #     Default: False
+          # @!attribute [rw] encryption_key
+          #   @return [::Google::Cloud::GkeBackup::V1::EncryptionKey]
+          #     This defines a customer managed encryption key that will be used to
+          #     encrypt the "config" portion (the Kubernetes resources) of Backups
+          #     created via this plan.
+          #
+          #     Default (empty): Config backup artifacts will not be encrypted.
+          class BackupConfig
+            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
+      end
+    end
+  end
+end