Google Cloud Gke Backup V1 Client - Class BackupForGKEClient (0.2.0)

Reference documentation and code samples for the Google Cloud Gke Backup V1 Client class BackupForGKEClient.

Service Description: BackupForGKE allows Kubernetes administrators to configure, execute, and manage backup and restore operations for their GKE clusters.

This class is currently experimental and may be subject to changes.

Methods

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
Type	Description
`Google\ApiCore\LongRunning\OperationsClient`

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
Name	Description
`operationName`	`string` The name of the long running operation
`methodName`	`string` The name of the method used to start the operation

Returns
Type	Description
`Google\ApiCore\OperationResponse`

backupName

Formats a string containing the fully-qualified path to represent a backup resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`backupPlan`	`string`
`backup`	`string`

Returns
Type	Description
`string`	The formatted backup resource.

backupPlanName

Formats a string containing the fully-qualified path to represent a backup_plan resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`backupPlan`	`string`

Returns
Type	Description
`string`	The formatted backup_plan resource.

clusterName

Formats a string containing the fully-qualified path to represent a cluster resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`cluster`	`string`

Returns
Type	Description
`string`	The formatted cluster resource.

cryptoKeyName

Formats a string containing the fully-qualified path to represent a crypto_key resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`keyRing`	`string`
`cryptoKey`	`string`

Returns
Type	Description
`string`	The formatted crypto_key resource.

locationName

Formats a string containing the fully-qualified path to represent a location resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`

Returns
Type	Description
`string`	The formatted location resource.

restoreName

Formats a string containing the fully-qualified path to represent a restore resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`restorePlan`	`string`
`restore`	`string`

Returns
Type	Description
`string`	The formatted restore resource.

restorePlanName

Formats a string containing the fully-qualified path to represent a restore_plan resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`restorePlan`	`string`

Returns
Type	Description
`string`	The formatted restore_plan resource.

volumeBackupName

Formats a string containing the fully-qualified path to represent a volume_backup resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`backupPlan`	`string`
`backup`	`string`
`volumeBackup`	`string`

Returns
Type	Description
`string`	The formatted volume_backup resource.

volumeRestoreName

Formats a string containing the fully-qualified path to represent a volume_restore resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`restorePlan`	`string`
`restore`	`string`
`volumeRestore`	`string`

Returns
Type	Description
`string`	The formatted volume_restore resource.

parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

backup: projects/{project}/locations/{location}/backupPlans/{backup_plan}/backups/{backup}
backupPlan: projects/{project}/locations/{location}/backupPlans/{backup_plan}
cluster: projects/{project}/locations/{location}/clusters/{cluster}
cryptoKey: projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}
location: projects/{project}/locations/{location}
restore: projects/{project}/locations/{location}/restorePlans/{restore_plan}/restores/{restore}
restorePlan: projects/{project}/locations/{location}/restorePlans/{restore_plan}
volumeBackup: projects/{project}/locations/{location}/backupPlans/{backup_plan}/backups/{backup}/volumeBackups/{volume_backup}
volumeRestore: projects/{project}/locations/{location}/restorePlans/{restore_plan}/restores/{restore}/volumeRestores/{volume_restore}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name	Description
`formattedName`	`string` The formatted name string
`template`	`string` Optional name of template to match

Returns
Type	Description
`array`	An associative array from name component IDs to component values.

__construct

Constructor.

Parameters
Name	Description
`options`	`array` Optional. Options for configuring the service API wrapper.
`↳ apiEndpoint`	`string` The address of the API remote host. May optionally include the port, formatted as "
`↳ credentials`	`string\|array\|FetchAuthTokenInterface\|CredentialsWrapper` The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
`↳ credentialsConfig`	`array` Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
`↳ disableRetries`	`bool` Determines whether or not retries defined by the client configuration should be disabled. Defaults to `false`.
`↳ clientConfig`	`string\|array` Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
`↳ transport`	`string\|TransportInterface` The transport used for executing network requests. May be either the string `rest` or `grpc`. Defaults to `grpc` if gRPC support is detected on the system. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
`↳ transportConfig`	`array` Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options.
`↳ clientCertSource`	`callable` A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS.

__call

Handles execution of the async variants for each documented method.

Parameters
Name	Description
`method`	`mixed`
`args`	`mixed`

createBackup

Creates a Backup for the given BackupPlan.

The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::createBackupAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\GkeBackup\V1\CreateBackupRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

createBackupPlan

Creates a new BackupPlan in a given location.

The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::createBackupPlanAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\GkeBackup\V1\CreateBackupPlanRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

createRestore

Creates a new Restore for the given RestorePlan.

The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::createRestoreAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\GkeBackup\V1\CreateRestoreRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

createRestorePlan

Creates a new RestorePlan in a given location.

The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::createRestorePlanAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\GkeBackup\V1\CreateRestorePlanRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

deleteBackup

Deletes an existing Backup.

The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::deleteBackupAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\GkeBackup\V1\DeleteBackupRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

deleteBackupPlan

Deletes an existing BackupPlan.

The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::deleteBackupPlanAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\GkeBackup\V1\DeleteBackupPlanRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

deleteRestore

Deletes an existing Restore.

The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::deleteRestoreAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\GkeBackup\V1\DeleteRestoreRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

deleteRestorePlan

Deletes an existing RestorePlan.

The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::deleteRestorePlanAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\GkeBackup\V1\DeleteRestorePlanRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

getBackup

Retrieve the details of a single Backup.

The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::getBackupAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\GkeBackup\V1\GetBackupRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\GkeBackup\V1\Backup`

getBackupPlan

Retrieve the details of a single BackupPlan.

The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::getBackupPlanAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\GkeBackup\V1\GetBackupPlanRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\GkeBackup\V1\BackupPlan`

getRestore

Retrieves the details of a single Restore.

The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::getRestoreAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\GkeBackup\V1\GetRestoreRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\GkeBackup\V1\Restore`

getRestorePlan

Retrieve the details of a single RestorePlan.

The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::getRestorePlanAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\GkeBackup\V1\GetRestorePlanRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\GkeBackup\V1\RestorePlan`

getVolumeBackup

Retrieve the details of a single VolumeBackup.

The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::getVolumeBackupAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\GkeBackup\V1\GetVolumeBackupRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\GkeBackup\V1\VolumeBackup`

getVolumeRestore

Retrieve the details of a single VolumeRestore.

The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::getVolumeRestoreAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\GkeBackup\V1\GetVolumeRestoreRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\Cloud\GkeBackup\V1\VolumeRestore`

listBackupPlans

Lists BackupPlans in a given location.

The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::listBackupPlansAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\GkeBackup\V1\ListBackupPlansRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

listBackups

Lists the Backups for a given BackupPlan.

The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::listBackupsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\GkeBackup\V1\ListBackupsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

listRestorePlans

Lists RestorePlans in a given location.

The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::listRestorePlansAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\GkeBackup\V1\ListRestorePlansRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

listRestores

Lists the Restores for a given RestorePlan.

The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::listRestoresAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\GkeBackup\V1\ListRestoresRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

listVolumeBackups

Lists the VolumeBackups for a given Backup.

The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::listVolumeBackupsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\GkeBackup\V1\ListVolumeBackupsRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

listVolumeRestores

Lists the VolumeRestores for a given Restore.

The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::listVolumeRestoresAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\GkeBackup\V1\ListVolumeRestoresRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\PagedListResponse`

updateBackup

Update a Backup.

The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::updateBackupAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\GkeBackup\V1\UpdateBackupRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

updateBackupPlan

Update a BackupPlan.

The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::updateBackupPlanAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\GkeBackup\V1\UpdateBackupPlanRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

updateRestore

Update a Restore.

The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::updateRestoreAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\GkeBackup\V1\UpdateRestoreRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`

updateRestorePlan

Update a RestorePlan.

The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::updateRestorePlanAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\GkeBackup\V1\UpdateRestorePlanRequest` A request to house fields associated with the call.
`callOptions`	`array` Optional.
`↳ retrySettings`	`RetrySettings\|array` Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage.

Returns
Type	Description
`Google\ApiCore\OperationResponse`