Google Cloud Sql Admin V1beta4 Client - Class SqlBackupRunsServiceClient (0.7.0)

Reference documentation and code samples for the Google Cloud Sql Admin V1beta4 Client class SqlBackupRunsServiceClient.

Service Description:

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

$sqlBackupRunsServiceClient = new SqlBackupRunsServiceClient();
try {
 $response = $sqlBackupRunsServiceClient->delete();
} finally {
 $sqlBackupRunsServiceClient->close();
}

Namespace

Google \ Cloud \ Sql \ V1beta4

Methods

__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.

delete

Deletes the backup taken by a backup run.

Parameters
Name Description
optionalArgs array

Optional.
↳ id int

The ID of the backup run to delete. To find a backup run ID, use the list method.
↳ instance string

Cloud SQL instance ID. This does not include the project ID.
↳ project string

Project ID of the project that contains the instance.
↳ 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\Sql\V1beta4\Operation
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Sql\V1beta4\Operation;
use Google\Cloud\Sql\V1beta4\SqlBackupRunsServiceClient;
/**
 * 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 delete_sample(): void
{
 // Create a client.
 $sqlBackupRunsServiceClient = new SqlBackupRunsServiceClient();
 // Call the API and handle any network failures.
 try {
 /** @var Operation $response */
 $response = $sqlBackupRunsServiceClient->delete();
 printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
 } catch (ApiException $ex) {
 printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
 }
}

get

Retrieves a resource containing information about a backup run.

Parameters
Name Description
optionalArgs array

Optional.
↳ id int

The ID of this backup run.
↳ instance string

Cloud SQL instance ID. This does not include the project ID.
↳ project string

Project ID of the project that contains the instance.
↳ 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\Sql\V1beta4\BackupRun
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Sql\V1beta4\BackupRun;
use Google\Cloud\Sql\V1beta4\SqlBackupRunsServiceClient;
/**
 * 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 get_sample(): void
{
 // Create a client.
 $sqlBackupRunsServiceClient = new SqlBackupRunsServiceClient();
 // Call the API and handle any network failures.
 try {
 /** @var BackupRun $response */
 $response = $sqlBackupRunsServiceClient->get();
 printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
 } catch (ApiException $ex) {
 printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
 }
}

insert

Creates a new backup run on demand.

Parameters
Name Description
optionalArgs array

Optional.
↳ instance string

Cloud SQL instance ID. This does not include the project ID.
↳ project string

Project ID of the project that contains the instance.
↳ body BackupRun
↳ 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\Sql\V1beta4\Operation
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Sql\V1beta4\Operation;
use Google\Cloud\Sql\V1beta4\SqlBackupRunsServiceClient;
/**
 * 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 insert_sample(): void
{
 // Create a client.
 $sqlBackupRunsServiceClient = new SqlBackupRunsServiceClient();
 // Call the API and handle any network failures.
 try {
 /** @var Operation $response */
 $response = $sqlBackupRunsServiceClient->insert();
 printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
 } catch (ApiException $ex) {
 printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
 }
}

list

Lists all backup runs associated with the project or a given instance and configuration in the reverse chronological order of the backup initiation time.

Parameters
Name Description
optionalArgs array

Optional.
↳ instance string

Cloud SQL instance ID, or "-" for all instances. This does not include the project ID.
↳ maxResults int

Maximum number of backup runs per response.
↳ pageToken string

A previously-returned page token representing part of the larger set of results to view.
↳ project string

Project ID of the project that contains the instance.
↳ 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\Sql\V1beta4\BackupRunsListResponse
Example 
use Google\ApiCore\ApiException;
use Google\Cloud\Sql\V1beta4\BackupRunsListResponse;
use Google\Cloud\Sql\V1beta4\SqlBackupRunsServiceClient;
/**
 * 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 list_sample(): void
{
 // Create a client.
 $sqlBackupRunsServiceClient = new SqlBackupRunsServiceClient();
 // Call the API and handle any network failures.
 try {
 /** @var BackupRunsListResponse $response */
 $response = $sqlBackupRunsServiceClient->list();
 printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
 } catch (ApiException $ex) {
 printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
 }
}

Constants

SERVICE_NAME

Value: 'google.cloud.sql.v1beta4.SqlBackupRunsService'

The name of the service.

SERVICE_ADDRESS

Value: 'sqladmin.googleapis.com'

The default address of the service.

DEFAULT_SERVICE_PORT

Value: 443

The default port of the service.

CODEGEN_NAME

Value: 'gapic'

The name of the code generator, to be included in the agent header.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年11月21日 UTC.