proto_docs/google/cloud/gkebackup/v1/gkebackup.rb in google-cloud-gke_backup-v1-0.4.0 vs proto_docs/google/cloud/gkebackup/v1/gkebackup.rb in google-cloud-gke_backup-v1-0.5.0

- old
+ new

@@ -39,12 +39,13 @@ # Output only. Human-readable status of the operation, if any. # @!attribute [r] requested_cancellation # @return [::Boolean] # Output only. Identifies whether the user has requested cancellation # of the operation. Operations that have successfully been cancelled - # have [Operation.error][] value with a {::Google::Rpc::Status#code google.rpc.Status.code} of 1, - # corresponding to `Code.CANCELLED`. + # have [Operation.error][] value with a + # {::Google::Rpc::Status#code google.rpc.Status.code} of 1, corresponding to + # `Code.CANCELLED`. # @!attribute [r] api_version # @return [::String] # Output only. API version used to start the operation. class OperationMetadata include ::Google::Protobuf::MessageExts @@ -53,11 +54,11 @@ # Request message for CreateBackupPlan. # @!attribute [rw] parent # @return [::String] # Required. The location within which to create the BackupPlan. - # Format: projects/*/locations/* + # Format: `projects/*/locations/*` # @!attribute [rw] backup_plan # @return [::Google::Cloud::GkeBackup::V1::BackupPlan] # Required. The BackupPlan resource object to create. # @!attribute [rw] backup_plan_id # @return [::String] @@ -76,11 +77,11 @@ # Request message for ListBackupPlans. # @!attribute [rw] parent # @return [::String] # Required. The location that contains the BackupPlans to list. - # Format: projects/*/locations/* + # Format: `projects/*/locations/*` # @!attribute [rw] page_size # @return [::Integer] # 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 @@ -111,14 +112,14 @@ # @return [::Array<::Google::Cloud::GkeBackup::V1::BackupPlan>] # The list of BackupPlans matching the given criteria. # @!attribute [rw] next_page_token # @return [::String] # A token which may be sent as - # {::Google::Cloud::GkeBackup::V1::ListBackupPlansRequest#page_token page_token} in a subsequent - # `ListBackupPlans` call to retrieve the next page of results. - # If this field is omitted or empty, then there are no more results to - # return. + # {::Google::Cloud::GkeBackup::V1::ListBackupPlansRequest#page_token page_token} + # in a subsequent `ListBackupPlans` call to retrieve the next page of + # results. If this field is omitted or empty, then there are no more results + # to return. # @!attribute [rw] unreachable # @return [::Array<::String>] # Locations that could not be reached. class ListBackupPlansResponse include ::Google::Protobuf::MessageExts @@ -127,21 +128,21 @@ # Request message for GetBackupPlan. # @!attribute [rw] name # @return [::String] # Required. Fully qualified BackupPlan name. - # Format: projects/*/locations/*/backupPlans/* + # Format: `projects/*/locations/*/backupPlans/*` class GetBackupPlanRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for UpdateBackupPlan. # @!attribute [rw] backup_plan # @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. + # 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 # BackupPlan targeted for update. The values for each of these # updated fields will be taken from the `backup_plan` provided @@ -158,26 +159,26 @@ # Request message for DeleteBackupPlan. # @!attribute [rw] name # @return [::String] # Required. Fully qualified BackupPlan name. - # Format: projects/*/locations/*/backupPlans/* + # Format: `projects/*/locations/*/backupPlans/*` # @!attribute [rw] etag # @return [::String] # 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. + # 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 end # Request message for CreateBackup. # @!attribute [rw] parent # @return [::String] # Required. The BackupPlan within which to create the Backup. - # Format: projects/*/locations/*/backupPlans/* + # Format: `projects/*/locations/*/backupPlans/*` # @!attribute [rw] backup # @return [::Google::Cloud::GkeBackup::V1::Backup] # The Backup resource to create. # @!attribute [rw] backup_id # @return [::String] @@ -196,11 +197,11 @@ # Request message for ListBackups. # @!attribute [rw] parent # @return [::String] # Required. The BackupPlan that contains the Backups to list. - # Format: projects/*/locations/*/backupPlans/* + # Format: `projects/*/locations/*/backupPlans/*` # @!attribute [rw] page_size # @return [::Integer] # 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 @@ -230,33 +231,34 @@ # @!attribute [rw] backups # @return [::Array<::Google::Cloud::GkeBackup::V1::Backup>] # The list of Backups matching the given criteria. # @!attribute [rw] next_page_token # @return [::String] - # A token which may be sent as {::Google::Cloud::GkeBackup::V1::ListBackupsRequest#page_token page_token} in - # a subsequent `ListBackups` call to retrieve the next page of results. If - # this field is omitted or empty, then there are no more results to return. + # A token which may be sent as + # {::Google::Cloud::GkeBackup::V1::ListBackupsRequest#page_token page_token} in a + # subsequent `ListBackups` call to retrieve the next page of results. If this + # field is omitted or empty, then there are no more results to return. class ListBackupsResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for GetBackup. # @!attribute [rw] name # @return [::String] # Required. Full name of the Backup resource. - # Format: projects/*/locations/*/backupPlans/*/backups/* + # Format: `projects/*/locations/*/backupPlans/*/backups/*` class GetBackupRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for UpdateBackup. # @!attribute [rw] backup # @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. + # 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 # Backup targeted for update. The values for each of these # updated fields will be taken from the `backup_plan` provided @@ -272,16 +274,16 @@ # Request message for DeleteBackup. # @!attribute [rw] name # @return [::String] # Required. Name of the Backup resource. - # Format: projects/*/locations/*/backupPlans/*/backups/* + # Format: `projects/*/locations/*/backupPlans/*/backups/*` # @!attribute [rw] etag # @return [::String] # 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. + # 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 # VolumeBackups. @@ -292,11 +294,11 @@ # Request message for ListVolumeBackups. # @!attribute [rw] parent # @return [::String] # Required. The Backup that contains the VolumeBackups to list. - # Format: projects/*/locations/*/backupPlans/*/backups/* + # Format: `projects/*/locations/*/backupPlans/*/backups/*` # @!attribute [rw] page_size # @return [::Integer] # 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 @@ -327,34 +329,34 @@ # @return [::Array<::Google::Cloud::GkeBackup::V1::VolumeBackup>] # The list of VolumeBackups matching the given criteria. # @!attribute [rw] next_page_token # @return [::String] # A token which may be sent as - # {::Google::Cloud::GkeBackup::V1::ListVolumeBackupsRequest#page_token page_token} in a subsequent - # `ListVolumeBackups` call to retrieve the next page of results. - # If this field is omitted or empty, then there are no more results to - # return. + # {::Google::Cloud::GkeBackup::V1::ListVolumeBackupsRequest#page_token page_token} + # in a subsequent `ListVolumeBackups` call to retrieve the next page of + # results. If this field is omitted or empty, then there are no more results + # to return. class ListVolumeBackupsResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for GetVolumeBackup. # @!attribute [rw] name # @return [::String] # Required. Full name of the VolumeBackup resource. - # Format: projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/* + # Format: `projects/*/locations/*/backupPlans/*/backups/*/volumeBackups/*` class GetVolumeBackupRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for CreateRestorePlan. # @!attribute [rw] parent # @return [::String] # Required. The location within which to create the RestorePlan. - # Format: projects/*/locations/* + # Format: `projects/*/locations/*` # @!attribute [rw] restore_plan # @return [::Google::Cloud::GkeBackup::V1::RestorePlan] # Required. The RestorePlan resource object to create. # @!attribute [rw] restore_plan_id # @return [::String] @@ -373,11 +375,11 @@ # Request message for ListRestorePlans. # @!attribute [rw] parent # @return [::String] # Required. The location that contains the RestorePlans to list. - # Format: projects/*/locations/* + # Format: `projects/*/locations/*` # @!attribute [rw] page_size # @return [::Integer] # 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 @@ -408,14 +410,14 @@ # @return [::Array<::Google::Cloud::GkeBackup::V1::RestorePlan>] # The list of RestorePlans matching the given criteria. # @!attribute [rw] next_page_token # @return [::String] # A token which may be sent as - # {::Google::Cloud::GkeBackup::V1::ListRestorePlansRequest#page_token page_token} in a subsequent - # `ListRestorePlans` call to retrieve the next page of results. - # If this field is omitted or empty, then there are no more results to - # return. + # {::Google::Cloud::GkeBackup::V1::ListRestorePlansRequest#page_token page_token} + # in a subsequent `ListRestorePlans` call to retrieve the next page of + # results. If this field is omitted or empty, then there are no more results + # to return. # @!attribute [rw] unreachable # @return [::Array<::String>] # Locations that could not be reached. class ListRestorePlansResponse include ::Google::Protobuf::MessageExts @@ -424,21 +426,21 @@ # Request message for GetRestorePlan. # @!attribute [rw] name # @return [::String] # Required. Fully qualified RestorePlan name. - # Format: projects/*/locations/*/restorePlans/* + # Format: `projects/*/locations/*/restorePlans/*` class GetRestorePlanRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for UpdateRestorePlan. # @!attribute [rw] restore_plan # @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. + # 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 # RestorePlan targeted for update. The values for each of these # updated fields will be taken from the `restore_plan` provided @@ -454,16 +456,16 @@ # Request message for DeleteRestorePlan. # @!attribute [rw] name # @return [::String] # Required. Fully qualified RestorePlan name. - # Format: projects/*/locations/*/restorePlans/* + # Format: `projects/*/locations/*/restorePlans/*` # @!attribute [rw] etag # @return [::String] # 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. + # 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 # Restores. @@ -474,11 +476,11 @@ # Request message for CreateRestore. # @!attribute [rw] parent # @return [::String] # Required. The RestorePlan within which to create the Restore. - # Format: projects/*/locations/*/restorePlans/* + # Format: `projects/*/locations/*/restorePlans/*` # @!attribute [rw] restore # @return [::Google::Cloud::GkeBackup::V1::Restore] # Required. The restore resource to create. # @!attribute [rw] restore_id # @return [::String] @@ -497,11 +499,11 @@ # Request message for ListRestores. # @!attribute [rw] parent # @return [::String] # Required. The RestorePlan that contains the Restores to list. - # Format: projects/*/locations/*/restorePlans/* + # Format: `projects/*/locations/*/restorePlans/*` # @!attribute [rw] page_size # @return [::Integer] # 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 @@ -531,14 +533,14 @@ # @!attribute [rw] restores # @return [::Array<::Google::Cloud::GkeBackup::V1::Restore>] # The list of Restores matching the given criteria. # @!attribute [rw] next_page_token # @return [::String] - # A token which may be sent as {::Google::Cloud::GkeBackup::V1::ListRestoresRequest#page_token page_token} - # in a subsequent `ListRestores` call to retrieve the next page of results. - # If this field is omitted or empty, then there are no more results to - # return. + # A token which may be sent as + # {::Google::Cloud::GkeBackup::V1::ListRestoresRequest#page_token page_token} in a + # subsequent `ListRestores` call to retrieve the next page of results. If + # this field is omitted or empty, then there are no more results to return. # @!attribute [rw] unreachable # @return [::Array<::String>] # Locations that could not be reached. class ListRestoresResponse include ::Google::Protobuf::MessageExts @@ -547,21 +549,21 @@ # Request message for GetRestore. # @!attribute [rw] name # @return [::String] # Required. Name of the restore resource. - # Format: projects/*/locations/*/restorePlans/*/restores/* + # Format: `projects/*/locations/*/restorePlans/*/restores/*` class GetRestoreRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for UpdateRestore. # @!attribute [rw] restore # @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. + # 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 # Restore targeted for update. The values for each of these # updated fields will be taken from the `restore` provided @@ -577,16 +579,16 @@ # Request message for DeleteRestore. # @!attribute [rw] name # @return [::String] # Required. Full name of the Restore - # Format: projects/*/locations/*/restorePlans/*/restores/* + # Format: `projects/*/locations/*/restorePlans/*/restores/*` # @!attribute [rw] etag # @return [::String] # 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. + # 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 # VolumeRestores. @@ -597,11 +599,11 @@ # Request message for ListVolumeRestores. # @!attribute [rw] parent # @return [::String] # Required. The Restore that contains the VolumeRestores to list. - # Format: projects/*/locations/*/restorePlans/*/restores/* + # Format: `projects/*/locations/*/restorePlans/*/restores/*` # @!attribute [rw] page_size # @return [::Integer] # 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 @@ -632,23 +634,23 @@ # @return [::Array<::Google::Cloud::GkeBackup::V1::VolumeRestore>] # The list of VolumeRestores matching the given criteria. # @!attribute [rw] next_page_token # @return [::String] # A token which may be sent as - # {::Google::Cloud::GkeBackup::V1::ListVolumeRestoresRequest#page_token page_token} in a subsequent - # `ListVolumeRestores` call to retrieve the next page of results. - # If this field is omitted or empty, then there are no more results to - # return. + # {::Google::Cloud::GkeBackup::V1::ListVolumeRestoresRequest#page_token page_token} + # in a subsequent `ListVolumeRestores` call to retrieve the next page of + # results. If this field is omitted or empty, then there are no more results + # to return. class ListVolumeRestoresResponse include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Request message for GetVolumeRestore. # @!attribute [rw] name # @return [::String] # Required. Full name of the VolumeRestore resource. - # Format: projects/*/locations/*/restorePlans/*/restores/*/volumeRestores/* + # Format: `projects/*/locations/*/restorePlans/*/restores/*/volumeRestores/*` class GetVolumeRestoreRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end