Google Cloud Gke Connect Gateway V1beta1 Client - Class GatewayServiceClient (0.1.12)

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

Service Description: Gateway service is a public API which works as a Kubernetes resource model proxy between end users and registered Kubernetes clusters. Each RPC in this service matches with an HTTP verb. End user will initiate kubectl commands against the Gateway service, and Gateway service will forward user requests to clusters.

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:

$gatewayServiceClient = new GatewayServiceClient();
try {
    $response = $gatewayServiceClient->deleteResource();
} finally {
    $gatewayServiceClient->close();
}

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.

deleteResource

DeleteResource performs an HTTP DELETE on the Kubernetes API Server.

Parameters
Name	Description
`optionalArgs`	`array` Optional.
`↳ contentType`	`string` The HTTP Content-Type header value specifying the content type of the body.
`↳ data`	`string` The HTTP request/response body as raw binary.
`↳ extensions`	`Any[]` Application specific response metadata. Must be set in the first response for streaming APIs.
`↳ 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\Api\HttpBody`

Example

use Google\ApiCore\ApiException;
use Google\Api\HttpBody;
use Google\Cloud\GkeConnect\Gateway\V1beta1\GatewayServiceClient;

/**
 * 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_resource_sample(): void
{
    // Create a client.
    $gatewayServiceClient = new GatewayServiceClient();

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

getResource

GetResource performs an HTTP GET request on the Kubernetes API Server.

Parameters
Name	Description
`optionalArgs`	`array` Optional.
`↳ contentType`	`string` The HTTP Content-Type header value specifying the content type of the body.
`↳ data`	`string` The HTTP request/response body as raw binary.
`↳ extensions`	`Any[]` Application specific response metadata. Must be set in the first response for streaming APIs.
`↳ 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\Api\HttpBody`

Example

use Google\ApiCore\ApiException;
use Google\Api\HttpBody;
use Google\Cloud\GkeConnect\Gateway\V1beta1\GatewayServiceClient;

/**
 * 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_resource_sample(): void
{
    // Create a client.
    $gatewayServiceClient = new GatewayServiceClient();

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

patchResource

PatchResource performs an HTTP PATCH on the Kubernetes API Server.

Parameters
Name	Description
`optionalArgs`	`array` Optional.
`↳ contentType`	`string` The HTTP Content-Type header value specifying the content type of the body.
`↳ data`	`string` The HTTP request/response body as raw binary.
`↳ extensions`	`Any[]` Application specific response metadata. Must be set in the first response for streaming APIs.
`↳ 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\Api\HttpBody`

Example

use Google\ApiCore\ApiException;
use Google\Api\HttpBody;
use Google\Cloud\GkeConnect\Gateway\V1beta1\GatewayServiceClient;

/**
 * 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 patch_resource_sample(): void
{
    // Create a client.
    $gatewayServiceClient = new GatewayServiceClient();

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

postResource

PostResource performs an HTTP POST on the Kubernetes API Server.

Parameters
Name	Description
`optionalArgs`	`array` Optional.
`↳ contentType`	`string` The HTTP Content-Type header value specifying the content type of the body.
`↳ data`	`string` The HTTP request/response body as raw binary.
`↳ extensions`	`Any[]` Application specific response metadata. Must be set in the first response for streaming APIs.
`↳ 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\Api\HttpBody`

Example

use Google\ApiCore\ApiException;
use Google\Api\HttpBody;
use Google\Cloud\GkeConnect\Gateway\V1beta1\GatewayServiceClient;

/**
 * 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 post_resource_sample(): void
{
    // Create a client.
    $gatewayServiceClient = new GatewayServiceClient();

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

putResource

PutResource performs an HTTP PUT on the Kubernetes API Server.

Parameters
Name	Description
`optionalArgs`	`array` Optional.
`↳ contentType`	`string` The HTTP Content-Type header value specifying the content type of the body.
`↳ data`	`string` The HTTP request/response body as raw binary.
`↳ extensions`	`Any[]` Application specific response metadata. Must be set in the first response for streaming APIs.
`↳ 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\Api\HttpBody`

Example

use Google\ApiCore\ApiException;
use Google\Api\HttpBody;
use Google\Cloud\GkeConnect\Gateway\V1beta1\GatewayServiceClient;

/**
 * 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 put_resource_sample(): void
{
    // Create a client.
    $gatewayServiceClient = new GatewayServiceClient();

    // Call the API and handle any network failures.
    try {
        /** @var HttpBody $response */
        $response = $gatewayServiceClient->putResource();
        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.gkeconnect.gateway.v1beta1.GatewayService'

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.