Reference documentation and code samples for the Google Cloud Sql Admin V1beta4 Client class SqlConnectServiceClient.
Service Description: Cloud SQL connect service.
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:
$sqlConnectServiceClient = new SqlConnectServiceClient();
try {
$response = $sqlConnectServiceClient->generateEphemeralCert();
} finally {
$sqlConnectServiceClient->close();
}
Namespace
Google \ Cloud \ Sql \ V1beta4Methods
__construct
Constructor.
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.
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.
↳ publicKey
string
PEM encoded public key to include in the signed certificate.
↳ accessToken
string
Optional. Access token to include in the signed certificate.
↳ readTime
Timestamp
Optional. Optional snapshot read timestamp to trade freshness for performance.
↳ validDuration
Duration
Optional. If set, it will contain the cert valid duration.
↳ 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.
use Google\ApiCore\ApiException;
use Google\Cloud\Sql\V1beta4\GenerateEphemeralCertResponse;
use Google\Cloud\Sql\V1beta4\SqlConnectServiceClient;
/**
* 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();
// Call the API and handle any network failures.
try {
/** @var GenerateEphemeralCertResponse $response */
$response = $sqlConnectServiceClient->generateEphemeralCert();
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.
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.
↳ readTime
Timestamp
Optional. Optional snapshot read timestamp to trade freshness for performance.
↳ 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.
use Google\ApiCore\ApiException;
use Google\Cloud\Sql\V1beta4\ConnectSettings;
use Google\Cloud\Sql\V1beta4\SqlConnectServiceClient;
/**
* 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();
// Call the API and handle any network failures.
try {
/** @var ConnectSettings $response */
$response = $sqlConnectServiceClient->getConnectSettings();
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.SqlConnectService'
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.
