class ProjectsLocationsBackupVaultsDataSources extends Resource (View source)

The "dataSources" collection of methods.

Typical usage is:

 $backupdrService = new Google\Service\Backupdr(...);
 $dataSources = $backupdrService->projects_locations_backupVaults_dataSources;

Methods

abandonBackup(string $dataSource, AbandonBackupRequest $postBody, array $optParams = [])

Internal only. Abandons a backup. (dataSources.abandonBackup)

fetchAccessToken(string $name, FetchAccessTokenRequest $postBody, array $optParams = [])

Internal only. Fetch access token for a given data source.

finalizeBackup(string $dataSource, FinalizeBackupRequest $postBody, array $optParams = [])

Internal only. Finalize a backup that was started by a call to InitiateBackup. (dataSources.finalizeBackup)

get(string $name, array $optParams = [])

Gets details of a DataSource. (dataSources.get)

initiateBackup(string $dataSource, InitiateBackupRequest $postBody, array $optParams = [])

Internal only. Initiates a backup. (dataSources.initiateBackup)

listProjectsLocationsBackupVaultsDataSources(string $parent, array $optParams = [])

Lists DataSources in a given project and location.

patch(string $name, DataSource $postBody, array $optParams = [])

Updates the settings of a DataSource. (dataSources.patch)

remove(string $name, RemoveDataSourceRequest $postBody, array $optParams = [])

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. (dataSources.remove)

setInternalStatus(string $dataSource, SetInternalStatusRequest $postBody, array $optParams = [])

Sets the internal status of a DataSource. (dataSources.setInternalStatus)

Details

Operation abandonBackup(string $dataSource, AbandonBackupRequest $postBody, array $optParams = [])

Internal only. Abandons a backup. (dataSources.abandonBackup)

Parameters

string $dataSource

Required. The resource name of the instance, in the format 'projects/locations/backupVaults/dataSources/'.

AbandonBackupRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

FetchAccessTokenResponse fetchAccessToken(string $name, FetchAccessTokenRequest $postBody, array $optParams = [])

Internal only. Fetch access token for a given data source.

(dataSources.fetchAccessToken)

Parameters

string $name

Required. The resource name for the location for which static IPs should be returned. Must be in the format 'projects/locations/backupVaults/dataSources'.

FetchAccessTokenRequest $postBody
array $optParams

Optional parameters.

Return Value

FetchAccessTokenResponse

Exceptions

Exception

Operation finalizeBackup(string $dataSource, FinalizeBackupRequest $postBody, array $optParams = [])

Internal only. Finalize a backup that was started by a call to InitiateBackup. (dataSources.finalizeBackup)

Parameters

string $dataSource

Required. The resource name of the instance, in the format 'projects/locations/backupVaults/dataSources/'.

FinalizeBackupRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

DataSource get(string $name, array $optParams = [])

Gets details of a DataSource. (dataSources.get)

Parameters

string $name

Required. Name of the data source resource name, in the format 'projects/{project_id}/locations/{location}/backupVaults/{resource_nam e}/dataSource/{resource_name}'

array $optParams

Optional parameters.

Return Value

DataSource

Exceptions

Exception

InitiateBackupResponse initiateBackup(string $dataSource, InitiateBackupRequest $postBody, array $optParams = [])

Internal only. Initiates a backup. (dataSources.initiateBackup)

Parameters

string $dataSource

Required. The resource name of the instance, in the format 'projects/locations/backupVaults/dataSources/'.

InitiateBackupRequest $postBody
array $optParams

Optional parameters.

Return Value

InitiateBackupResponse

Exceptions

Exception

ListDataSourcesResponse listProjectsLocationsBackupVaultsDataSources(string $parent, array $optParams = [])

Lists DataSources in a given project and location.

(dataSources.listProjectsLocationsBackupVaultsDataSources)

Parameters

string $parent

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.

array $optParams

Optional parameters.

Return Value

ListDataSourcesResponse

Exceptions

Exception

Operation patch(string $name, DataSource $postBody, array $optParams = [])

Updates the settings of a DataSource. (dataSources.patch)

Parameters

string $name

Output only. Identifier. The resource name.

DataSource $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation remove(string $name, RemoveDataSourceRequest $postBody, array $optParams = [])

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. (dataSources.remove)

Parameters

string $name

Required. Name of the resource.

RemoveDataSourceRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

Operation setInternalStatus(string $dataSource, SetInternalStatusRequest $postBody, array $optParams = [])

Sets the internal status of a DataSource. (dataSources.setInternalStatus)

Parameters

string $dataSource

Required. The resource name of the instance, in the format 'projects/locations/backupVaults/dataSources/'.

SetInternalStatusRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception