Google Cloud Api Gateway V1 Client - Class ApiGatewayServiceClient (1.1.1)

Reference documentation and code samples for the Google Cloud Api Gateway V1 Client class ApiGatewayServiceClient.

Service Description: The API Gateway Service is the interface for managing API Gateways.

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

Namespace

Google \ Cloud \ ApiGateway \ 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.

createApi

Creates a new Api in a given project and location.

The async variant is Google\Cloud\ApiGateway\V1\Client\BaseClient\self::createApiAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\ApiGateway\V1\CreateApiRequest` 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\ApiCore\OperationResponse`

createApiConfig

Creates a new ApiConfig in a given project and location.

The async variant is Google\Cloud\ApiGateway\V1\Client\BaseClient\self::createApiConfigAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\ApiGateway\V1\CreateApiConfigRequest` 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\ApiCore\OperationResponse`

createGateway

Creates a new Gateway in a given project and location.

The async variant is Google\Cloud\ApiGateway\V1\Client\BaseClient\self::createGatewayAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\ApiGateway\V1\CreateGatewayRequest` 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\ApiCore\OperationResponse`

deleteApi

Deletes a single Api.

The async variant is Google\Cloud\ApiGateway\V1\Client\BaseClient\self::deleteApiAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\ApiGateway\V1\DeleteApiRequest` 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\ApiCore\OperationResponse`

deleteApiConfig

Deletes a single ApiConfig.

The async variant is Google\Cloud\ApiGateway\V1\Client\BaseClient\self::deleteApiConfigAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\ApiGateway\V1\DeleteApiConfigRequest` 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\ApiCore\OperationResponse`

deleteGateway

Deletes a single Gateway.

The async variant is Google\Cloud\ApiGateway\V1\Client\BaseClient\self::deleteGatewayAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\ApiGateway\V1\DeleteGatewayRequest` 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\ApiCore\OperationResponse`

getApi

Gets details of a single Api.

The async variant is Google\Cloud\ApiGateway\V1\Client\BaseClient\self::getApiAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\ApiGateway\V1\GetApiRequest` 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\ApiGateway\V1\Api`

getApiConfig

Gets details of a single ApiConfig.

The async variant is Google\Cloud\ApiGateway\V1\Client\BaseClient\self::getApiConfigAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\ApiGateway\V1\GetApiConfigRequest` 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\ApiGateway\V1\ApiConfig`

getGateway

Gets details of a single Gateway.

The async variant is Google\Cloud\ApiGateway\V1\Client\BaseClient\self::getGatewayAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\ApiGateway\V1\GetGatewayRequest` 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\ApiGateway\V1\Gateway`

listApiConfigs

Lists ApiConfigs in a given project and location.

The async variant is Google\Cloud\ApiGateway\V1\Client\BaseClient\self::listApiConfigsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\ApiGateway\V1\ListApiConfigsRequest` 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\ApiCore\PagedListResponse`

listApis

Lists Apis in a given project and location.

The async variant is Google\Cloud\ApiGateway\V1\Client\BaseClient\self::listApisAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\ApiGateway\V1\ListApisRequest` 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\ApiCore\PagedListResponse`

listGateways

Lists Gateways in a given project and location.

The async variant is Google\Cloud\ApiGateway\V1\Client\BaseClient\self::listGatewaysAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\ApiGateway\V1\ListGatewaysRequest` 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\ApiCore\PagedListResponse`

updateApi

Updates the parameters of a single Api.

The async variant is Google\Cloud\ApiGateway\V1\Client\BaseClient\self::updateApiAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\ApiGateway\V1\UpdateApiRequest` 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\ApiCore\OperationResponse`

updateApiConfig

Updates the parameters of a single ApiConfig.

The async variant is Google\Cloud\ApiGateway\V1\Client\BaseClient\self::updateApiConfigAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\ApiGateway\V1\UpdateApiConfigRequest` 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\ApiCore\OperationResponse`

updateGateway

Updates the parameters of a single Gateway.

The async variant is Google\Cloud\ApiGateway\V1\Client\BaseClient\self::updateGatewayAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\ApiGateway\V1\UpdateGatewayRequest` 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\ApiCore\OperationResponse`

createApiAsync

Parameters
Name	Description
`request`	`Google\Cloud\ApiGateway\V1\CreateApiRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

createApiConfigAsync

Parameters
Name	Description
`request`	`Google\Cloud\ApiGateway\V1\CreateApiConfigRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

createGatewayAsync

Parameters
Name	Description
`request`	`Google\Cloud\ApiGateway\V1\CreateGatewayRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteApiAsync

Parameters
Name	Description
`request`	`Google\Cloud\ApiGateway\V1\DeleteApiRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteApiConfigAsync

Parameters
Name	Description
`request`	`Google\Cloud\ApiGateway\V1\DeleteApiConfigRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

deleteGatewayAsync

Parameters
Name	Description
`request`	`Google\Cloud\ApiGateway\V1\DeleteGatewayRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getApiAsync

Parameters
Name	Description
`request`	`Google\Cloud\ApiGateway\V1\GetApiRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getApiConfigAsync

Parameters
Name	Description
`request`	`Google\Cloud\ApiGateway\V1\GetApiConfigRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getGatewayAsync

Parameters
Name	Description
`request`	`Google\Cloud\ApiGateway\V1\GetGatewayRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listApiConfigsAsync

Parameters
Name	Description
`request`	`Google\Cloud\ApiGateway\V1\ListApiConfigsRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listApisAsync

Parameters
Name	Description
`request`	`Google\Cloud\ApiGateway\V1\ListApisRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

listGatewaysAsync

Parameters
Name	Description
`request`	`Google\Cloud\ApiGateway\V1\ListGatewaysRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateApiAsync

Parameters
Name	Description
`request`	`Google\Cloud\ApiGateway\V1\UpdateApiRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateApiConfigAsync

Parameters
Name	Description
`request`	`Google\Cloud\ApiGateway\V1\UpdateApiConfigRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

updateGatewayAsync

Parameters
Name	Description
`request`	`Google\Cloud\ApiGateway\V1\UpdateGatewayRequest`
`optionalArgs = []`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface`

getOperationsClient

Return an OperationsClient object with the same endpoint as $this.

Returns
Type	Description
`Google\ApiCore\LongRunning\OperationsClient`

resumeOperation

Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.

Parameters
Name	Description
`operationName`	`string` The name of the long running operation
`methodName`	`string` The name of the method used to start the operation

Returns
Type	Description
`Google\ApiCore\OperationResponse`

static::apiName

Formats a string containing the fully-qualified path to represent a api resource.

Parameters
Name	Description
`project`	`string`
`api`	`string`

Returns
Type	Description
`string`	The formatted api resource.

static::apiConfigName

Formats a string containing the fully-qualified path to represent a api_config resource.

Parameters
Name	Description
`project`	`string`
`api`	`string`
`apiConfig`	`string`

Returns
Type	Description
`string`	The formatted api_config resource.

static::gatewayName

Formats a string containing the fully-qualified path to represent a gateway resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`
`gateway`	`string`

Returns
Type	Description
`string`	The formatted gateway resource.

static::locationName

Formats a string containing the fully-qualified path to represent a location resource.

Parameters
Name	Description
`project`	`string`
`location`	`string`

Returns
Type	Description
`string`	The formatted location resource.

static::managedServiceName

Formats a string containing the fully-qualified path to represent a managed_service resource.

Parameter
Name	Description
`service`	`string`

Returns
Type	Description
`string`	The formatted managed_service resource.

static::serviceName

Formats a string containing the fully-qualified path to represent a service resource.

Parameters
Name	Description
`service`	`string`
`config`	`string`

Returns
Type	Description
`string`	The formatted service resource.

static::serviceAccountName

Formats a string containing the fully-qualified path to represent a service_account resource.

Parameters
Name	Description
`project`	`string`
`serviceAccount`	`string`

Returns
Type	Description
`string`	The formatted service_account resource.

static::parseName

Parses a formatted name string and returns an associative array of the components in the name.

The following name formats are supported: Template: Pattern

api: projects/{project}/locations/global/apis/{api}
apiConfig: projects/{project}/locations/global/apis/{api}/configs/{api_config}
gateway: projects/{project}/locations/{location}/gateways/{gateway}
location: projects/{project}/locations/{location}
managedService: services/{service}
service: services/{service}/configs/{config}
serviceAccount: projects/{project}/serviceAccounts/{service_account}

The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.

Parameters
Name	Description
`formattedName`	`string` The formatted name string
`template`	`string` Optional name of template to match

Returns
Type	Description
`array`	An associative array from name component IDs to component values.