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.
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.
operationName
string
The name of the long running operation
methodName
string
The name of the method used to start the operation
backupName
Formats a string containing the fully-qualified path to represent a backup resource.
project
string
location
string
backupPlan
string
backup
string
string
backupPlanName
Formats a string containing the fully-qualified path to represent a backup_plan resource.
project
string
location
string
backupPlan
string
string
clusterName
Formats a string containing the fully-qualified path to represent a cluster resource.
project
string
location
string
cluster
string
string
cryptoKeyName
Formats a string containing the fully-qualified path to represent a crypto_key resource.
project
string
location
string
keyRing
string
cryptoKey
string
string
locationName
Formats a string containing the fully-qualified path to represent a location resource.
project
string
location
string
string
restoreName
Formats a string containing the fully-qualified path to represent a restore resource.
project
string
location
string
restorePlan
string
restore
string
string
restorePlanName
Formats a string containing the fully-qualified path to represent a restore_plan resource.
project
string
location
string
restorePlan
string
string
volumeBackupName
Formats a string containing the fully-qualified path to represent a volume_backup resource.
project
string
location
string
backupPlan
string
backup
string
volumeBackup
string
string
volumeRestoreName
Formats a string containing the fully-qualified path to represent a volume_restore resource.
project
string
location
string
restorePlan
string
restore
string
volumeRestore
string
string
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.
formattedName
string
The formatted name string
template
string
Optional name of template to match
array
__construct
Constructor.
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.
method
mixed
args
mixed
createBackup
Creates a Backup for the given BackupPlan.
The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::createBackupAsync() .
request
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.
createBackupPlan
Creates a new BackupPlan in a given location.
The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::createBackupPlanAsync() .
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.
createRestore
Creates a new Restore for the given RestorePlan.
The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::createRestoreAsync() .
request
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.
createRestorePlan
Creates a new RestorePlan in a given location.
The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::createRestorePlanAsync() .
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.
deleteBackup
Deletes an existing Backup.
The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::deleteBackupAsync() .
request
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.
deleteBackupPlan
Deletes an existing BackupPlan.
The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::deleteBackupPlanAsync() .
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.
deleteRestore
Deletes an existing Restore.
The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::deleteRestoreAsync() .
request
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.
deleteRestorePlan
Deletes an existing RestorePlan.
The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::deleteRestorePlanAsync() .
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.
getBackup
Retrieve the details of a single Backup.
The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::getBackupAsync() .
request
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.
getBackupPlan
Retrieve the details of a single BackupPlan.
The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::getBackupPlanAsync() .
request
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.
getRestore
Retrieves the details of a single Restore.
The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::getRestoreAsync() .
request
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.
getRestorePlan
Retrieve the details of a single RestorePlan.
The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::getRestorePlanAsync() .
request
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.
getVolumeBackup
Retrieve the details of a single VolumeBackup.
The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::getVolumeBackupAsync() .
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.
getVolumeRestore
Retrieve the details of a single VolumeRestore.
The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::getVolumeRestoreAsync() .
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.
listBackupPlans
Lists BackupPlans in a given location.
The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::listBackupPlansAsync() .
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.
listBackups
Lists the Backups for a given BackupPlan.
The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::listBackupsAsync() .
request
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.
listRestorePlans
Lists RestorePlans in a given location.
The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::listRestorePlansAsync() .
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.
listRestores
Lists the Restores for a given RestorePlan.
The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::listRestoresAsync() .
request
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.
listVolumeBackups
Lists the VolumeBackups for a given Backup.
The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::listVolumeBackupsAsync() .
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.
listVolumeRestores
Lists the VolumeRestores for a given Restore.
The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::listVolumeRestoresAsync() .
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.
updateBackup
Update a Backup.
The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::updateBackupAsync() .
request
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.
updateBackupPlan
Update a BackupPlan.
The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::updateBackupPlanAsync() .
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.
updateRestore
Update a Restore.
The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::updateRestoreAsync() .
request
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.
updateRestorePlan
Update a RestorePlan.
The async variant is Google\Cloud\GkeBackup\V1\Client\BaseClient\self::updateRestorePlanAsync() .
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.
