Google Cloud Sql Admin V1 Client - Class SqlConnectServiceClient (0.6.0)

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

Service Description: Cloud SQL connect service.

This class is currently experimental and may be subject to changes.

Namespace

Google \ Cloud \ Sql \ V1 \ Client

Methods

__construct

Constructor.

Parameters
NameDescription
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.

generateEphemeralCert

Generates a short-lived X509 certificate containing the provided public key and signed by a private key specific to the target instance. Users may use the certificate to authenticate as themselves when connecting to the database.

The async variant is Google\Cloud\Sql\V1\Client\BaseClient\self::generateEphemeralCertAsync() .

Parameters
NameDescription
request Google\Cloud\Sql\V1\GenerateEphemeralCertRequest

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
TypeDescription
Google\Cloud\Sql\V1\GenerateEphemeralCertResponse
Example
use Google\ApiCore\ApiException;
use Google\Cloud\Sql\V1\Client\SqlConnectServiceClient;
use Google\Cloud\Sql\V1\GenerateEphemeralCertRequest;
use Google\Cloud\Sql\V1\GenerateEphemeralCertResponse;

/**
 * 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 generate_ephemeral_cert_sample(): void
{
    // Create a client.
    $sqlConnectServiceClient = new SqlConnectServiceClient();

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

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

getConnectSettings

Retrieves connect settings about a Cloud SQL instance.

The async variant is Google\Cloud\Sql\V1\Client\BaseClient\self::getConnectSettingsAsync() .

Parameters
NameDescription
request Google\Cloud\Sql\V1\GetConnectSettingsRequest

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
TypeDescription
Google\Cloud\Sql\V1\ConnectSettings
Example
use Google\ApiCore\ApiException;
use Google\Cloud\Sql\V1\Client\SqlConnectServiceClient;
use Google\Cloud\Sql\V1\ConnectSettings;
use Google\Cloud\Sql\V1\GetConnectSettingsRequest;

/**
 * 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_connect_settings_sample(): void
{
    // Create a client.
    $sqlConnectServiceClient = new SqlConnectServiceClient();

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

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

generateEphemeralCertAsync

Parameters
NameDescription
request Google\Cloud\Sql\V1\GenerateEphemeralCertRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface

getConnectSettingsAsync

Parameters
NameDescription
request Google\Cloud\Sql\V1\GetConnectSettingsRequest
optionalArgs = [] array
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface