proto_docs/google/cloud/gkebackup/v1/gkebackup.rb in google-cloud-gke_backup-v1-0.8.0 vs proto_docs/google/cloud/gkebackup/v1/gkebackup.rb in google-cloud-gke_backup-v1-0.9.0

- old
+ new

@@ -80,30 +80,30 @@ # @return [::String] # Required. The location that contains the BackupPlans to list. # Format: `projects/*/locations/*` # @!attribute [rw] page_size # @return [::Integer] - # The target number of results to return in a single response. + # Optional. The target number of results to return in a single response. # If not specified, a default value will be chosen by the service. - # Note that the response may inclue a partial list and a caller should + # Note that the response may include a partial list and a caller should # only rely on the response's # {::Google::Cloud::GkeBackup::V1::ListBackupPlansResponse#next_page_token next_page_token} # to determine if there are more instances left to be queried. # @!attribute [rw] page_token # @return [::String] - # The value of + # Optional. The value of # {::Google::Cloud::GkeBackup::V1::ListBackupPlansResponse#next_page_token next_page_token} # received from a previous `ListBackupPlans` call. # Provide this to retrieve the subsequent page in a multi-page list of # results. When paginating, all other parameters provided to # `ListBackupPlans` must match the call that provided the page token. # @!attribute [rw] filter # @return [::String] - # Field match expression used to filter the results. + # Optional. Field match expression used to filter the results. # @!attribute [rw] order_by # @return [::String] - # Field by which to sort the results. + # Optional. Field by which to sort the results. class ListBackupPlansRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end @@ -141,11 +141,11 @@ # @return [::Google::Cloud::GkeBackup::V1::BackupPlan] # Required. A new version of the BackupPlan resource that contains updated # fields. This may be sparsely populated if an `update_mask` is provided. # @!attribute [rw] update_mask # @return [::Google::Protobuf::FieldMask] - # This is used to specify the fields to be overwritten in the + # Optional. This is used to specify the fields to be overwritten in the # BackupPlan targeted for update. The values for each of these # updated fields will be taken from the `backup_plan` provided # with this request. Field names are relative to the root of the resource # (e.g., `description`, `backup_config.include_volume_data`, etc.) # If no `update_mask` is provided, all fields in `backup_plan` will be @@ -162,11 +162,11 @@ # @return [::String] # Required. Fully qualified BackupPlan name. # Format: `projects/*/locations/*/backupPlans/*` # @!attribute [rw] etag # @return [::String] - # If provided, this value must match the current value of the + # Optional. If provided, this value must match the current value of the # target BackupPlan's {::Google::Cloud::GkeBackup::V1::BackupPlan#etag etag} field # or the request is rejected. class DeleteBackupPlanRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods @@ -177,14 +177,14 @@ # @return [::String] # Required. The BackupPlan within which to create the Backup. # Format: `projects/*/locations/*/backupPlans/*` # @!attribute [rw] backup # @return [::Google::Cloud::GkeBackup::V1::Backup] - # The Backup resource to create. + # Optional. The Backup resource to create. # @!attribute [rw] backup_id # @return [::String] - # The client-provided short name for the Backup resource. + # Optional. The client-provided short name for the Backup resource. # This name must: # # - be between 1 and 63 characters long (inclusive) # - consist of only lower-case ASCII letters, numbers, and dashes # - start with a lower-case letter @@ -200,30 +200,30 @@ # @return [::String] # Required. The BackupPlan that contains the Backups to list. # Format: `projects/*/locations/*/backupPlans/*` # @!attribute [rw] page_size # @return [::Integer] - # The target number of results to return in a single response. + # Optional. The target number of results to return in a single response. # If not specified, a default value will be chosen by the service. - # Note that the response may inclue a partial list and a caller should + # Note that the response may include a partial list and a caller should # only rely on the response's # {::Google::Cloud::GkeBackup::V1::ListBackupsResponse#next_page_token next_page_token} # to determine if there are more instances left to be queried. # @!attribute [rw] page_token # @return [::String] - # The value of + # Optional. The value of # {::Google::Cloud::GkeBackup::V1::ListBackupsResponse#next_page_token next_page_token} # received from a previous `ListBackups` call. # Provide this to retrieve the subsequent page in a multi-page list of # results. When paginating, all other parameters provided to # `ListBackups` must match the call that provided the page token. # @!attribute [rw] filter # @return [::String] - # Field match expression used to filter the results. + # Optional. Field match expression used to filter the results. # @!attribute [rw] order_by # @return [::String] - # Field by which to sort the results. + # Optional. Field by which to sort the results. class ListBackupsRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end @@ -257,11 +257,11 @@ # @return [::Google::Cloud::GkeBackup::V1::Backup] # Required. A new version of the Backup resource that contains updated # fields. This may be sparsely populated if an `update_mask` is provided. # @!attribute [rw] update_mask # @return [::Google::Protobuf::FieldMask] - # This is used to specify the fields to be overwritten in the + # Optional. This is used to specify the fields to be overwritten in the # Backup targeted for update. The values for each of these # updated fields will be taken from the `backup_plan` provided # with this request. Field names are relative to the root of the resource. # If no `update_mask` is provided, all fields in `backup` will be # written to the target Backup resource. @@ -277,17 +277,17 @@ # @return [::String] # Required. Name of the Backup resource. # Format: `projects/*/locations/*/backupPlans/*/backups/*` # @!attribute [rw] etag # @return [::String] - # If provided, this value must match the current value of the + # Optional. If provided, this value must match the current value of the # target Backup's {::Google::Cloud::GkeBackup::V1::Backup#etag etag} field or the # request is rejected. # @!attribute [rw] force # @return [::Boolean] - # If set to true, any VolumeBackups below this Backup will also be deleted. - # Otherwise, the request will only succeed if the Backup has no + # Optional. If set to true, any VolumeBackups below this Backup will also be + # deleted. Otherwise, the request will only succeed if the Backup has no # VolumeBackups. class DeleteBackupRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end @@ -297,30 +297,30 @@ # @return [::String] # Required. The Backup that contains the VolumeBackups to list. # Format: `projects/*/locations/*/backupPlans/*/backups/*` # @!attribute [rw] page_size # @return [::Integer] - # The target number of results to return in a single response. + # Optional. The target number of results to return in a single response. # If not specified, a default value will be chosen by the service. - # Note that the response may inclue a partial list and a caller should + # Note that the response may include a partial list and a caller should # only rely on the response's # {::Google::Cloud::GkeBackup::V1::ListVolumeBackupsResponse#next_page_token next_page_token} # to determine if there are more instances left to be queried. # @!attribute [rw] page_token # @return [::String] - # The value of + # Optional. The value of # {::Google::Cloud::GkeBackup::V1::ListVolumeBackupsResponse#next_page_token next_page_token} # received from a previous `ListVolumeBackups` call. # Provide this to retrieve the subsequent page in a multi-page list of # results. When paginating, all other parameters provided to # `ListVolumeBackups` must match the call that provided the page token. # @!attribute [rw] filter # @return [::String] - # Field match expression used to filter the results. + # Optional. Field match expression used to filter the results. # @!attribute [rw] order_by # @return [::String] - # Field by which to sort the results. + # Optional. Field by which to sort the results. class ListVolumeBackupsRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end @@ -378,30 +378,30 @@ # @return [::String] # Required. The location that contains the RestorePlans to list. # Format: `projects/*/locations/*` # @!attribute [rw] page_size # @return [::Integer] - # The target number of results to return in a single response. + # Optional. The target number of results to return in a single response. # If not specified, a default value will be chosen by the service. - # Note that the response may inclue a partial list and a caller should + # Note that the response may include a partial list and a caller should # only rely on the response's # {::Google::Cloud::GkeBackup::V1::ListRestorePlansResponse#next_page_token next_page_token} # to determine if there are more instances left to be queried. # @!attribute [rw] page_token # @return [::String] - # The value of + # Optional. The value of # {::Google::Cloud::GkeBackup::V1::ListRestorePlansResponse#next_page_token next_page_token} # received from a previous `ListRestorePlans` call. # Provide this to retrieve the subsequent page in a multi-page list of # results. When paginating, all other parameters provided to # `ListRestorePlans` must match the call that provided the page token. # @!attribute [rw] filter # @return [::String] - # Field match expression used to filter the results. + # Optional. Field match expression used to filter the results. # @!attribute [rw] order_by # @return [::String] - # Field by which to sort the results. + # Optional. Field by which to sort the results. class ListRestorePlansRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end @@ -439,11 +439,11 @@ # @return [::Google::Cloud::GkeBackup::V1::RestorePlan] # Required. A new version of the RestorePlan resource that contains updated # fields. This may be sparsely populated if an `update_mask` is provided. # @!attribute [rw] update_mask # @return [::Google::Protobuf::FieldMask] - # This is used to specify the fields to be overwritten in the + # Optional. This is used to specify the fields to be overwritten in the # RestorePlan targeted for update. The values for each of these # updated fields will be taken from the `restore_plan` provided # with this request. Field names are relative to the root of the resource. # If no `update_mask` is provided, all fields in `restore_plan` will be # written to the target RestorePlan resource. @@ -459,17 +459,17 @@ # @return [::String] # Required. Fully qualified RestorePlan name. # Format: `projects/*/locations/*/restorePlans/*` # @!attribute [rw] etag # @return [::String] - # If provided, this value must match the current value of the + # Optional. If provided, this value must match the current value of the # target RestorePlan's {::Google::Cloud::GkeBackup::V1::RestorePlan#etag etag} # field or the request is rejected. # @!attribute [rw] force # @return [::Boolean] - # If set to true, any Restores below this RestorePlan will also be deleted. - # Otherwise, the request will only succeed if the RestorePlan has no + # Optional. If set to true, any Restores below this RestorePlan will also be + # deleted. Otherwise, the request will only succeed if the RestorePlan has no # Restores. class DeleteRestorePlanRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end @@ -502,30 +502,30 @@ # @return [::String] # Required. The RestorePlan that contains the Restores to list. # Format: `projects/*/locations/*/restorePlans/*` # @!attribute [rw] page_size # @return [::Integer] - # The target number of results to return in a single response. + # Optional. The target number of results to return in a single response. # If not specified, a default value will be chosen by the service. - # Note that the response may inclue a partial list and a caller should + # Note that the response may include a partial list and a caller should # only rely on the response's # {::Google::Cloud::GkeBackup::V1::ListRestoresResponse#next_page_token next_page_token} # to determine if there are more instances left to be queried. # @!attribute [rw] page_token # @return [::String] - # The value of + # Optional. The value of # {::Google::Cloud::GkeBackup::V1::ListRestoresResponse#next_page_token next_page_token} # received from a previous `ListRestores` call. # Provide this to retrieve the subsequent page in a multi-page list of # results. When paginating, all other parameters provided to `ListRestores` # must match the call that provided the page token. # @!attribute [rw] filter # @return [::String] - # Field match expression used to filter the results. + # Optional. Field match expression used to filter the results. # @!attribute [rw] order_by # @return [::String] - # Field by which to sort the results. + # Optional. Field by which to sort the results. class ListRestoresRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end @@ -562,11 +562,11 @@ # @return [::Google::Cloud::GkeBackup::V1::Restore] # Required. A new version of the Restore resource that contains updated # fields. This may be sparsely populated if an `update_mask` is provided. # @!attribute [rw] update_mask # @return [::Google::Protobuf::FieldMask] - # This is used to specify the fields to be overwritten in the + # Optional. This is used to specify the fields to be overwritten in the # Restore targeted for update. The values for each of these # updated fields will be taken from the `restore` provided # with this request. Field names are relative to the root of the resource. # If no `update_mask` is provided, all fields in `restore` will be # written to the target Restore resource. @@ -582,17 +582,17 @@ # @return [::String] # Required. Full name of the Restore # Format: `projects/*/locations/*/restorePlans/*/restores/*` # @!attribute [rw] etag # @return [::String] - # If provided, this value must match the current value of the + # Optional. If provided, this value must match the current value of the # target Restore's {::Google::Cloud::GkeBackup::V1::Restore#etag etag} field or # the request is rejected. # @!attribute [rw] force # @return [::Boolean] - # If set to true, any VolumeRestores below this restore will also be deleted. - # Otherwise, the request will only succeed if the restore has no + # Optional. If set to true, any VolumeRestores below this restore will also + # be deleted. Otherwise, the request will only succeed if the restore has no # VolumeRestores. class DeleteRestoreRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end @@ -602,30 +602,30 @@ # @return [::String] # Required. The Restore that contains the VolumeRestores to list. # Format: `projects/*/locations/*/restorePlans/*/restores/*` # @!attribute [rw] page_size # @return [::Integer] - # The target number of results to return in a single response. + # Optional. The target number of results to return in a single response. # If not specified, a default value will be chosen by the service. - # Note that the response may inclue a partial list and a caller should + # Note that the response may include a partial list and a caller should # only rely on the response's # {::Google::Cloud::GkeBackup::V1::ListVolumeRestoresResponse#next_page_token next_page_token} # to determine if there are more instances left to be queried. # @!attribute [rw] page_token # @return [::String] - # The value of + # Optional. The value of # {::Google::Cloud::GkeBackup::V1::ListVolumeRestoresResponse#next_page_token next_page_token} # received from a previous `ListVolumeRestores` call. # Provide this to retrieve the subsequent page in a multi-page list of # results. When paginating, all other parameters provided to # `ListVolumeRestores` must match the call that provided the page token. # @!attribute [rw] filter # @return [::String] - # Field match expression used to filter the results. + # Optional. Field match expression used to filter the results. # @!attribute [rw] order_by # @return [::String] - # Field by which to sort the results. + # Optional. Field by which to sort the results. class ListVolumeRestoresRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end @@ -649,9 +649,28 @@ # @!attribute [rw] name # @return [::String] # Required. Full name of the VolumeRestore resource. # Format: `projects/*/locations/*/restorePlans/*/restores/*/volumeRestores/*` class GetVolumeRestoreRequest + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + end + + # Request message for GetBackupIndexDownloadUrl. + # @!attribute [rw] backup + # @return [::String] + # Required. Full name of Backup resource. + # Format: + # projects/\\{project}/locations/\\{location}/backupPlans/\\{backup_plan}/backups/\\{backup} + class GetBackupIndexDownloadUrlRequest + include ::Google::Protobuf::MessageExts + extend ::Google::Protobuf::MessageExts::ClassMethods + end + + # Response message for GetBackupIndexDownloadUrl. + # @!attribute [rw] signed_url + # @return [::String] + class GetBackupIndexDownloadUrlResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end end