2024-07-05
▼ ▲ backupdr.projects.locations.backupVaults.create
Path: v1/{+parent}/backupVaults
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupVaults
HTTP Method: POST
Parameters:
parent
Description: Required. Value for parent.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
backupVaultId
Description: Required. ID of the requesting object If auto-generating ID server-side, remove this field and backup_vault_id from the method_signature of Create RPC
Location: query
Type: string
requestId
Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location: query
Type: string
validateOnly
Description: Optional. Only validate the request, but do not perform mutations. The default is 'false'.
Location: query
Type: boolean
Parameter Order: parent
▼ ▲ backupdr.projects.locations.backupVaults.list
Path: v1/{+parent}/backupVaults
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupVaults
HTTP Method: GET
Parameters:
parent
Description: Required. The project and location for which to retrieve backupvault stores information, in the format 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve backupvault stores for all locations, use "-" for the '{location}' value.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Location: query
Type: integer
Format: int32
pageToken
Description: Optional. A token identifying a page of results the server should return.
Location: query
Type: string
filter
Description: Optional. Filtering results.
Location: query
Type: string
orderBy
Description: Optional. Hint for how to order the results.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists BackupVaults in a given project and location.
▼ ▲ backupdr.projects.locations.backupVaults.fetchUsable
Path: v1/{+parent}/backupVaults:fetchUsable
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupVaults:fetchUsable
HTTP Method: GET
Parameters:
parent
Description: Required. The project and location for which to retrieve backupvault stores information, in the format 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve backupvault stores for all locations, use "-" for the '{location}' value.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Location: query
Type: integer
Format: int32
pageToken
Description: Optional. A token identifying a page of results the server should return.
Location: query
Type: string
filter
Description: Optional. Filtering results.
Location: query
Type: string
orderBy
Description: Optional. Hint for how to order the results.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: FetchUsableBackupVaults lists usable BackupVaults in a given project and location. Usable BackupVault are the ones that user has backupdr.backupVaults.get permission.
▼ ▲ backupdr.projects.locations.backupVaults.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}
HTTP Method: GET
Parameters:
name
Description: Required. Name of the backupvault store resource name, in the format 'projects/{project_id}/locations/{location}/backupVaults/{resource_name}'
Pattern: ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets details of a BackupVault.
▼ ▲ backupdr.projects.locations.backupVaults.patch
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}
HTTP Method: PATCH
Parameters:
name
Description: Output only. The resource name.
Pattern: ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Description: Required. Field mask is used to specify the fields to be overwritten in the BackupVault resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then the request will fail.
Location: query
Type: string
Format: google-fieldmask
requestId
Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location: query
Type: string
validateOnly
Description: Optional. Only validate the request, but do not perform mutations. The default is 'false'.
Location: query
Type: boolean
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates the settings of a BackupVault.
▼ ▲ backupdr.projects.locations.backupVaults.delete
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}
HTTP Method: DELETE
Parameters:
name
Description: Required. Name of the resource.
Pattern: ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$
Location: path
Required: Yes
Type: string
requestId
Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location: query
Type: string
force
Description: Optional. If set to true, any data source from this backup vault will also be deleted.
Location: query
Type: boolean
etag
Description: The current etag of the backup vault. If an etag is provided and does not match the current etag of the connection, deletion will be blocked.
Location: query
Type: string
validateOnly
Description: Optional. Only validate the request, but do not perform mutations. The default is 'false'.
Location: query
Type: boolean
allowMissing
Description: Optional. If true and the BackupVault is not found, the request will succeed but no action will be taken.
Location: query
Type: boolean
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a BackupVault.
▼ ▲ backupdr.projects.locations.backupVaults.testIamPermissions
Path: v1/{+resource}:testIamPermissions
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}:testIamPermissions
HTTP Method: POST
Parameters:
resource
Description: REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern: ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: resource
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Returns the caller's permissions on a BackupVault resource. A caller is not required to have Google IAM permission to make this request.
▼ ▲ backupdr.projects.locations.backupVaults.dataSources.list
Path: v1/{+parent}/dataSources
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources
HTTP Method: GET
Parameters:
parent
Description: Required. The project and location for which to retrieve data sources information, in the format 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve data sources for all locations, use "-" for the '{location}' value.
Pattern: ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Location: query
Type: integer
Format: int32
pageToken
Description: Optional. A token identifying a page of results the server should return.
Location: query
Type: string
filter
Description: Optional. Filtering results.
Location: query
Type: string
orderBy
Description: Optional. Hint for how to order the results.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists DataSources in a given project and location.
▼ ▲ backupdr.projects.locations.backupVaults.dataSources.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}
HTTP Method: GET
Parameters:
name
Description: Required. Name of the data source resource name, in the format 'projects/{project_id}/locations/{location}/backupVaults/{resource_name}/dataSource/{resource_name}'
Pattern: ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets details of a DataSource.
▼ ▲ backupdr.projects.locations.backupVaults.dataSources.patch
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}
HTTP Method: PATCH
Parameters:
name
Description: Output only. The resource name.
Pattern: ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Description: Required. Field mask is used to specify the fields to be overwritten in the DataSource resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then the request will fail.
Location: query
Type: string
Format: google-fieldmask
requestId
Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location: query
Type: string
allowMissing
Description: Optional. Enable upsert.
Location: query
Type: boolean
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates the settings of a DataSource.
▼ ▲ backupdr.projects.locations.backupVaults.dataSources.remove
Path: v1/{+name}:remove
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:remove
HTTP Method: POST
Parameters:
name
Description: Required. Name of the resource.
Pattern: ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a DataSource. This is a custom method instead of a standard delete method because external clients will not delete DataSources except for BackupDR backup appliances.
▼ ▲ backupdr.projects.locations.backupVaults.dataSources.setInternalStatus
Path: v1/{+dataSource}:setInternalStatus
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:setInternalStatus
HTTP Method: POST
Parameters:
dataSource
Description: Required. The resource name of the instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/'.
Pattern: ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: dataSource
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Sets the internal status of a DataSource.
▼ ▲ backupdr.projects.locations.backupVaults.dataSources.initiateBackup
Path: v1/{+dataSource}:initiateBackup
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:initiateBackup
HTTP Method: POST
Parameters:
dataSource
Description: Required. The resource name of the instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/'.
Pattern: ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: dataSource
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Internal only. Initiates a backup.
▼ ▲ backupdr.projects.locations.backupVaults.dataSources.abandonBackup
Path: v1/{+dataSource}:abandonBackup
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:abandonBackup
HTTP Method: POST
Parameters:
dataSource
Description: Required. The resource name of the instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/'.
Pattern: ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: dataSource
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Internal only. Abandons a backup.
▼ ▲ backupdr.projects.locations.backupVaults.dataSources.finalizeBackup
Path: v1/{+dataSource}:finalizeBackup
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:finalizeBackup
HTTP Method: POST
Parameters:
dataSource
Description: Required. The resource name of the instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/'.
Pattern: ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: dataSource
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Internal only. Finalize a backup that was started by a call to InitiateBackup.
▼ ▲ backupdr.projects.locations.backupVaults.dataSources.fetchAccessToken
Path: v1/{+name}:fetchAccessToken
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:fetchAccessToken
HTTP Method: POST
Parameters:
name
Description: Required. The resource name for the location for which static IPs should be returned. Must be in the format 'projects/*/locations/*/backupVaults/*/dataSources'.
Pattern: ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Internal only. Fetch access token for a given data source.
▼ ▲ backupdr.projects.locations.backupVaults.dataSources.backups.list
Path: v1/{+parent}/backups
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}/backups
HTTP Method: GET
Parameters:
parent
Description: Required. The project and location for which to retrieve backup information, in the format 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve data sources for all locations, use "-" for the '{location}' value.
Pattern: ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Location: query
Type: integer
Format: int32
pageToken
Description: Optional. A token identifying a page of results the server should return.
Location: query
Type: string
filter
Description: Optional. Filtering results.
Location: query
Type: string
orderBy
Description: Optional. Hint for how to order the results.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists Backups in a given project and location.
▼ ▲ backupdr.projects.locations.backupVaults.dataSources.backups.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}/backups/{backupsId}
HTTP Method: GET
Parameters:
name
Description: Required. Name of the data source resource name, in the format 'projects/{project_id}/locations/{location}/backupVaults/{backupVault}/dataSources/{datasource}/backups/{backup}'
Pattern: ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+/backups/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets details of a Backup.
▼ ▲ backupdr.projects.locations.backupVaults.dataSources.backups.patch
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}/backups/{backupsId}
HTTP Method: PATCH
Parameters:
name
Description: Output only. Name of the resource.
Pattern: ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+/backups/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Description: Required. Field mask is used to specify the fields to be overwritten in the Backup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then the request will fail.
Location: query
Type: string
Format: google-fieldmask
requestId
Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location: query
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates the settings of a Backup.
▼ ▲ backupdr.projects.locations.backupVaults.dataSources.backups.delete
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}/backups/{backupsId}
HTTP Method: DELETE
Parameters:
name
Description: Required. Name of the resource.
Pattern: ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+/backups/[^/]+$
Location: path
Required: Yes
Type: string
requestId
Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location: query
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a Backup.
▼ ▲ backupdr.projects.locations.backupVaults.create
Path: v1/{+parent}/backupVaults
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupVaults
HTTP Method: POST
Parameters:
parent
Description: Required. Value for parent.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
backupVaultId
Description: Required. ID of the requesting object If auto-generating ID server-side, remove this field and backup_vault_id from the method_signature of Create RPC
Location: query
Type: string
requestId
Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location: query
Type: string
validateOnly
Description: Optional. Only validate the request, but do not perform mutations. The default is 'false'.
Location: query
Type: boolean
Parameter Order: parent
▼ ▲ backupdr.projects.locations.backupVaults.list
Path: v1/{+parent}/backupVaults
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupVaults
HTTP Method: GET
Parameters:
parent
Description: Required. The project and location for which to retrieve backupvault stores information, in the format 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve backupvault stores for all locations, use "-" for the '{location}' value.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Location: query
Type: integer
Format: int32
pageToken
Description: Optional. A token identifying a page of results the server should return.
Location: query
Type: string
filter
Description: Optional. Filtering results.
Location: query
Type: string
orderBy
Description: Optional. Hint for how to order the results.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists BackupVaults in a given project and location.
▼ ▲ backupdr.projects.locations.backupVaults.fetchUsable
Path: v1/{+parent}/backupVaults:fetchUsable
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupVaults:fetchUsable
HTTP Method: GET
Parameters:
parent
Description: Required. The project and location for which to retrieve backupvault stores information, in the format 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve backupvault stores for all locations, use "-" for the '{location}' value.
Pattern: ^projects/[^/]+/locations/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Location: query
Type: integer
Format: int32
pageToken
Description: Optional. A token identifying a page of results the server should return.
Location: query
Type: string
filter
Description: Optional. Filtering results.
Location: query
Type: string
orderBy
Description: Optional. Hint for how to order the results.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: FetchUsableBackupVaults lists usable BackupVaults in a given project and location. Usable BackupVault are the ones that user has backupdr.backupVaults.get permission.
▼ ▲ backupdr.projects.locations.backupVaults.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}
HTTP Method: GET
Parameters:
name
Description: Required. Name of the backupvault store resource name, in the format 'projects/{project_id}/locations/{location}/backupVaults/{resource_name}'
Pattern: ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets details of a BackupVault.
▼ ▲ backupdr.projects.locations.backupVaults.patch
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}
HTTP Method: PATCH
Parameters:
name
Description: Output only. The resource name.
Pattern: ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Description: Required. Field mask is used to specify the fields to be overwritten in the BackupVault resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then the request will fail.
Location: query
Type: string
Format: google-fieldmask
requestId
Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location: query
Type: string
validateOnly
Description: Optional. Only validate the request, but do not perform mutations. The default is 'false'.
Location: query
Type: boolean
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates the settings of a BackupVault.
▼ ▲ backupdr.projects.locations.backupVaults.delete
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}
HTTP Method: DELETE
Parameters:
name
Description: Required. Name of the resource.
Pattern: ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$
Location: path
Required: Yes
Type: string
requestId
Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location: query
Type: string
force
Description: Optional. If set to true, any data source from this backup vault will also be deleted.
Location: query
Type: boolean
etag
Description: The current etag of the backup vault. If an etag is provided and does not match the current etag of the connection, deletion will be blocked.
Location: query
Type: string
validateOnly
Description: Optional. Only validate the request, but do not perform mutations. The default is 'false'.
Location: query
Type: boolean
allowMissing
Description: Optional. If true and the BackupVault is not found, the request will succeed but no action will be taken.
Location: query
Type: boolean
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a BackupVault.
▼ ▲ backupdr.projects.locations.backupVaults.testIamPermissions
Path: v1/{+resource}:testIamPermissions
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}:testIamPermissions
HTTP Method: POST
Parameters:
resource
Description: REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.
Pattern: ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: resource
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Returns the caller's permissions on a BackupVault resource. A caller is not required to have Google IAM permission to make this request.
▼ ▲ backupdr.projects.locations.backupVaults.dataSources.list
Path: v1/{+parent}/dataSources
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources
HTTP Method: GET
Parameters:
parent
Description: Required. The project and location for which to retrieve data sources information, in the format 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve data sources for all locations, use "-" for the '{location}' value.
Pattern: ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Location: query
Type: integer
Format: int32
pageToken
Description: Optional. A token identifying a page of results the server should return.
Location: query
Type: string
filter
Description: Optional. Filtering results.
Location: query
Type: string
orderBy
Description: Optional. Hint for how to order the results.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists DataSources in a given project and location.
▼ ▲ backupdr.projects.locations.backupVaults.dataSources.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}
HTTP Method: GET
Parameters:
name
Description: Required. Name of the data source resource name, in the format 'projects/{project_id}/locations/{location}/backupVaults/{resource_name}/dataSource/{resource_name}'
Pattern: ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets details of a DataSource.
▼ ▲ backupdr.projects.locations.backupVaults.dataSources.patch
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}
HTTP Method: PATCH
Parameters:
name
Description: Output only. The resource name.
Pattern: ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Description: Required. Field mask is used to specify the fields to be overwritten in the DataSource resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then the request will fail.
Location: query
Type: string
Format: google-fieldmask
requestId
Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location: query
Type: string
allowMissing
Description: Optional. Enable upsert.
Location: query
Type: boolean
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates the settings of a DataSource.
▼ ▲ backupdr.projects.locations.backupVaults.dataSources.remove
Path: v1/{+name}:remove
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:remove
HTTP Method: POST
Parameters:
name
Description: Required. Name of the resource.
Pattern: ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a DataSource. This is a custom method instead of a standard delete method because external clients will not delete DataSources except for BackupDR backup appliances.
▼ ▲ backupdr.projects.locations.backupVaults.dataSources.setInternalStatus
Path: v1/{+dataSource}:setInternalStatus
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:setInternalStatus
HTTP Method: POST
Parameters:
dataSource
Description: Required. The resource name of the instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/'.
Pattern: ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: dataSource
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Sets the internal status of a DataSource.
▼ ▲ backupdr.projects.locations.backupVaults.dataSources.initiateBackup
Path: v1/{+dataSource}:initiateBackup
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:initiateBackup
HTTP Method: POST
Parameters:
dataSource
Description: Required. The resource name of the instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/'.
Pattern: ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: dataSource
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Internal only. Initiates a backup.
▼ ▲ backupdr.projects.locations.backupVaults.dataSources.abandonBackup
Path: v1/{+dataSource}:abandonBackup
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:abandonBackup
HTTP Method: POST
Parameters:
dataSource
Description: Required. The resource name of the instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/'.
Pattern: ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: dataSource
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Internal only. Abandons a backup.
▼ ▲ backupdr.projects.locations.backupVaults.dataSources.finalizeBackup
Path: v1/{+dataSource}:finalizeBackup
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:finalizeBackup
HTTP Method: POST
Parameters:
dataSource
Description: Required. The resource name of the instance, in the format 'projects/*/locations/*/backupVaults/*/dataSources/'.
Pattern: ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: dataSource
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Internal only. Finalize a backup that was started by a call to InitiateBackup.
▼ ▲ backupdr.projects.locations.backupVaults.dataSources.fetchAccessToken
Path: v1/{+name}:fetchAccessToken
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}:fetchAccessToken
HTTP Method: POST
Parameters:
name
Description: Required. The resource name for the location for which static IPs should be returned. Must be in the format 'projects/*/locations/*/backupVaults/*/dataSources'.
Pattern: ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Internal only. Fetch access token for a given data source.
▼ ▲ backupdr.projects.locations.backupVaults.dataSources.backups.list
Path: v1/{+parent}/backups
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}/backups
HTTP Method: GET
Parameters:
parent
Description: Required. The project and location for which to retrieve backup information, in the format 'projects/{project_id}/locations/{location}'. In Cloud Backup and DR, locations map to Google Cloud regions, for example **us-central1**. To retrieve data sources for all locations, use "-" for the '{location}' value.
Pattern: ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+$
Location: path
Required: Yes
Type: string
pageSize
Description: Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
Location: query
Type: integer
Format: int32
pageToken
Description: Optional. A token identifying a page of results the server should return.
Location: query
Type: string
filter
Description: Optional. Filtering results.
Location: query
Type: string
orderBy
Description: Optional. Hint for how to order the results.
Location: query
Type: string
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists Backups in a given project and location.
▼ ▲ backupdr.projects.locations.backupVaults.dataSources.backups.get
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}/backups/{backupsId}
HTTP Method: GET
Parameters:
name
Description: Required. Name of the data source resource name, in the format 'projects/{project_id}/locations/{location}/backupVaults/{backupVault}/dataSources/{datasource}/backups/{backup}'
Pattern: ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+/backups/[^/]+$
Location: path
Required: Yes
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets details of a Backup.
▼ ▲ backupdr.projects.locations.backupVaults.dataSources.backups.patch
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}/backups/{backupsId}
HTTP Method: PATCH
Parameters:
name
Description: Output only. Name of the resource.
Pattern: ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+/backups/[^/]+$
Location: path
Required: Yes
Type: string
updateMask
Description: Required. Field mask is used to specify the fields to be overwritten in the Backup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then the request will fail.
Location: query
Type: string
Format: google-fieldmask
requestId
Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location: query
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Updates the settings of a Backup.
▼ ▲ backupdr.projects.locations.backupVaults.dataSources.backups.delete
Path: v1/{+name}
Flat Path: v1/projects/{projectsId}/locations/{locationsId}/backupVaults/{backupVaultsId}/dataSources/{dataSourcesId}/backups/{backupsId}
HTTP Method: DELETE
Parameters:
name
Description: Required. Name of the resource.
Pattern: ^projects/[^/]+/locations/[^/]+/backupVaults/[^/]+/dataSources/[^/]+/backups/[^/]+$
Location: path
Required: Yes
Type: string
requestId
Description: Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Location: query
Type: string
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Deletes a Backup.