Google Cloud Sql Admin V1 Client - Class SqlBackupsServiceClient (1.9.0)

Reference documentation and code samples for the Google Cloud Sql Admin V1 Client class SqlBackupsServiceClient.

Service Description:

This class provides the ability to make remote calls to the backing service through method calls that map to API methods.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.

Namespace

Google \ Cloud \ Sql \ V1 \ Client

Methods

__construct

Constructor.

Parameters
Name
Description
options
array| Google\ApiCore\Options\ClientOptions

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
Google\Auth\FetchAuthTokenInterface | Google\ApiCore\CredentialsWrapper

This option should only be used with a pre-constructed Google\Auth\FetchAuthTokenInterface or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. Important: If you are providing a path to a credentials file, or a decoded credentials file as a PHP array, this usage is now DEPRECATED. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. It is recommended to create the credentials explicitly use Google\Auth\Credentials\ServiceAccountCredentials; use Google\Cloud\Sql\V1\SqlBackupsServiceClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new SqlBackupsServiceClient(['credentials' => $creds]); https://cloud.google.com/docs/authentication/external/externally-sourced-credentials

↳ 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| Google\ApiCore\Transport\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.

↳ logger
false| Psr\Log\LoggerInterface

A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag

↳ universeDomain
string

The service domain for the client. Defaults to 'googleapis.com'.

createBackup

Creates a backup for a Cloud SQL instance. This API can be used only to create on-demand backups.

The async variant is SqlBackupsServiceClient::createBackupAsync() .

Parameters
Name
Description
request
Google\Cloud\Sql\V1\CreateBackupRequest

A request to house fields associated with the call.

callOptions
array

Optional.

↳ retrySettings
Google\ApiCore\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
Example
 use Google\ApiCore\ApiException;
use Google\Cloud\Sql\V1\Backup;
use Google\Cloud\Sql\V1\Client\SqlBackupsServiceClient;
use Google\Cloud\Sql\V1\CreateBackupRequest;
use Google\Cloud\Sql\V1\Operation;

/**
 * @param string $formattedParent The parent resource where this backup is created.
 *                                Format: projects/{project}
 *                                Please see {@see SqlBackupsServiceClient::projectName()} for help formatting this field.
 */
function create_backup_sample(string $formattedParent): void
{
    // Create a client.
    $sqlBackupsServiceClient = new SqlBackupsServiceClient();

    // Prepare the request message.
    $backup = new Backup();
    $request = (new CreateBackupRequest())
        ->setParent($formattedParent)
        ->setBackup($backup);

    // Call the API and handle any network failures.
    try {
        /** @var Operation $response */
        $response = $sqlBackupsServiceClient->createBackup($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = SqlBackupsServiceClient::projectName('[PROJECT]');

    create_backup_sample($formattedParent);
} 

deleteBackup

Deletes the backup.

The async variant is SqlBackupsServiceClient::deleteBackupAsync() .

Parameters
Name
Description
request
Google\Cloud\Sql\V1\DeleteBackupRequest

A request to house fields associated with the call.

callOptions
array

Optional.

↳ retrySettings
Google\ApiCore\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
Example
 use Google\ApiCore\ApiException;
use Google\Cloud\Sql\V1\Client\SqlBackupsServiceClient;
use Google\Cloud\Sql\V1\DeleteBackupRequest;
use Google\Cloud\Sql\V1\Operation;

/**
 * @param string $formattedName The name of the backup to delete.
 *                              Format: projects/{project}/backups/{backup}
 *                              Please see {@see SqlBackupsServiceClient::backupName()} for help formatting this field.
 */
function delete_backup_sample(string $formattedName): void
{
    // Create a client.
    $sqlBackupsServiceClient = new SqlBackupsServiceClient();

    // Prepare the request message.
    $request = (new DeleteBackupRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var Operation $response */
        $response = $sqlBackupsServiceClient->deleteBackup($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = SqlBackupsServiceClient::backupName('[PROJECT]', '[BACKUP]');

    delete_backup_sample($formattedName);
} 

getBackup

Retrieves a resource containing information about a backup.

The async variant is SqlBackupsServiceClient::getBackupAsync() .

Parameters
Name
Description
request
Google\Cloud\Sql\V1\GetBackupRequest

A request to house fields associated with the call.

callOptions
array

Optional.

↳ retrySettings
Google\ApiCore\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
Example
 use Google\ApiCore\ApiException;
use Google\Cloud\Sql\V1\Backup;
use Google\Cloud\Sql\V1\Client\SqlBackupsServiceClient;
use Google\Cloud\Sql\V1\GetBackupRequest;

/**
 * @param string $formattedName The name of the backup to retrieve.
 *                              Format: projects/{project}/backups/{backup}
 *                              Please see {@see SqlBackupsServiceClient::backupName()} for help formatting this field.
 */
function get_backup_sample(string $formattedName): void
{
    // Create a client.
    $sqlBackupsServiceClient = new SqlBackupsServiceClient();

    // Prepare the request message.
    $request = (new GetBackupRequest())
        ->setName($formattedName);

    // Call the API and handle any network failures.
    try {
        /** @var Backup $response */
        $response = $sqlBackupsServiceClient->getBackup($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedName = SqlBackupsServiceClient::backupName('[PROJECT]', '[BACKUP]');

    get_backup_sample($formattedName);
} 

listBackups

Lists all backups associated with the project.

The async variant is SqlBackupsServiceClient::listBackupsAsync() .

Parameters
Name
Description
request
Google\Cloud\Sql\V1\ListBackupsRequest

A request to house fields associated with the call.

callOptions
array

Optional.

↳ retrySettings
Google\ApiCore\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
Example
 use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Sql\V1\Backup;
use Google\Cloud\Sql\V1\Client\SqlBackupsServiceClient;
use Google\Cloud\Sql\V1\ListBackupsRequest;

/**
 * @param string $formattedParent The parent that owns this collection of backups.
 *                                Format: projects/{project}
 *                                Please see {@see SqlBackupsServiceClient::projectName()} for help formatting this field.
 */
function list_backups_sample(string $formattedParent): void
{
    // Create a client.
    $sqlBackupsServiceClient = new SqlBackupsServiceClient();

    // Prepare the request message.
    $request = (new ListBackupsRequest())
        ->setParent($formattedParent);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $sqlBackupsServiceClient->listBackups($request);

        /** @var Backup $element */
        foreach ($response as $element) {
            printf('Element data: %s' . PHP_EOL, $element->serializeToJsonString());
        }
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
}

/**
 * Helper to execute the sample.
 *
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function callSample(): void
{
    $formattedParent = SqlBackupsServiceClient::projectName('[PROJECT]');

    list_backups_sample($formattedParent);
} 

updateBackup

Updates the retention period and description of the backup. You can use this API to update final backups only.

The async variant is SqlBackupsServiceClient::updateBackupAsync() .

Parameters
Name
Description
request
Google\Cloud\Sql\V1\UpdateBackupRequest

A request to house fields associated with the call.

callOptions
array

Optional.

↳ retrySettings
Google\ApiCore\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
Example
 use Google\ApiCore\ApiException;
use Google\Cloud\Sql\V1\Backup;
use Google\Cloud\Sql\V1\Client\SqlBackupsServiceClient;
use Google\Cloud\Sql\V1\Operation;
use Google\Cloud\Sql\V1\UpdateBackupRequest;

/**
 * This sample has been automatically generated and should be regarded as a code
 * template only. It will require modifications to work:
 *  - It may require correct/in-range values for request initialization.
 *  - It may require specifying regional endpoints when creating the service client,
 *    please see the apiEndpoint client configuration option for more details.
 */
function update_backup_sample(): void
{
    // Create a client.
    $sqlBackupsServiceClient = new SqlBackupsServiceClient();

    // Prepare the request message.
    $backup = new Backup();
    $request = (new UpdateBackupRequest())
        ->setBackup($backup);

    // Call the API and handle any network failures.
    try {
        /** @var Operation $response */
        $response = $sqlBackupsServiceClient->updateBackup($request);
        printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
    } catch (ApiException $ex) {
        printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
    }
} 

createBackupAsync

Parameters
Name
Description
optionalArgs
array

deleteBackupAsync

Parameters
Name
Description
optionalArgs
array

getBackupAsync

Parameters
Name
Description
optionalArgs
array

listBackupsAsync

Parameters
Name
Description
optionalArgs
array

updateBackupAsync

Parameters
Name
Description
optionalArgs
array

static::backupName

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

Parameters
Name
Description
project
string
backup
string
Returns
Type
Description
string
The formatted backup resource.

static::projectName

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

Parameter
Name
Description
project
string
Returns
Type
Description
string
The formatted project resource.

static::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}/backups/{backup}
  • project: projects/{project}

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.
Create a Mobile Website
View Site in Mobile | Classic
Share by: