Google Cloud Gke Connect Gateway V1beta1 Client - Class GatewayControlClient (0.5.0)

Reference documentation and code samples for the Google Cloud Gke Connect Gateway V1beta1 Client class GatewayControlClient.

Service Description: GatewayControl is the control plane API for Connect Gateway.

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:

$gatewayControlClient = new GatewayControlClient();
try {
    $name = 'name';
    $response = $gatewayControlClient->generateCredentials($name);
} finally {
    $gatewayControlClient->close();
}

Namespace

Google \ Cloud \ GkeConnect \ Gateway \ V1beta1

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.

generateCredentials

GenerateCredentials provides connection information that allows a user to access the specified membership using Connect Gateway.

Parameters
Name	Description
`name`	`string` Required. The Fleet membership resource.
`optionalArgs`	`array` Optional.
`↳ forceUseAgent`	`bool` Optional. Whether to force the use of Connect Agent-based transport. This will return a configuration that uses Connect Agent as the underlying transport mechanism for cluster types that would otherwise have used a different transport. Requires that Connect Agent be installed on the cluster. Setting this field to false is equivalent to not setting it.
`↳ version`	`string` Optional. The Connect Gateway version to be used in the resulting configuration. Leave this field blank to let the server choose the version (recommended).
`↳ kubernetesNamespace`	`string` Optional. The namespace to use in the kubeconfig context. If this field is specified, the server will set the `namespace` field in kubeconfig context. If not specified, the `namespace` field is omitted.
`↳ operatingSystem`	`int` Optional. The operating system where the kubeconfig will be used. For allowed values, use constants defined on Google\Cloud\GkeConnect\Gateway\V1beta1\GenerateCredentialsRequest\OperatingSystem
`↳ 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\GkeConnect\Gateway\V1beta1\GenerateCredentialsResponse`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\GkeConnect\Gateway\V1beta1\Client\GatewayControlClient;
use Google\Cloud\GkeConnect\Gateway\V1beta1\GenerateCredentialsRequest;
use Google\Cloud\GkeConnect\Gateway\V1beta1\GenerateCredentialsResponse;

/**
 * @param string $name The Fleet membership resource.
 */
function generate_credentials_sample(string $name): void
{
    // Create a client.
    $gatewayControlClient = new GatewayControlClient();

    // Prepare the request message.
    $request = (new GenerateCredentialsRequest())
        ->setName($name);

    // Call the API and handle any network failures.
    try {
        /** @var GenerateCredentialsResponse $response */
        $response = $gatewayControlClient->generateCredentials($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
{
    $name = '[NAME]';

    generate_credentials_sample($name);
}

Constants

SERVICE_NAME

Value: 'google.cloud.gkeconnect.gateway.v1beta1.GatewayControl'

The name of the service.

SERVICE_ADDRESS

Value: 'connectgateway.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.