Google Cloud Sql Admin V1 Client - Class BlueGreenDeploymentsServiceClient (1.13.0)

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

Service Description: Service for managing blue-green deployments.

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\BlueGreenDeploymentsServiceClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new BlueGreenDeploymentsServiceClient(['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'.

createBlueGreenDeployment

Creates a blue-green deployment under a given project and location.

The async variant is BlueGreenDeploymentsServiceClient::createBlueGreenDeploymentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Sql\V1\CreateBlueGreenDeploymentRequest` 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
`Google\Cloud\Sql\V1\Operation`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Sql\V1\BlueGreenDeployment;
use Google\Cloud\Sql\V1\Client\BlueGreenDeploymentsServiceClient;
use Google\Cloud\Sql\V1\CreateBlueGreenDeploymentRequest;
use Google\Cloud\Sql\V1\Operation;

/**
 * @param string $formattedParent                            The parent resource where this blue-green deployment will be
 *                                                           created. Format: projects/{project}/locations/{location}
 *                                                           Please see {@see BlueGreenDeploymentsServiceClient::locationName()} for help formatting this field.
 * @param string $blueGreenDeploymentId                      The ID to use for the blue-green deployment, which will become
 *                                                           the final component of the deployment's resource name. The ID must be
 *                                                           unique within the given project and location and between 2-63 characters.
 * @param string $formattedBlueGreenDeploymentSourceInstance Immutable. Required on create, and immutable. The full resource
 *                                                           name of the source instance (the "blue" instance). Format:
 *                                                           projects/{project}/instances/{instance}
 *                                                           Please see {@see BlueGreenDeploymentsServiceClient::instanceName()} for help formatting this field.
 */
function create_blue_green_deployment_sample(
    string $formattedParent,
    string $blueGreenDeploymentId,
    string $formattedBlueGreenDeploymentSourceInstance
): void {
    // Create a client.
    $blueGreenDeploymentsServiceClient = new BlueGreenDeploymentsServiceClient();

    // Prepare the request message.
    $blueGreenDeployment = (new BlueGreenDeployment())
        ->setSourceInstance($formattedBlueGreenDeploymentSourceInstance);
    $request = (new CreateBlueGreenDeploymentRequest())
        ->setParent($formattedParent)
        ->setBlueGreenDeploymentId($blueGreenDeploymentId)
        ->setBlueGreenDeployment($blueGreenDeployment);

    // Call the API and handle any network failures.
    try {
        /** @var Operation $response */
        $response = $blueGreenDeploymentsServiceClient->createBlueGreenDeployment($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 = BlueGreenDeploymentsServiceClient::locationName('[PROJECT]', '[LOCATION]');
    $blueGreenDeploymentId = '[BLUE_GREEN_DEPLOYMENT_ID]';
    $formattedBlueGreenDeploymentSourceInstance = BlueGreenDeploymentsServiceClient::instanceName(
        '[PROJECT]',
        '[INSTANCE]'
    );

    create_blue_green_deployment_sample(
        $formattedParent,
        $blueGreenDeploymentId,
        $formattedBlueGreenDeploymentSourceInstance
    );
}

deleteBlueGreenDeployment

Deletes a blue-green deployment.

The async variant is BlueGreenDeploymentsServiceClient::deleteBlueGreenDeploymentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Sql\V1\DeleteBlueGreenDeploymentRequest` 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
`Google\Cloud\Sql\V1\Operation`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Sql\V1\Client\BlueGreenDeploymentsServiceClient;
use Google\Cloud\Sql\V1\DeleteBlueGreenDeploymentRequest;
use Google\Cloud\Sql\V1\Operation;

/**
 * @param string $formattedName The name of the blue-green deployment to delete.
 *                              Format:
 *                              projects/{project}/locations/{location}/blueGreenDeployments/{blue_green_deployment}
 *                              Please see {@see BlueGreenDeploymentsServiceClient::blueGreenDeploymentName()} for help formatting this field.
 */
function delete_blue_green_deployment_sample(string $formattedName): void
{
    // Create a client.
    $blueGreenDeploymentsServiceClient = new BlueGreenDeploymentsServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Operation $response */
        $response = $blueGreenDeploymentsServiceClient->deleteBlueGreenDeployment($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 = BlueGreenDeploymentsServiceClient::blueGreenDeploymentName(
        '[PROJECT]',
        '[LOCATION]',
        '[BLUE_GREEN_DEPLOYMENT]'
    );

    delete_blue_green_deployment_sample($formattedName);
}

getBlueGreenDeployment

Retrieves a blue-green deployment resource under a given project and location.

The async variant is BlueGreenDeploymentsServiceClient::getBlueGreenDeploymentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Sql\V1\GetBlueGreenDeploymentRequest` 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
`Google\Cloud\Sql\V1\BlueGreenDeployment`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Sql\V1\BlueGreenDeployment;
use Google\Cloud\Sql\V1\Client\BlueGreenDeploymentsServiceClient;
use Google\Cloud\Sql\V1\GetBlueGreenDeploymentRequest;

/**
 * @param string $formattedName The name of the blue-green deployment to retrieve.
 *                              Format:
 *                              projects/{project}/locations/{location}/blueGreenDeployments/{blue_green_deployment}
 *                              Please see {@see BlueGreenDeploymentsServiceClient::blueGreenDeploymentName()} for help formatting this field.
 */
function get_blue_green_deployment_sample(string $formattedName): void
{
    // Create a client.
    $blueGreenDeploymentsServiceClient = new BlueGreenDeploymentsServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var BlueGreenDeployment $response */
        $response = $blueGreenDeploymentsServiceClient->getBlueGreenDeployment($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 = BlueGreenDeploymentsServiceClient::blueGreenDeploymentName(
        '[PROJECT]',
        '[LOCATION]',
        '[BLUE_GREEN_DEPLOYMENT]'
    );

    get_blue_green_deployment_sample($formattedName);
}

listBlueGreenDeployments

Lists blue-green deployments under a given project.

The async variant is BlueGreenDeploymentsServiceClient::listBlueGreenDeploymentsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Sql\V1\ListBlueGreenDeploymentsRequest` 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
`Google\ApiCore\PagedListResponse`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Sql\V1\BlueGreenDeployment;
use Google\Cloud\Sql\V1\Client\BlueGreenDeploymentsServiceClient;
use Google\Cloud\Sql\V1\ListBlueGreenDeploymentsRequest;

/**
 * @param string $formattedParent The parent resource whose blue-green deployments are to be
 *                                listed. Format: projects/{project}/locations/{location}
 *                                Please see {@see BlueGreenDeploymentsServiceClient::locationName()} for help formatting this field.
 */
function list_blue_green_deployments_sample(string $formattedParent): void
{
    // Create a client.
    $blueGreenDeploymentsServiceClient = new BlueGreenDeploymentsServiceClient();

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

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

        /** @var BlueGreenDeployment $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 = BlueGreenDeploymentsServiceClient::locationName('[PROJECT]', '[LOCATION]');

    list_blue_green_deployments_sample($formattedParent);
}

switchoverBlueGreenDeployment

Switches over to green instance for a blue-green deployment.

The async variant is BlueGreenDeploymentsServiceClient::switchoverBlueGreenDeploymentAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Sql\V1\SwitchoverBlueGreenDeploymentRequest` 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
`Google\Cloud\Sql\V1\Operation`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Sql\V1\Client\BlueGreenDeploymentsServiceClient;
use Google\Cloud\Sql\V1\Operation;
use Google\Cloud\Sql\V1\SwitchoverBlueGreenDeploymentRequest;

/**
 * @param string $formattedName The name of the blue-green deployment to switch over.
 *                              Format:
 *                              projects/{project}/locations/{location}/blueGreenDeployments/{blue_green_deployment}
 *                              Please see {@see BlueGreenDeploymentsServiceClient::blueGreenDeploymentName()} for help formatting this field.
 */
function switchover_blue_green_deployment_sample(string $formattedName): void
{
    // Create a client.
    $blueGreenDeploymentsServiceClient = new BlueGreenDeploymentsServiceClient();

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

    // Call the API and handle any network failures.
    try {
        /** @var Operation $response */
        $response = $blueGreenDeploymentsServiceClient->switchoverBlueGreenDeployment($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 = BlueGreenDeploymentsServiceClient::blueGreenDeploymentName(
        '[PROJECT]',
        '[LOCATION]',
        '[BLUE_GREEN_DEPLOYMENT]'
    );

    switchover_blue_green_deployment_sample($formattedName);
}

createBlueGreenDeploymentAsync

Parameters
Name	Description
`request`	`Google\Cloud\Sql\V1\CreateBlueGreenDeploymentRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Sql\V1\Operation>`

deleteBlueGreenDeploymentAsync

Parameters
Name	Description
`request`	`Google\Cloud\Sql\V1\DeleteBlueGreenDeploymentRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Sql\V1\Operation>`

getBlueGreenDeploymentAsync

Parameters
Name	Description
`request`	`Google\Cloud\Sql\V1\GetBlueGreenDeploymentRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Sql\V1\BlueGreenDeployment>`

listBlueGreenDeploymentsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Sql\V1\ListBlueGreenDeploymentsRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>`

switchoverBlueGreenDeploymentAsync

Parameters
Name	Description
`request`	`Google\Cloud\Sql\V1\SwitchoverBlueGreenDeploymentRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Sql\V1\Operation>`

static::blueGreenDeploymentName

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

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

Returns
Type	Description
`string`	The formatted blue_green_deployment resource.

static::instanceName

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

Parameters
Name	Description
`project`	`string`
`instance`	`string`

Returns
Type	Description
`string`	The formatted instance resource.

static::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.

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

blueGreenDeployment: projects/{project}/locations/{location}/blueGreenDeployments/{blue_green_deployment}
instance: projects/{project}/instances/{instance}
location: projects/{project}/locations/{location}

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.

Google Cloud Sql Admin V1 Client - Class BlueGreenDeploymentsServiceClient (1.13.0) Stay organized with collections Save and categorize content based on your preferences.

Namespace

Methods

__construct

createBlueGreenDeployment

deleteBlueGreenDeployment

getBlueGreenDeployment

listBlueGreenDeployments

switchoverBlueGreenDeployment

createBlueGreenDeploymentAsync

deleteBlueGreenDeploymentAsync

getBlueGreenDeploymentAsync

listBlueGreenDeploymentsAsync

switchoverBlueGreenDeploymentAsync

static::blueGreenDeploymentName

static::instanceName

static::locationName

static::parseName

Google Cloud Sql Admin V1 Client - Class BlueGreenDeploymentsServiceClient (1.13.0)