2022-04-09
▼ ▲ gkebackup.projects.locations.list
Description: Lists information about the supported locations for this service.
Flat Path: v1/projects/{projectsId}/locations
HTTP Method: GET
Parameter Order: name
Path: v1/{+name}/locations
Parameters:
name
Location: path
Description: The resource that owns the locations collection, if applicable.
Required: Yes
Type: string
Pattern: ^projects/[^/]+$
filter
Type: string
Description: A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in [AIP-160](https://google.aip.dev/160).
Location: query
pageSize
Type: integer
Description: The maximum number of results to return. If not set, the service selects a default.
Format: int32
Location: query
pageToken
Type: string
Location: query
Description: A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
▼ ▲ gkebackup.projects.locations.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
Parameter Order: name
Parameters:
name
Description: Resource name for the location.
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
Type: string
Location: path
Description: Gets information about a location.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}
HTTP Method: GET
▼ ▲ gkebackup.projects.locations.deleteOperations
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Description: The name of the operation resource to be deleted.
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Path: v1/{+name}/operations
Description: Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
Parameter Order: name
HTTP Method: DELETE
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations
▼ ▲ gkebackup.projects.locations.restorePlans.restores.get
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}/restores/{restoresId}
Parameters:
name
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/restorePlans/[^/]+/restores/[^/]+$
Description: Required. Name of the restore resource. Format: projects/{project}/locations/{location}/restorePlans/{restore_plan}/restores/{restore}
Path: v1/{+name}
HTTP Method: GET
Description: Retrieves the details of a single Restore.
▼ ▲ gkebackup.projects.locations.restorePlans.restores.list
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists the Restores for a given RestorePlan.
Parameter Order: parent
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}/restores
Parameters:
parent
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/restorePlans/[^/]+$
Location: path
Description: Required. The RestorePlan that contains the Restores to list. Format: projects/{project}/locations/{location}/restorePlans/{restore_plan}
pageSize
Format: int32
Type: integer
Location: query
Description: 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 only rely on the response's next_page_token to determine if there are more instances left to be queried.
pageToken
Type: string
Location: query
Description: The value of 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.
orderBy
Location: query
Description: Sort results.
Type: string
filter
Description: List filter.
Type: string
Location: query
Path: v1/{+parent}/restores
▼ ▲ gkebackup.projects.locations.restorePlans.restores.create
Path: v1/{+parent}/restores
Parameters:
parent
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/restorePlans/[^/]+$
Description: Required. The RestorePlan within which to create the Restore. Format: projects/{project}/locations/{location}/restorePlans/{restore_plan}
Location: path
Required: Yes
restoreId
Description: Required. The client-provided short name for the Restore resource. This name must: a. be between 1 and 63 characters long (inclusive) b. consist of only lower-case ASCII letters, numbers, and dashes c. start with a lower-case letter d. end with a lower-case letter or number e. be unique within the set of Restores in this RestorePlan.
Location: query
Type: string
Description: Creates a new Restore for the given RestorePlan.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}/restores
▼ ▲ gkebackup.projects.locations.restorePlans.restores.testIamPermissions
Parameters:
resource
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/restorePlans/[^/]+/restores/[^/]+$
Description: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
Required: Yes
HTTP Method: POST
Parameter Order: resource
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}/restores/{restoresId}:testIamPermissions
Path: v1/{+resource}:testIamPermissions
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
▼ ▲ gkebackup.projects.locations.restorePlans.restores.getIamPolicy
HTTP Method: GET
Path: v1/{+resource}:getIamPolicy
Parameters:
resource
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/restorePlans/[^/]+/restores/[^/]+$
Description: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
options.requestedPolicyVersion
Format: int32
Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Location: query
Type: integer
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}/restores/{restoresId}:getIamPolicy
Parameter Order: resource
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
▼ ▲ gkebackup.projects.locations.restorePlans.restores.delete
Description: Deletes an existing Restore.
Path: v1/{+name}
HTTP Method: DELETE
Parameter Order: name
Parameters:
etag
Location: query
Type: string
Description: etag, if provided, it must match the server's etag for delete to happen.
force
Type: boolean
Description: 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.
Location: query
name
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/restorePlans/[^/]+/restores/[^/]+$
Description: Required. Full name of the Restore Format: projects/{project}/locations/{location}/restorePlans/{restore_plan}/restores/{restore}
Location: path
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}/restores/{restoresId}
▼ ▲ gkebackup.projects.locations.restorePlans.restores.setIamPolicy
Path: v1/{+resource}:setIamPolicy
HTTP Method: POST
Parameters:
resource
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/restorePlans/[^/]+/restores/[^/]+$
Required: Yes
Description: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}/restores/{restoresId}:setIamPolicy
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Parameter Order: resource
▼ ▲ gkebackup.projects.locations.restorePlans.restores.patch
Path: v1/{+name}
Description: Update a Restore.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}/restores/{restoresId}
HTTP Method: PATCH
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Description: Output only. The full name of the Restore resource. Format: projects/*/locations/*/restorePlans/*/restores/*
Pattern: ^projects/[^/]+/locations/[^/]+/restorePlans/[^/]+/restores/[^/]+$
Type: string
Required: Yes
Location: path
updateMask
Type: string
Description: 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. Note that OUTPUT_ONLY and IMMUTABLE fields in `restore` are ignored and are not used to update the target Restore.
Location: query
Format: google-fieldmask
▼ ▲ gkebackup.projects.locations.restorePlans.restores.volumeRestores.getIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}/restores/{restoresId}/volumeRestores/{volumeRestoresId}:getIamPolicy
Path: v1/{+resource}:getIamPolicy
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/restorePlans/[^/]+/restores/[^/]+/volumeRestores/[^/]+$
Location: path
Required: Yes
Type: string
Description: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
options.requestedPolicyVersion
Type: integer
Format: int32
Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Location: query
Parameter Order: resource
HTTP Method: GET
▼ ▲ gkebackup.projects.locations.restorePlans.restores.volumeRestores.setIamPolicy
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}/restores/{restoresId}/volumeRestores/{volumeRestoresId}:setIamPolicy
Path: v1/{+resource}:setIamPolicy
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/restorePlans/[^/]+/restores/[^/]+/volumeRestores/[^/]+$
Description: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
Location: path
Type: string
Required: Yes
Parameter Order: resource
▼ ▲ gkebackup.projects.locations.restorePlans.restores.volumeRestores.testIamPermissions
Parameters:
resource
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/restorePlans/[^/]+/restores/[^/]+/volumeRestores/[^/]+$
Location: path
Description: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameter Order: resource
Path: v1/{+resource}:testIamPermissions
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}/restores/{restoresId}/volumeRestores/{volumeRestoresId}:testIamPermissions
▼ ▲ gkebackup.projects.locations.restorePlans.restores.volumeRestores.list
Parameters:
orderBy
Type: string
Location: query
Description: Sort results.
parent
Location: path
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/restorePlans/[^/]+/restores/[^/]+$
Description: Required. The Restore that contains the VolumeRestores to list. Format: projects/{project}/locations/{location}/restorePlans/{restore_plan}/restores/{restore}
Type: string
pageToken
Description: The value of 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.
Location: query
Type: string
pageSize
Location: query
Type: integer
Description: 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 only rely on the response's next_page_token to determine if there are more instances left to be queried.
Format: int32
filter
Location: query
Description: List filter.
Type: string
Description: Lists the VolumeRestores for a given Restore.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}/restores/{restoresId}/volumeRestores
Path: v1/{+parent}/volumeRestores
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
HTTP Method: GET
▼ ▲ gkebackup.projects.locations.restorePlans.restores.volumeRestores.get
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Retrieve the details of a single VolumeRestore.
Parameter Order: name
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}/restores/{restoresId}/volumeRestores/{volumeRestoresId}
Parameters:
name
Location: path
Description: Required. Full name of the VolumeRestore resource. Format: projects/{project}/locations/{location}/restorePlans/{restore_plan}/restores/{restore}/volumeRestores/{volume_restore}
Pattern: ^projects/[^/]+/locations/[^/]+/restorePlans/[^/]+/restores/[^/]+/volumeRestores/[^/]+$
Type: string
Required: Yes
HTTP Method: GET
Path: v1/{+name}
▼ ▲ gkebackup.projects.locations.restorePlans.delete
Description: Deletes an existing RestorePlan.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
Parameter Order: name
HTTP Method: DELETE
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}
Parameters:
name
Description: Required. Fully qualified RestorePlan name. Format: projects/{project}/locations/{location}/restorePlans/{restore_plan}
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/restorePlans/[^/]+$
etag
Description: If provided, this value must match the value currently assigned to the target resource.
Type: string
Location: query
force
Location: query
Description: 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.
Type: boolean
▼ ▲ gkebackup.projects.locations.restorePlans.list
Parameters:
filter
Location: query
Type: string
Description: List filter.
pageToken
Location: query
Description: The value of 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.
Type: string
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: Required. The location that contains the RestorePlans to list. Format: projects/{project}/locations/{location}
Location: path
Type: string
Required: Yes
pageSize
Format: int32
Type: integer
Location: query
Description: 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 only rely on the response's next_page_token to determine if there are more instances left to be queried.
orderBy
Type: string
Location: query
Description: Sort results.
Parameter Order: parent
Description: Lists RestorePlans in a given location.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/restorePlans
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+parent}/restorePlans
▼ ▲ gkebackup.projects.locations.restorePlans.get
Parameters:
name
Description: Required. Fully qualified RestorePlan name. Format: projects/{project}/locations/{location}/restorePlans/{restore_plan}
Pattern: ^projects/[^/]+/locations/[^/]+/restorePlans/[^/]+$
Type: string
Location: path
Required: Yes
Path: v1/{+name}
Parameter Order: name
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}
Description: Retrieve the details of a single RestorePlan.
▼ ▲ gkebackup.projects.locations.restorePlans.getIamPolicy
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}:getIamPolicy
Path: v1/{+resource}:getIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
options.requestedPolicyVersion
Location: query
Type: integer
Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Format: int32
resource
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/restorePlans/[^/]+$
Location: path
Type: string
Description: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
HTTP Method: GET
Parameter Order: resource
▼ ▲ gkebackup.projects.locations.restorePlans.testIamPermissions
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}:testIamPermissions
Parameters:
resource
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/restorePlans/[^/]+$
Description: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
Location: path
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Parameter Order: resource
Path: v1/{+resource}:testIamPermissions
▼ ▲ gkebackup.projects.locations.restorePlans.patch
HTTP Method: PATCH
Parameters:
updateMask
Location: query
Description: 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. Note that OUTPUT_ONLY and IMMUTABLE fields in `restore_plan` are ignored and are not used to update the target RestorePlan.
Type: string
Format: google-fieldmask
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/restorePlans/[^/]+$
Description: Output only. [Output Only] The full name of the RestorePlan resource. Format: projects/*/locations/*/restorePlans/*
Required: Yes
Location: path
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}
Path: v1/{+name}
Description: Update a RestorePlan.
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
▼ ▲ gkebackup.projects.locations.restorePlans.create
Description: Creates a new RestorePlan in a given location.
Parameter Order: parent
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/restorePlans
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+$
Type: string
Description: Required. The location within which to create the RestorePlan. Format: projects/{project}/locations/{location}
Required: Yes
Location: path
restorePlanId
Location: query
Type: string
Description: Required. The client-provided short name for the RestorePlan resource. This name must: a. be between 1 and 63 characters long (inclusive) b. consist of only lower-case ASCII letters, numbers, and dashes c. start with a lower-case letter d. end with a lower-case letter or number e. be unique within the set of RestorePlans in this location
HTTP Method: POST
Path: v1/{+parent}/restorePlans
▼ ▲ gkebackup.projects.locations.restorePlans.setIamPolicy
Path: v1/{+resource}:setIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: resource
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/restorePlans/{restorePlansId}:setIamPolicy
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
HTTP Method: POST
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/restorePlans/[^/]+$
Type: string
Description: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
Required: Yes
Location: path
▼ ▲ gkebackup.projects.locations.operations.list
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Path: v1/{+name}/operations
Parameters:
pageToken
Location: query
Description: The standard list page token.
Type: string
name
Description: The name of the operation's parent resource.
Type: string
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+$
filter
Type: string
Description: The standard list filter.
Location: query
pageSize
Type: integer
Description: The standard list page size.
Format: int32
Location: query
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations
Parameter Order: name
▼ ▲ gkebackup.projects.locations.operations.get
HTTP Method: GET
Path: v1/{+name}
Description: Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
Parameter Order: name
Parameters:
name
Description: The name of the operation resource.
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Type: string
Required: Yes
▼ ▲ gkebackup.projects.locations.operations.cancel
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
name
Description: The name of the operation resource to be cancelled.
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Type: string
Location: path
Required: Yes
Parameter Order: name
HTTP Method: POST
Description: Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
Path: v1/{+name}:cancel
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel
▼ ▲ gkebackup.projects.locations.backupPlans.backups.list
Parameter Order: parent
Parameters:
parent
Type: string
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+$
Description: Required. The BackupPlan that contains the Backups to list. Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}
pageToken
Type: string
Location: query
Description: The value of 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.
filter
Description: List filter.
Type: string
Location: query
orderBy
Type: string
Location: query
Description: Sort results.
pageSize
Type: integer
Format: int32
Description: 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 only rely on the response's next_page_token to determine if there are more instances left to be queried.
Location: query
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/backups
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists the Backups for a given BackupPlan.
HTTP Method: GET
Path: v1/{+parent}/backups
▼ ▲ gkebackup.projects.locations.backupPlans.backups.patch
Path: v1/{+name}
HTTP Method: PATCH
Description: Update a Backup.
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/backups/{backupsId}
Parameter Order: name
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+/backups/[^/]+$
Required: Yes
Description: Output only. The fully qualified name of the Backup. projects/*/locations/*/backupPlans/*/backups/*
Location: path
Type: string
updateMask
Location: query
Description: 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. Note that OUTPUT_ONLY and IMMUTABLE fields in `backup` are ignored and are not used to update the target Backup.
Format: google-fieldmask
Type: string
▼ ▲ gkebackup.projects.locations.backupPlans.backups.getIamPolicy
Path: v1/{+resource}:getIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/backups/{backupsId}:getIamPolicy
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Parameters:
options.requestedPolicyVersion
Location: query
Format: int32
Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Type: integer
resource
Description: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+/backups/[^/]+$
Location: path
Required: Yes
Parameter Order: resource
▼ ▲ gkebackup.projects.locations.backupPlans.backups.setIamPolicy
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/backups/{backupsId}:setIamPolicy
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+resource}:setIamPolicy
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+/backups/[^/]+$
Location: path
Required: Yes
Type: string
Description: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
Parameter Order: resource
▼ ▲ gkebackup.projects.locations.backupPlans.backups.get
Description: Retrieve the details of a single Backup.
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+/backups/[^/]+$
Location: path
Description: Required. Full name of the Backup resource. Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}/backups/{backup}
Required: Yes
Type: string
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/backups/{backupsId}
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
HTTP Method: GET
▼ ▲ gkebackup.projects.locations.backupPlans.backups.delete
HTTP Method: DELETE
Parameters:
etag
Type: string
Location: query
Description: etag, if provided, it must match the server's etag for the delete to happen.
name
Description: Required. Name of the Backup resource. Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}/backups/{backup}
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+/backups/[^/]+$
Location: path
Required: Yes
force
Type: boolean
Location: query
Description: 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.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
Parameter Order: name
Description: Deletes an existing Backup.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/backups/{backupsId}
▼ ▲ gkebackup.projects.locations.backupPlans.backups.testIamPermissions
Path: v1/{+resource}:testIamPermissions
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/backups/{backupsId}:testIamPermissions
Parameter Order: resource
HTTP Method: POST
Parameters:
resource
Description: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
Pattern: ^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+/backups/[^/]+$
Location: path
Type: string
Required: Yes
Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
▼ ▲ gkebackup.projects.locations.backupPlans.backups.create
Parameters:
backupId
Description: The client-provided short name for the Backup resource. This name must: a. be between 1 and 63 characters long (inclusive) b. consist of only lower-case ASCII letters, numbers, and dashes c. start with a lower-case letter d. end with a lower-case letter or number e. be unique within the set of Backups in this BackupPlan
Location: query
Type: string
parent
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+$
Description: Required. The BackupPlan within which to create the Backup. Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}
Path: v1/{+parent}/backups
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/backups
Parameter Order: parent
Description: Creates a Backup for the given BackupPlan.
▼ ▲ gkebackup.projects.locations.backupPlans.backups.volumeBackups.testIamPermissions
Path: v1/{+resource}:testIamPermissions
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/backups/{backupsId}/volumeBackups/{volumeBackupsId}:testIamPermissions
Parameter Order: resource
Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+/backups/[^/]+/volumeBackups/[^/]+$
Type: string
Description: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
Required: Yes
Location: path
▼ ▲ gkebackup.projects.locations.backupPlans.backups.volumeBackups.setIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/backups/{backupsId}/volumeBackups/{volumeBackupsId}:setIamPolicy
Path: v1/{+resource}:setIamPolicy
Parameter Order: resource
Parameters:
resource
Required: Yes
Location: path
Description: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+/backups/[^/]+/volumeBackups/[^/]+$
▼ ▲ gkebackup.projects.locations.backupPlans.backups.volumeBackups.getIamPolicy
Path: v1/{+resource}:getIamPolicy
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: resource
HTTP Method: GET
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+/backups/[^/]+/volumeBackups/[^/]+$
Required: Yes
Description: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
Type: string
Location: path
options.requestedPolicyVersion
Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Format: int32
Location: query
Type: integer
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/backups/{backupsId}/volumeBackups/{volumeBackupsId}:getIamPolicy
▼ ▲ gkebackup.projects.locations.backupPlans.backups.volumeBackups.list
Description: Lists the VolumeBackups for a given Backup.
Parameter Order: parent
HTTP Method: GET
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/backups/{backupsId}/volumeBackups
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
orderBy
Type: string
Location: query
Description: Sort results.
pageSize
Description: 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 only rely on the response's next_page_token to determine if there are more instances left to be queried.
Format: int32
Location: query
Type: integer
pageToken
Description: The value of 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.
Type: string
Location: query
filter
Description: List filter.
Type: string
Location: query
parent
Pattern: ^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+/backups/[^/]+$
Required: Yes
Description: Required. The Backup that contains the VolumeBackups to list. Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}/backups/{backup}
Type: string
Location: path
Path: v1/{+parent}/volumeBackups
▼ ▲ gkebackup.projects.locations.backupPlans.backups.volumeBackups.get
Parameter Order: name
Description: Retrieve the details of a single VolumeBackup.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}/backups/{backupsId}/volumeBackups/{volumeBackupsId}
Parameters:
name
Location: path
Required: Yes
Type: string
Description: Required. Full name of the VolumeBackup resource. Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}/backups/{backup}/volumeBackups/{volume_backup}
Pattern: ^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+/backups/[^/]+/volumeBackups/[^/]+$
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
▼ ▲ gkebackup.projects.locations.backupPlans.get
Path: v1/{+name}
Parameter Order: name
Parameters:
name
Description: Required. Fully qualified BackupPlan name. Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+$
Type: string
Location: path
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}
HTTP Method: GET
Description: Retrieve the details of a single BackupPlan.
▼ ▲ gkebackup.projects.locations.backupPlans.create
Parameters:
parent
Location: path
Type: string
Description: Required. The location within which to create the BackupPlan. Format: projects/{project}/locations/{location}
Pattern: ^projects/[^/]+/locations/[^/]+$
Required: Yes
backupPlanId
Location: query
Type: string
Description: Required. The client-provided short name for the BackupPlan resource. This name must: a. be between 1 and 63 characters long (inclusive) b. consist of only lower-case ASCII letters, numbers, and dashes c. start with a lower-case letter d. end with a lower-case letter or number e. be unique within the set of BackupPlans in this location
Description: Creates a new BackupPlan in a given location.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+parent}/backupPlans
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupPlans
Parameter Order: parent
▼ ▲ gkebackup.projects.locations.backupPlans.getIamPolicy
Parameters:
resource
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+$
Description: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
Location: path
options.requestedPolicyVersion
Type: integer
Format: int32
Location: query
Description: Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
Parameter Order: resource
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}:getIamPolicy
Description: Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
HTTP Method: GET
Path: v1/{+resource}:getIamPolicy
▼ ▲ gkebackup.projects.locations.backupPlans.list
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupPlans
Description: Lists BackupPlans in a given location.
Path: v1/{+parent}/backupPlans
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
HTTP Method: GET
Parameters:
orderBy
Type: string
Description: Sort results.
Location: query
pageToken
Location: query
Description: The value of 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.
Type: string
pageSize
Location: query
Description: 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 only rely on the response's next_page_token to determine if there are more instances left to be queried.
Format: int32
Type: integer
parent
Description: Required. The location that contains the BackupPlans to list. Format: projects/{project}/locations/{location}
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Type: string
filter
Description: List filter.
Type: string
Location: query
▼ ▲ gkebackup.projects.locations.backupPlans.setIamPolicy
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}:setIamPolicy
Parameters:
resource
Pattern: ^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+$
Location: path
Type: string
Description: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
Required: Yes
Parameter Order: resource
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.
Path: v1/{+resource}:setIamPolicy
▼ ▲ gkebackup.projects.locations.backupPlans.testIamPermissions
Parameter Order: resource
HTTP Method: POST
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}:testIamPermissions
Parameters:
resource
Location: path
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+$
Description: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
Description: Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+resource}:testIamPermissions
▼ ▲ gkebackup.projects.locations.backupPlans.patch
HTTP Method: PATCH
Parameters:
updateMask
Format: google-fieldmask
Location: query
Type: string
Description: 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 written to the target BackupPlan resource. Note that OUTPUT_ONLY and IMMUTABLE fields in `backup_plan` are ignored and are not used to update the target BackupPlan.
name
Description: Output only. [Output Only] The full name of the BackupPlan resource. Format: projects/*/locations/*/backupPlans/*
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+$
Location: path
Required: Yes
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Update a BackupPlan.
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}
Path: v1/{+name}
Parameter Order: name
▼ ▲ gkebackup.projects.locations.backupPlans.delete
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupPlans/{backupPlansId}
Parameters:
etag
Location: query
Type: string
Description: If provided, this value must match the value currently assigned to the target resource.
name
Pattern: ^projects/[^/]+/locations/[^/]+/backupPlans/[^/]+$
Location: path
Description: Required. Fully qualified BackupPlan name. Format: projects/{project}/locations/{location}/backupPlans/{backup_plan}
Type: string
Required: Yes
Description: Deletes an existing BackupPlan.
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1/{+name}
Parameter Order: name
HTTP Method: DELETE