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 provides the ability to make remote calls to the backing service through method calls that map to API methods.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.
Namespace
Google \ Cloud \ ApiGateway \ V1 \ ClientMethods
__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 |
↳ 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 |
↳ 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\ApiGatewayServiceClient::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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\ApiGateway\V1\Api;
use Google\Cloud\ApiGateway\V1\Client\ApiGatewayServiceClient;
use Google\Cloud\ApiGateway\V1\CreateApiRequest;
use Google\Rpc\Status;
/**
* @param string $formattedParent Parent resource of the API, of the form:
* `projects/*/locations/global`
* Please see {@see ApiGatewayServiceClient::locationName()} for help formatting this field.
* @param string $apiId Identifier to assign to the API. Must be unique within scope of
* the parent resource.
*/
function create_api_sample(string $formattedParent, string $apiId): void
{
// Create a client.
$apiGatewayServiceClient = new ApiGatewayServiceClient();
// Prepare the request message.
$api = new Api();
$request = (new CreateApiRequest())
->setParent($formattedParent)
->setApiId($apiId)
->setApi($api);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $apiGatewayServiceClient->createApi($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Api $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->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
{
$formattedParent = ApiGatewayServiceClient::locationName('[PROJECT]', '[LOCATION]');
$apiId = '[API_ID]';
create_api_sample($formattedParent, $apiId);
}
createApiConfig
Creates a new ApiConfig in a given project and location.
The async variant is Google\Cloud\ApiGateway\V1\Client\ApiGatewayServiceClient::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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\ApiGateway\V1\ApiConfig;
use Google\Cloud\ApiGateway\V1\Client\ApiGatewayServiceClient;
use Google\Cloud\ApiGateway\V1\CreateApiConfigRequest;
use Google\Rpc\Status;
/**
* @param string $formattedParent Parent resource of the API Config, of the form:
* `projects/*/locations/global/apis/*`
* Please see {@see ApiGatewayServiceClient::apiName()} for help formatting this field.
* @param string $apiConfigId Identifier to assign to the API Config. Must be unique within scope of
* the parent resource.
*/
function create_api_config_sample(string $formattedParent, string $apiConfigId): void
{
// Create a client.
$apiGatewayServiceClient = new ApiGatewayServiceClient();
// Prepare the request message.
$apiConfig = new ApiConfig();
$request = (new CreateApiConfigRequest())
->setParent($formattedParent)
->setApiConfigId($apiConfigId)
->setApiConfig($apiConfig);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $apiGatewayServiceClient->createApiConfig($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var ApiConfig $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->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
{
$formattedParent = ApiGatewayServiceClient::apiName('[PROJECT]', '[API]');
$apiConfigId = '[API_CONFIG_ID]';
create_api_config_sample($formattedParent, $apiConfigId);
}
createGateway
Creates a new Gateway in a given project and location.
The async variant is Google\Cloud\ApiGateway\V1\Client\ApiGatewayServiceClient::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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\ApiGateway\V1\Client\ApiGatewayServiceClient;
use Google\Cloud\ApiGateway\V1\CreateGatewayRequest;
use Google\Cloud\ApiGateway\V1\Gateway;
use Google\Rpc\Status;
/**
* @param string $formattedParent Parent resource of the Gateway, of the form:
* `projects/*/locations/*`
* Please see {@see ApiGatewayServiceClient::locationName()} for help formatting this field.
* @param string $gatewayId Identifier to assign to the Gateway. Must be unique within scope of
* the parent resource.
* @param string $formattedGatewayApiConfig Resource name of the API Config for this Gateway.
* Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}
* Please see {@see ApiGatewayServiceClient::apiConfigName()} for help formatting this field.
*/
function create_gateway_sample(
string $formattedParent,
string $gatewayId,
string $formattedGatewayApiConfig
): void {
// Create a client.
$apiGatewayServiceClient = new ApiGatewayServiceClient();
// Prepare the request message.
$gateway = (new Gateway())
->setApiConfig($formattedGatewayApiConfig);
$request = (new CreateGatewayRequest())
->setParent($formattedParent)
->setGatewayId($gatewayId)
->setGateway($gateway);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $apiGatewayServiceClient->createGateway($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Gateway $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->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
{
$formattedParent = ApiGatewayServiceClient::locationName('[PROJECT]', '[LOCATION]');
$gatewayId = '[GATEWAY_ID]';
$formattedGatewayApiConfig = ApiGatewayServiceClient::apiConfigName(
'[PROJECT]',
'[API]',
'[API_CONFIG]'
);
create_gateway_sample($formattedParent, $gatewayId, $formattedGatewayApiConfig);
}
deleteApi
Deletes a single Api.
The async variant is Google\Cloud\ApiGateway\V1\Client\ApiGatewayServiceClient::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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\ApiGateway\V1\Client\ApiGatewayServiceClient;
use Google\Cloud\ApiGateway\V1\DeleteApiRequest;
use Google\Rpc\Status;
/**
* @param string $formattedName Resource name of the form:
* `projects/*/locations/global/apis/*`
* Please see {@see ApiGatewayServiceClient::apiName()} for help formatting this field.
*/
function delete_api_sample(string $formattedName): void
{
// Create a client.
$apiGatewayServiceClient = new ApiGatewayServiceClient();
// Prepare the request message.
$request = (new DeleteApiRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $apiGatewayServiceClient->deleteApi($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
printf('Operation completed successfully.' . PHP_EOL);
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->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
{
$formattedName = ApiGatewayServiceClient::apiName('[PROJECT]', '[API]');
delete_api_sample($formattedName);
}
deleteApiConfig
Deletes a single ApiConfig.
The async variant is Google\Cloud\ApiGateway\V1\Client\ApiGatewayServiceClient::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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\ApiGateway\V1\Client\ApiGatewayServiceClient;
use Google\Cloud\ApiGateway\V1\DeleteApiConfigRequest;
use Google\Rpc\Status;
/**
* @param string $formattedName Resource name of the form:
* `projects/*/locations/global/apis/*/configs/*`
* Please see {@see ApiGatewayServiceClient::apiConfigName()} for help formatting this field.
*/
function delete_api_config_sample(string $formattedName): void
{
// Create a client.
$apiGatewayServiceClient = new ApiGatewayServiceClient();
// Prepare the request message.
$request = (new DeleteApiConfigRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $apiGatewayServiceClient->deleteApiConfig($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
printf('Operation completed successfully.' . PHP_EOL);
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->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
{
$formattedName = ApiGatewayServiceClient::apiConfigName('[PROJECT]', '[API]', '[API_CONFIG]');
delete_api_config_sample($formattedName);
}
deleteGateway
Deletes a single Gateway.
The async variant is Google\Cloud\ApiGateway\V1\Client\ApiGatewayServiceClient::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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\ApiGateway\V1\Client\ApiGatewayServiceClient;
use Google\Cloud\ApiGateway\V1\DeleteGatewayRequest;
use Google\Rpc\Status;
/**
* @param string $formattedName Resource name of the form:
* `projects/*/locations/*/gateways/*`
* Please see {@see ApiGatewayServiceClient::gatewayName()} for help formatting this field.
*/
function delete_gateway_sample(string $formattedName): void
{
// Create a client.
$apiGatewayServiceClient = new ApiGatewayServiceClient();
// Prepare the request message.
$request = (new DeleteGatewayRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $apiGatewayServiceClient->deleteGateway($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
printf('Operation completed successfully.' . PHP_EOL);
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->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
{
$formattedName = ApiGatewayServiceClient::gatewayName('[PROJECT]', '[LOCATION]', '[GATEWAY]');
delete_gateway_sample($formattedName);
}
getApi
Gets details of a single Api.
The async variant is Google\Cloud\ApiGateway\V1\Client\ApiGatewayServiceClient::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 |
use Google\ApiCore\ApiException;
use Google\Cloud\ApiGateway\V1\Api;
use Google\Cloud\ApiGateway\V1\Client\ApiGatewayServiceClient;
use Google\Cloud\ApiGateway\V1\GetApiRequest;
/**
* @param string $formattedName Resource name of the form:
* `projects/*/locations/global/apis/*`
* Please see {@see ApiGatewayServiceClient::apiName()} for help formatting this field.
*/
function get_api_sample(string $formattedName): void
{
// Create a client.
$apiGatewayServiceClient = new ApiGatewayServiceClient();
// Prepare the request message.
$request = (new GetApiRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var Api $response */
$response = $apiGatewayServiceClient->getApi($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
{
$formattedName = ApiGatewayServiceClient::apiName('[PROJECT]', '[API]');
get_api_sample($formattedName);
}
getApiConfig
Gets details of a single ApiConfig.
The async variant is Google\Cloud\ApiGateway\V1\Client\ApiGatewayServiceClient::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 |
use Google\ApiCore\ApiException;
use Google\Cloud\ApiGateway\V1\ApiConfig;
use Google\Cloud\ApiGateway\V1\Client\ApiGatewayServiceClient;
use Google\Cloud\ApiGateway\V1\GetApiConfigRequest;
/**
* @param string $formattedName Resource name of the form:
* `projects/*/locations/global/apis/*/configs/*`
* Please see {@see ApiGatewayServiceClient::apiConfigName()} for help formatting this field.
*/
function get_api_config_sample(string $formattedName): void
{
// Create a client.
$apiGatewayServiceClient = new ApiGatewayServiceClient();
// Prepare the request message.
$request = (new GetApiConfigRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var ApiConfig $response */
$response = $apiGatewayServiceClient->getApiConfig($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
{
$formattedName = ApiGatewayServiceClient::apiConfigName('[PROJECT]', '[API]', '[API_CONFIG]');
get_api_config_sample($formattedName);
}
getGateway
Gets details of a single Gateway.
The async variant is Google\Cloud\ApiGateway\V1\Client\ApiGatewayServiceClient::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 |
use Google\ApiCore\ApiException;
use Google\Cloud\ApiGateway\V1\Client\ApiGatewayServiceClient;
use Google\Cloud\ApiGateway\V1\Gateway;
use Google\Cloud\ApiGateway\V1\GetGatewayRequest;
/**
* @param string $formattedName Resource name of the form:
* `projects/*/locations/*/gateways/*`
* Please see {@see ApiGatewayServiceClient::gatewayName()} for help formatting this field.
*/
function get_gateway_sample(string $formattedName): void
{
// Create a client.
$apiGatewayServiceClient = new ApiGatewayServiceClient();
// Prepare the request message.
$request = (new GetGatewayRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var Gateway $response */
$response = $apiGatewayServiceClient->getGateway($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
{
$formattedName = ApiGatewayServiceClient::gatewayName('[PROJECT]', '[LOCATION]', '[GATEWAY]');
get_gateway_sample($formattedName);
}
listApiConfigs
Lists ApiConfigs in a given project and location.
The async variant is Google\Cloud\ApiGateway\V1\Client\ApiGatewayServiceClient::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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\ApiGateway\V1\ApiConfig;
use Google\Cloud\ApiGateway\V1\Client\ApiGatewayServiceClient;
use Google\Cloud\ApiGateway\V1\ListApiConfigsRequest;
/**
* @param string $formattedParent Parent resource of the API Config, of the form:
* `projects/*/locations/global/apis/*`
* Please see {@see ApiGatewayServiceClient::apiName()} for help formatting this field.
*/
function list_api_configs_sample(string $formattedParent): void
{
// Create a client.
$apiGatewayServiceClient = new ApiGatewayServiceClient();
// Prepare the request message.
$request = (new ListApiConfigsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $apiGatewayServiceClient->listApiConfigs($request);
/** @var ApiConfig $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->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
{
$formattedParent = ApiGatewayServiceClient::apiName('[PROJECT]', '[API]');
list_api_configs_sample($formattedParent);
}
listApis
Lists Apis in a given project and location.
The async variant is Google\Cloud\ApiGateway\V1\Client\ApiGatewayServiceClient::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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\ApiGateway\V1\Api;
use Google\Cloud\ApiGateway\V1\Client\ApiGatewayServiceClient;
use Google\Cloud\ApiGateway\V1\ListApisRequest;
/**
* @param string $formattedParent Parent resource of the API, of the form:
* `projects/*/locations/global`
* Please see {@see ApiGatewayServiceClient::locationName()} for help formatting this field.
*/
function list_apis_sample(string $formattedParent): void
{
// Create a client.
$apiGatewayServiceClient = new ApiGatewayServiceClient();
// Prepare the request message.
$request = (new ListApisRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $apiGatewayServiceClient->listApis($request);
/** @var Api $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->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
{
$formattedParent = ApiGatewayServiceClient::locationName('[PROJECT]', '[LOCATION]');
list_apis_sample($formattedParent);
}
listGateways
Lists Gateways in a given project and location.
The async variant is Google\Cloud\ApiGateway\V1\Client\ApiGatewayServiceClient::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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\ApiGateway\V1\Client\ApiGatewayServiceClient;
use Google\Cloud\ApiGateway\V1\Gateway;
use Google\Cloud\ApiGateway\V1\ListGatewaysRequest;
/**
* @param string $formattedParent Parent resource of the Gateway, of the form:
* `projects/*/locations/*`
* Please see {@see ApiGatewayServiceClient::locationName()} for help formatting this field.
*/
function list_gateways_sample(string $formattedParent): void
{
// Create a client.
$apiGatewayServiceClient = new ApiGatewayServiceClient();
// Prepare the request message.
$request = (new ListGatewaysRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $apiGatewayServiceClient->listGateways($request);
/** @var Gateway $element */
foreach ($response as $element) {
printf('Element data: %s' . PHP_EOL, $element->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
{
$formattedParent = ApiGatewayServiceClient::locationName('[PROJECT]', '[LOCATION]');
list_gateways_sample($formattedParent);
}
updateApi
Updates the parameters of a single Api.
The async variant is Google\Cloud\ApiGateway\V1\Client\ApiGatewayServiceClient::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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\ApiGateway\V1\Api;
use Google\Cloud\ApiGateway\V1\Client\ApiGatewayServiceClient;
use Google\Cloud\ApiGateway\V1\UpdateApiRequest;
use Google\Rpc\Status;
/**
* 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 update_api_sample(): void
{
// Create a client.
$apiGatewayServiceClient = new ApiGatewayServiceClient();
// Prepare the request message.
$api = new Api();
$request = (new UpdateApiRequest())
->setApi($api);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $apiGatewayServiceClient->updateApi($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Api $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
updateApiConfig
Updates the parameters of a single ApiConfig.
The async variant is Google\Cloud\ApiGateway\V1\Client\ApiGatewayServiceClient::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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\ApiGateway\V1\ApiConfig;
use Google\Cloud\ApiGateway\V1\Client\ApiGatewayServiceClient;
use Google\Cloud\ApiGateway\V1\UpdateApiConfigRequest;
use Google\Rpc\Status;
/**
* 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 update_api_config_sample(): void
{
// Create a client.
$apiGatewayServiceClient = new ApiGatewayServiceClient();
// Prepare the request message.
$apiConfig = new ApiConfig();
$request = (new UpdateApiConfigRequest())
->setApiConfig($apiConfig);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $apiGatewayServiceClient->updateApiConfig($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var ApiConfig $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->serializeToJsonString());
}
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
updateGateway
Updates the parameters of a single Gateway.
The async variant is Google\Cloud\ApiGateway\V1\Client\ApiGatewayServiceClient::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 |
use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\ApiGateway\V1\Client\ApiGatewayServiceClient;
use Google\Cloud\ApiGateway\V1\Gateway;
use Google\Cloud\ApiGateway\V1\UpdateGatewayRequest;
use Google\Rpc\Status;
/**
* @param string $formattedGatewayApiConfig Resource name of the API Config for this Gateway.
* Format: projects/{project}/locations/global/apis/{api}/configs/{apiConfig}
* Please see {@see ApiGatewayServiceClient::apiConfigName()} for help formatting this field.
*/
function update_gateway_sample(string $formattedGatewayApiConfig): void
{
// Create a client.
$apiGatewayServiceClient = new ApiGatewayServiceClient();
// Prepare the request message.
$gateway = (new Gateway())
->setApiConfig($formattedGatewayApiConfig);
$request = (new UpdateGatewayRequest())
->setGateway($gateway);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $apiGatewayServiceClient->updateGateway($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var Gateway $result */
$result = $response->getResult();
printf('Operation successful with response data: %s' . PHP_EOL, $result->serializeToJsonString());
} else {
/** @var Status $error */
$error = $response->getError();
printf('Operation failed with error data: %s' . PHP_EOL, $error->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
{
$formattedGatewayApiConfig = ApiGatewayServiceClient::apiConfigName(
'[PROJECT]',
'[API]',
'[API_CONFIG]'
);
update_gateway_sample($formattedGatewayApiConfig);
}
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. |