Google Cloud Sql Admin V1 Client - Class SqlSslCertsServiceClient (0.11.0)

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

Service Description: Service to manage SSL certs for Cloud SQL instances.

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

Namespace

Google \ Cloud \ Sql \ V1 \ Client

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 SSL certificate. For First Generation instances, the certificate remains valid until the instance is restarted.

The async variant is Google\Cloud\Sql\V1\Client\SqlSslCertsServiceClient::deleteAsync() .

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

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Sql\V1\Client\SqlSslCertsServiceClient;
use Google\Cloud\Sql\V1\Operation;
use Google\Cloud\Sql\V1\SqlSslCertsDeleteRequest;

/**
 * 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.
    $sqlSslCertsServiceClient = new SqlSslCertsServiceClient();

    // Prepare the request message.
    $request = new SqlSslCertsDeleteRequest();

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

get

Retrieves a particular SSL certificate. Does not include the private key (required for usage). The private key must be saved from the response to initial creation.

The async variant is Google\Cloud\Sql\V1\Client\SqlSslCertsServiceClient::getAsync() .

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

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Sql\V1\Client\SqlSslCertsServiceClient;
use Google\Cloud\Sql\V1\SqlSslCertsGetRequest;
use Google\Cloud\Sql\V1\SslCert;

/**
 * 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.
    $sqlSslCertsServiceClient = new SqlSslCertsServiceClient();

    // Prepare the request message.
    $request = new SqlSslCertsGetRequest();

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

insert

Creates an SSL certificate and returns it along with the private key and server certificate authority. The new certificate will not be usable until the instance is restarted.

The async variant is Google\Cloud\Sql\V1\Client\SqlSslCertsServiceClient::insertAsync() .

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

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Sql\V1\Client\SqlSslCertsServiceClient;
use Google\Cloud\Sql\V1\SqlSslCertsInsertRequest;
use Google\Cloud\Sql\V1\SslCertsInsertResponse;

/**
 * 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.
    $sqlSslCertsServiceClient = new SqlSslCertsServiceClient();

    // Prepare the request message.
    $request = new SqlSslCertsInsertRequest();

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

list

Lists all of the current SSL certificates for the instance.

The async variant is Google\Cloud\Sql\V1\Client\SqlSslCertsServiceClient::listAsync() .

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

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Sql\V1\Client\SqlSslCertsServiceClient;
use Google\Cloud\Sql\V1\SqlSslCertsListRequest;
use Google\Cloud\Sql\V1\SslCertsListResponse;

/**
 * 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.
    $sqlSslCertsServiceClient = new SqlSslCertsServiceClient();

    // Prepare the request message.
    $request = new SqlSslCertsListRequest();

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

deleteAsync

Parameters
Name	Description
`request`	`Google\Cloud\Sql\V1\SqlSslCertsDeleteRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getAsync

Parameters
Name	Description
`request`	`Google\Cloud\Sql\V1\SqlSslCertsGetRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

insertAsync

Parameters
Name	Description
`request`	`Google\Cloud\Sql\V1\SqlSslCertsInsertRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listAsync

Parameters
Name	Description
`request`	`Google\Cloud\Sql\V1\SqlSslCertsListRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`