Reference documentation and code samples for the Google Cloud Network Services V1 Client class DepServiceClient.
Service Description: Service describing handlers for resources.
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 \ NetworkServices \ 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. |
createLbRouteExtension
Creates a new LbRouteExtension resource in a given project and location.
The async variant is DepServiceClient::createLbRouteExtensionAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\NetworkServices\V1\CreateLbRouteExtensionRequest
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\NetworkServices\V1\Client\DepServiceClient;
use Google\Cloud\NetworkServices\V1\CreateLbRouteExtensionRequest;
use Google\Cloud\NetworkServices\V1\ExtensionChain;
use Google\Cloud\NetworkServices\V1\ExtensionChain\Extension;
use Google\Cloud\NetworkServices\V1\ExtensionChain\MatchCondition;
use Google\Cloud\NetworkServices\V1\LbRouteExtension;
use Google\Cloud\NetworkServices\V1\LoadBalancingScheme;
use Google\Rpc\Status;
/**
* @param string $formattedParent The parent resource of the `LbRouteExtension` resource. Must be
* in the format `projects/{project}/locations/{location}`. Please see
* {@see DepServiceClient::locationName()} for help formatting this field.
* @param string $lbRouteExtensionId User-provided ID of the `LbRouteExtension` resource to be
* created.
* @param string $lbRouteExtensionName Identifier. Name of the `LbRouteExtension` resource in the
* following format:
* `projects/{project}/locations/{location}/lbRouteExtensions/{lb_route_extension}`.
* @param string $lbRouteExtensionForwardingRulesElement A list of references to the forwarding rules to which this
* service extension is attached to. At least one forwarding rule is required.
* There can be only one `LbRouteExtension` resource per forwarding rule.
* @param string $lbRouteExtensionExtensionChainsName The name for this extension chain.
* The name is logged as part of the HTTP request logs.
* The name must conform with RFC-1034, is restricted to lower-cased letters,
* numbers and hyphens, and can have a maximum length of 63 characters.
* Additionally, the first character must be a letter and the last a letter or
* a number.
* @param string $lbRouteExtensionExtensionChainsMatchConditionCelExpression A Common Expression Language (CEL) expression that is used to
* match requests for which the extension chain is executed.
*
* For more information, see [CEL matcher language
* reference](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference).
* @param string $lbRouteExtensionExtensionChainsExtensionsName The name for this extension.
* The name is logged as part of the HTTP request logs.
* The name must conform with RFC-1034, is restricted to lower-cased
* letters, numbers and hyphens, and can have a maximum length of 63
* characters. Additionally, the first character must be a letter and the
* last a letter or a number.
* @param string $lbRouteExtensionExtensionChainsExtensionsService The reference to the service that runs the extension.
*
* Currently only callout extensions are supported here.
*
* To configure a callout extension, `service` must be a fully-qualified
* reference
* to a [backend
* service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices)
* in the format:
* `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}`
* or
* `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`.
* @param int $lbRouteExtensionLoadBalancingScheme All backend services and forwarding rules referenced by this
* extension must share the same load balancing scheme. Supported values:
* `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to
* [Choosing a load
* balancer](https://cloud.google.com/load-balancing/docs/backend-service).
*/
function create_lb_route_extension_sample(
string $formattedParent,
string $lbRouteExtensionId,
string $lbRouteExtensionName,
string $lbRouteExtensionForwardingRulesElement,
string $lbRouteExtensionExtensionChainsName,
string $lbRouteExtensionExtensionChainsMatchConditionCelExpression,
string $lbRouteExtensionExtensionChainsExtensionsName,
string $lbRouteExtensionExtensionChainsExtensionsService,
int $lbRouteExtensionLoadBalancingScheme
): void {
// Create a client.
$depServiceClient = new DepServiceClient();
// Prepare the request message.
$lbRouteExtensionForwardingRules = [$lbRouteExtensionForwardingRulesElement,];
$lbRouteExtensionExtensionChainsMatchCondition = (new MatchCondition())
->setCelExpression($lbRouteExtensionExtensionChainsMatchConditionCelExpression);
$extension = (new Extension())
->setName($lbRouteExtensionExtensionChainsExtensionsName)
->setService($lbRouteExtensionExtensionChainsExtensionsService);
$lbRouteExtensionExtensionChainsExtensions = [$extension,];
$extensionChain = (new ExtensionChain())
->setName($lbRouteExtensionExtensionChainsName)
->setMatchCondition($lbRouteExtensionExtensionChainsMatchCondition)
->setExtensions($lbRouteExtensionExtensionChainsExtensions);
$lbRouteExtensionExtensionChains = [$extensionChain,];
$lbRouteExtension = (new LbRouteExtension())
->setName($lbRouteExtensionName)
->setForwardingRules($lbRouteExtensionForwardingRules)
->setExtensionChains($lbRouteExtensionExtensionChains)
->setLoadBalancingScheme($lbRouteExtensionLoadBalancingScheme);
$request = (new CreateLbRouteExtensionRequest())
->setParent($formattedParent)
->setLbRouteExtensionId($lbRouteExtensionId)
->setLbRouteExtension($lbRouteExtension);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $depServiceClient->createLbRouteExtension($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var LbRouteExtension $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 = DepServiceClient::locationName('[PROJECT]', '[LOCATION]');
$lbRouteExtensionId = '[LB_ROUTE_EXTENSION_ID]';
$lbRouteExtensionName = '[NAME]';
$lbRouteExtensionForwardingRulesElement = '[FORWARDING_RULES]';
$lbRouteExtensionExtensionChainsName = '[NAME]';
$lbRouteExtensionExtensionChainsMatchConditionCelExpression = '[CEL_EXPRESSION]';
$lbRouteExtensionExtensionChainsExtensionsName = '[NAME]';
$lbRouteExtensionExtensionChainsExtensionsService = '[SERVICE]';
$lbRouteExtensionLoadBalancingScheme = LoadBalancingScheme::LOAD_BALANCING_SCHEME_UNSPECIFIED;
create_lb_route_extension_sample(
$formattedParent,
$lbRouteExtensionId,
$lbRouteExtensionName,
$lbRouteExtensionForwardingRulesElement,
$lbRouteExtensionExtensionChainsName,
$lbRouteExtensionExtensionChainsMatchConditionCelExpression,
$lbRouteExtensionExtensionChainsExtensionsName,
$lbRouteExtensionExtensionChainsExtensionsService,
$lbRouteExtensionLoadBalancingScheme
);
}
createLbTrafficExtension
Creates a new LbTrafficExtension resource in a given project and
location.
The async variant is DepServiceClient::createLbTrafficExtensionAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\NetworkServices\V1\CreateLbTrafficExtensionRequest
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\NetworkServices\V1\Client\DepServiceClient;
use Google\Cloud\NetworkServices\V1\CreateLbTrafficExtensionRequest;
use Google\Cloud\NetworkServices\V1\ExtensionChain;
use Google\Cloud\NetworkServices\V1\ExtensionChain\Extension;
use Google\Cloud\NetworkServices\V1\ExtensionChain\MatchCondition;
use Google\Cloud\NetworkServices\V1\LbTrafficExtension;
use Google\Cloud\NetworkServices\V1\LoadBalancingScheme;
use Google\Rpc\Status;
/**
* @param string $formattedParent The parent resource of the `LbTrafficExtension` resource. Must be
* in the format `projects/{project}/locations/{location}`. Please see
* {@see DepServiceClient::locationName()} for help formatting this field.
* @param string $lbTrafficExtensionId User-provided ID of the `LbTrafficExtension` resource to be
* created.
* @param string $lbTrafficExtensionName Identifier. Name of the `LbTrafficExtension` resource in the
* following format:
* `projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}`.
* @param string $lbTrafficExtensionForwardingRulesElement A list of references to the forwarding rules to which this
* service extension is attached to. At least one forwarding rule is required.
* There can be only one `LBTrafficExtension` resource per forwarding rule.
* @param string $lbTrafficExtensionExtensionChainsName The name for this extension chain.
* The name is logged as part of the HTTP request logs.
* The name must conform with RFC-1034, is restricted to lower-cased letters,
* numbers and hyphens, and can have a maximum length of 63 characters.
* Additionally, the first character must be a letter and the last a letter or
* a number.
* @param string $lbTrafficExtensionExtensionChainsMatchConditionCelExpression A Common Expression Language (CEL) expression that is used to
* match requests for which the extension chain is executed.
*
* For more information, see [CEL matcher language
* reference](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference).
* @param string $lbTrafficExtensionExtensionChainsExtensionsName The name for this extension.
* The name is logged as part of the HTTP request logs.
* The name must conform with RFC-1034, is restricted to lower-cased
* letters, numbers and hyphens, and can have a maximum length of 63
* characters. Additionally, the first character must be a letter and the
* last a letter or a number.
* @param string $lbTrafficExtensionExtensionChainsExtensionsService The reference to the service that runs the extension.
*
* Currently only callout extensions are supported here.
*
* To configure a callout extension, `service` must be a fully-qualified
* reference
* to a [backend
* service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices)
* in the format:
* `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}`
* or
* `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`.
* @param int $lbTrafficExtensionLoadBalancingScheme All backend services and forwarding rules referenced by this
* extension must share the same load balancing scheme. Supported values:
* `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to
* [Choosing a load
* balancer](https://cloud.google.com/load-balancing/docs/backend-service).
*/
function create_lb_traffic_extension_sample(
string $formattedParent,
string $lbTrafficExtensionId,
string $lbTrafficExtensionName,
string $lbTrafficExtensionForwardingRulesElement,
string $lbTrafficExtensionExtensionChainsName,
string $lbTrafficExtensionExtensionChainsMatchConditionCelExpression,
string $lbTrafficExtensionExtensionChainsExtensionsName,
string $lbTrafficExtensionExtensionChainsExtensionsService,
int $lbTrafficExtensionLoadBalancingScheme
): void {
// Create a client.
$depServiceClient = new DepServiceClient();
// Prepare the request message.
$lbTrafficExtensionForwardingRules = [$lbTrafficExtensionForwardingRulesElement,];
$lbTrafficExtensionExtensionChainsMatchCondition = (new MatchCondition())
->setCelExpression($lbTrafficExtensionExtensionChainsMatchConditionCelExpression);
$extension = (new Extension())
->setName($lbTrafficExtensionExtensionChainsExtensionsName)
->setService($lbTrafficExtensionExtensionChainsExtensionsService);
$lbTrafficExtensionExtensionChainsExtensions = [$extension,];
$extensionChain = (new ExtensionChain())
->setName($lbTrafficExtensionExtensionChainsName)
->setMatchCondition($lbTrafficExtensionExtensionChainsMatchCondition)
->setExtensions($lbTrafficExtensionExtensionChainsExtensions);
$lbTrafficExtensionExtensionChains = [$extensionChain,];
$lbTrafficExtension = (new LbTrafficExtension())
->setName($lbTrafficExtensionName)
->setForwardingRules($lbTrafficExtensionForwardingRules)
->setExtensionChains($lbTrafficExtensionExtensionChains)
->setLoadBalancingScheme($lbTrafficExtensionLoadBalancingScheme);
$request = (new CreateLbTrafficExtensionRequest())
->setParent($formattedParent)
->setLbTrafficExtensionId($lbTrafficExtensionId)
->setLbTrafficExtension($lbTrafficExtension);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $depServiceClient->createLbTrafficExtension($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var LbTrafficExtension $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 = DepServiceClient::locationName('[PROJECT]', '[LOCATION]');
$lbTrafficExtensionId = '[LB_TRAFFIC_EXTENSION_ID]';
$lbTrafficExtensionName = '[NAME]';
$lbTrafficExtensionForwardingRulesElement = '[FORWARDING_RULES]';
$lbTrafficExtensionExtensionChainsName = '[NAME]';
$lbTrafficExtensionExtensionChainsMatchConditionCelExpression = '[CEL_EXPRESSION]';
$lbTrafficExtensionExtensionChainsExtensionsName = '[NAME]';
$lbTrafficExtensionExtensionChainsExtensionsService = '[SERVICE]';
$lbTrafficExtensionLoadBalancingScheme = LoadBalancingScheme::LOAD_BALANCING_SCHEME_UNSPECIFIED;
create_lb_traffic_extension_sample(
$formattedParent,
$lbTrafficExtensionId,
$lbTrafficExtensionName,
$lbTrafficExtensionForwardingRulesElement,
$lbTrafficExtensionExtensionChainsName,
$lbTrafficExtensionExtensionChainsMatchConditionCelExpression,
$lbTrafficExtensionExtensionChainsExtensionsName,
$lbTrafficExtensionExtensionChainsExtensionsService,
$lbTrafficExtensionLoadBalancingScheme
);
}
deleteLbRouteExtension
Deletes the specified LbRouteExtension resource.
The async variant is DepServiceClient::deleteLbRouteExtensionAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\NetworkServices\V1\DeleteLbRouteExtensionRequest
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\NetworkServices\V1\Client\DepServiceClient;
use Google\Cloud\NetworkServices\V1\DeleteLbRouteExtensionRequest;
use Google\Rpc\Status;
/**
* @param string $formattedName The name of the `LbRouteExtension` resource to delete. Must be in
* the format
* `projects/{project}/locations/{location}/lbRouteExtensions/{lb_route_extension}`. Please see
* {@see DepServiceClient::lbRouteExtensionName()} for help formatting this field.
*/
function delete_lb_route_extension_sample(string $formattedName): void
{
// Create a client.
$depServiceClient = new DepServiceClient();
// Prepare the request message.
$request = (new DeleteLbRouteExtensionRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $depServiceClient->deleteLbRouteExtension($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 = DepServiceClient::lbRouteExtensionName(
'[PROJECT]',
'[LOCATION]',
'[LB_ROUTE_EXTENSION]'
);
delete_lb_route_extension_sample($formattedName);
}
deleteLbTrafficExtension
Deletes the specified LbTrafficExtension resource.
The async variant is DepServiceClient::deleteLbTrafficExtensionAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\NetworkServices\V1\DeleteLbTrafficExtensionRequest
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\NetworkServices\V1\Client\DepServiceClient;
use Google\Cloud\NetworkServices\V1\DeleteLbTrafficExtensionRequest;
use Google\Rpc\Status;
/**
* @param string $formattedName The name of the `LbTrafficExtension` resource to delete. Must be
* in the format
* `projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}`. Please see
* {@see DepServiceClient::lbTrafficExtensionName()} for help formatting this field.
*/
function delete_lb_traffic_extension_sample(string $formattedName): void
{
// Create a client.
$depServiceClient = new DepServiceClient();
// Prepare the request message.
$request = (new DeleteLbTrafficExtensionRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $depServiceClient->deleteLbTrafficExtension($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 = DepServiceClient::lbTrafficExtensionName(
'[PROJECT]',
'[LOCATION]',
'[LB_TRAFFIC_EXTENSION]'
);
delete_lb_traffic_extension_sample($formattedName);
}
getLbRouteExtension
Gets details of the specified LbRouteExtension resource.
The async variant is DepServiceClient::getLbRouteExtensionAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\NetworkServices\V1\GetLbRouteExtensionRequest
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\NetworkServices\V1\LbRouteExtension |
|
use Google\ApiCore\ApiException;
use Google\Cloud\NetworkServices\V1\Client\DepServiceClient;
use Google\Cloud\NetworkServices\V1\GetLbRouteExtensionRequest;
use Google\Cloud\NetworkServices\V1\LbRouteExtension;
/**
* @param string $formattedName A name of the `LbRouteExtension` resource to get. Must be in the
* format
* `projects/{project}/locations/{location}/lbRouteExtensions/{lb_route_extension}`. Please see
* {@see DepServiceClient::lbRouteExtensionName()} for help formatting this field.
*/
function get_lb_route_extension_sample(string $formattedName): void
{
// Create a client.
$depServiceClient = new DepServiceClient();
// Prepare the request message.
$request = (new GetLbRouteExtensionRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var LbRouteExtension $response */
$response = $depServiceClient->getLbRouteExtension($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 = DepServiceClient::lbRouteExtensionName(
'[PROJECT]',
'[LOCATION]',
'[LB_ROUTE_EXTENSION]'
);
get_lb_route_extension_sample($formattedName);
}
getLbTrafficExtension
Gets details of the specified LbTrafficExtension resource.
The async variant is DepServiceClient::getLbTrafficExtensionAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\NetworkServices\V1\GetLbTrafficExtensionRequest
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\NetworkServices\V1\LbTrafficExtension |
|
use Google\ApiCore\ApiException;
use Google\Cloud\NetworkServices\V1\Client\DepServiceClient;
use Google\Cloud\NetworkServices\V1\GetLbTrafficExtensionRequest;
use Google\Cloud\NetworkServices\V1\LbTrafficExtension;
/**
* @param string $formattedName A name of the `LbTrafficExtension` resource to get. Must be in
* the format
* `projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}`. Please see
* {@see DepServiceClient::lbTrafficExtensionName()} for help formatting this field.
*/
function get_lb_traffic_extension_sample(string $formattedName): void
{
// Create a client.
$depServiceClient = new DepServiceClient();
// Prepare the request message.
$request = (new GetLbTrafficExtensionRequest())
->setName($formattedName);
// Call the API and handle any network failures.
try {
/** @var LbTrafficExtension $response */
$response = $depServiceClient->getLbTrafficExtension($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 = DepServiceClient::lbTrafficExtensionName(
'[PROJECT]',
'[LOCATION]',
'[LB_TRAFFIC_EXTENSION]'
);
get_lb_traffic_extension_sample($formattedName);
}
listLbRouteExtensions
Lists LbRouteExtension resources in a given project and location.
The async variant is DepServiceClient::listLbRouteExtensionsAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\NetworkServices\V1\ListLbRouteExtensionsRequest
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\NetworkServices\V1\Client\DepServiceClient;
use Google\Cloud\NetworkServices\V1\LbRouteExtension;
use Google\Cloud\NetworkServices\V1\ListLbRouteExtensionsRequest;
/**
* @param string $formattedParent The project and location from which the `LbRouteExtension`
* resources are listed, specified in the following format:
* `projects/{project}/locations/{location}`. Please see
* {@see DepServiceClient::locationName()} for help formatting this field.
*/
function list_lb_route_extensions_sample(string $formattedParent): void
{
// Create a client.
$depServiceClient = new DepServiceClient();
// Prepare the request message.
$request = (new ListLbRouteExtensionsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $depServiceClient->listLbRouteExtensions($request);
/** @var LbRouteExtension $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 = DepServiceClient::locationName('[PROJECT]', '[LOCATION]');
list_lb_route_extensions_sample($formattedParent);
}
listLbTrafficExtensions
Lists LbTrafficExtension resources in a given project and location.
The async variant is DepServiceClient::listLbTrafficExtensionsAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\NetworkServices\V1\ListLbTrafficExtensionsRequest
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\NetworkServices\V1\Client\DepServiceClient;
use Google\Cloud\NetworkServices\V1\LbTrafficExtension;
use Google\Cloud\NetworkServices\V1\ListLbTrafficExtensionsRequest;
/**
* @param string $formattedParent The project and location from which the `LbTrafficExtension`
* resources are listed, specified in the following format:
* `projects/{project}/locations/{location}`. Please see
* {@see DepServiceClient::locationName()} for help formatting this field.
*/
function list_lb_traffic_extensions_sample(string $formattedParent): void
{
// Create a client.
$depServiceClient = new DepServiceClient();
// Prepare the request message.
$request = (new ListLbTrafficExtensionsRequest())
->setParent($formattedParent);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $depServiceClient->listLbTrafficExtensions($request);
/** @var LbTrafficExtension $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 = DepServiceClient::locationName('[PROJECT]', '[LOCATION]');
list_lb_traffic_extensions_sample($formattedParent);
}
updateLbRouteExtension
Updates the parameters of the specified LbRouteExtension resource.
The async variant is DepServiceClient::updateLbRouteExtensionAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\NetworkServices\V1\UpdateLbRouteExtensionRequest
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\NetworkServices\V1\Client\DepServiceClient;
use Google\Cloud\NetworkServices\V1\ExtensionChain;
use Google\Cloud\NetworkServices\V1\ExtensionChain\Extension;
use Google\Cloud\NetworkServices\V1\ExtensionChain\MatchCondition;
use Google\Cloud\NetworkServices\V1\LbRouteExtension;
use Google\Cloud\NetworkServices\V1\LoadBalancingScheme;
use Google\Cloud\NetworkServices\V1\UpdateLbRouteExtensionRequest;
use Google\Rpc\Status;
/**
* @param string $lbRouteExtensionName Identifier. Name of the `LbRouteExtension` resource in the
* following format:
* `projects/{project}/locations/{location}/lbRouteExtensions/{lb_route_extension}`.
* @param string $lbRouteExtensionForwardingRulesElement A list of references to the forwarding rules to which this
* service extension is attached to. At least one forwarding rule is required.
* There can be only one `LbRouteExtension` resource per forwarding rule.
* @param string $lbRouteExtensionExtensionChainsName The name for this extension chain.
* The name is logged as part of the HTTP request logs.
* The name must conform with RFC-1034, is restricted to lower-cased letters,
* numbers and hyphens, and can have a maximum length of 63 characters.
* Additionally, the first character must be a letter and the last a letter or
* a number.
* @param string $lbRouteExtensionExtensionChainsMatchConditionCelExpression A Common Expression Language (CEL) expression that is used to
* match requests for which the extension chain is executed.
*
* For more information, see [CEL matcher language
* reference](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference).
* @param string $lbRouteExtensionExtensionChainsExtensionsName The name for this extension.
* The name is logged as part of the HTTP request logs.
* The name must conform with RFC-1034, is restricted to lower-cased
* letters, numbers and hyphens, and can have a maximum length of 63
* characters. Additionally, the first character must be a letter and the
* last a letter or a number.
* @param string $lbRouteExtensionExtensionChainsExtensionsService The reference to the service that runs the extension.
*
* Currently only callout extensions are supported here.
*
* To configure a callout extension, `service` must be a fully-qualified
* reference
* to a [backend
* service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices)
* in the format:
* `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}`
* or
* `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`.
* @param int $lbRouteExtensionLoadBalancingScheme All backend services and forwarding rules referenced by this
* extension must share the same load balancing scheme. Supported values:
* `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to
* [Choosing a load
* balancer](https://cloud.google.com/load-balancing/docs/backend-service).
*/
function update_lb_route_extension_sample(
string $lbRouteExtensionName,
string $lbRouteExtensionForwardingRulesElement,
string $lbRouteExtensionExtensionChainsName,
string $lbRouteExtensionExtensionChainsMatchConditionCelExpression,
string $lbRouteExtensionExtensionChainsExtensionsName,
string $lbRouteExtensionExtensionChainsExtensionsService,
int $lbRouteExtensionLoadBalancingScheme
): void {
// Create a client.
$depServiceClient = new DepServiceClient();
// Prepare the request message.
$lbRouteExtensionForwardingRules = [$lbRouteExtensionForwardingRulesElement,];
$lbRouteExtensionExtensionChainsMatchCondition = (new MatchCondition())
->setCelExpression($lbRouteExtensionExtensionChainsMatchConditionCelExpression);
$extension = (new Extension())
->setName($lbRouteExtensionExtensionChainsExtensionsName)
->setService($lbRouteExtensionExtensionChainsExtensionsService);
$lbRouteExtensionExtensionChainsExtensions = [$extension,];
$extensionChain = (new ExtensionChain())
->setName($lbRouteExtensionExtensionChainsName)
->setMatchCondition($lbRouteExtensionExtensionChainsMatchCondition)
->setExtensions($lbRouteExtensionExtensionChainsExtensions);
$lbRouteExtensionExtensionChains = [$extensionChain,];
$lbRouteExtension = (new LbRouteExtension())
->setName($lbRouteExtensionName)
->setForwardingRules($lbRouteExtensionForwardingRules)
->setExtensionChains($lbRouteExtensionExtensionChains)
->setLoadBalancingScheme($lbRouteExtensionLoadBalancingScheme);
$request = (new UpdateLbRouteExtensionRequest())
->setLbRouteExtension($lbRouteExtension);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $depServiceClient->updateLbRouteExtension($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var LbRouteExtension $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
{
$lbRouteExtensionName = '[NAME]';
$lbRouteExtensionForwardingRulesElement = '[FORWARDING_RULES]';
$lbRouteExtensionExtensionChainsName = '[NAME]';
$lbRouteExtensionExtensionChainsMatchConditionCelExpression = '[CEL_EXPRESSION]';
$lbRouteExtensionExtensionChainsExtensionsName = '[NAME]';
$lbRouteExtensionExtensionChainsExtensionsService = '[SERVICE]';
$lbRouteExtensionLoadBalancingScheme = LoadBalancingScheme::LOAD_BALANCING_SCHEME_UNSPECIFIED;
update_lb_route_extension_sample(
$lbRouteExtensionName,
$lbRouteExtensionForwardingRulesElement,
$lbRouteExtensionExtensionChainsName,
$lbRouteExtensionExtensionChainsMatchConditionCelExpression,
$lbRouteExtensionExtensionChainsExtensionsName,
$lbRouteExtensionExtensionChainsExtensionsService,
$lbRouteExtensionLoadBalancingScheme
);
}
updateLbTrafficExtension
Updates the parameters of the specified LbTrafficExtension resource.
The async variant is DepServiceClient::updateLbTrafficExtensionAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\NetworkServices\V1\UpdateLbTrafficExtensionRequest
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\NetworkServices\V1\Client\DepServiceClient;
use Google\Cloud\NetworkServices\V1\ExtensionChain;
use Google\Cloud\NetworkServices\V1\ExtensionChain\Extension;
use Google\Cloud\NetworkServices\V1\ExtensionChain\MatchCondition;
use Google\Cloud\NetworkServices\V1\LbTrafficExtension;
use Google\Cloud\NetworkServices\V1\LoadBalancingScheme;
use Google\Cloud\NetworkServices\V1\UpdateLbTrafficExtensionRequest;
use Google\Rpc\Status;
/**
* @param string $lbTrafficExtensionName Identifier. Name of the `LbTrafficExtension` resource in the
* following format:
* `projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}`.
* @param string $lbTrafficExtensionForwardingRulesElement A list of references to the forwarding rules to which this
* service extension is attached to. At least one forwarding rule is required.
* There can be only one `LBTrafficExtension` resource per forwarding rule.
* @param string $lbTrafficExtensionExtensionChainsName The name for this extension chain.
* The name is logged as part of the HTTP request logs.
* The name must conform with RFC-1034, is restricted to lower-cased letters,
* numbers and hyphens, and can have a maximum length of 63 characters.
* Additionally, the first character must be a letter and the last a letter or
* a number.
* @param string $lbTrafficExtensionExtensionChainsMatchConditionCelExpression A Common Expression Language (CEL) expression that is used to
* match requests for which the extension chain is executed.
*
* For more information, see [CEL matcher language
* reference](https://cloud.google.com/service-extensions/docs/cel-matcher-language-reference).
* @param string $lbTrafficExtensionExtensionChainsExtensionsName The name for this extension.
* The name is logged as part of the HTTP request logs.
* The name must conform with RFC-1034, is restricted to lower-cased
* letters, numbers and hyphens, and can have a maximum length of 63
* characters. Additionally, the first character must be a letter and the
* last a letter or a number.
* @param string $lbTrafficExtensionExtensionChainsExtensionsService The reference to the service that runs the extension.
*
* Currently only callout extensions are supported here.
*
* To configure a callout extension, `service` must be a fully-qualified
* reference
* to a [backend
* service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices)
* in the format:
* `https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/backendServices/{backendService}`
* or
* `https://www.googleapis.com/compute/v1/projects/{project}/global/backendServices/{backendService}`.
* @param int $lbTrafficExtensionLoadBalancingScheme All backend services and forwarding rules referenced by this
* extension must share the same load balancing scheme. Supported values:
* `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to
* [Choosing a load
* balancer](https://cloud.google.com/load-balancing/docs/backend-service).
*/
function update_lb_traffic_extension_sample(
string $lbTrafficExtensionName,
string $lbTrafficExtensionForwardingRulesElement,
string $lbTrafficExtensionExtensionChainsName,
string $lbTrafficExtensionExtensionChainsMatchConditionCelExpression,
string $lbTrafficExtensionExtensionChainsExtensionsName,
string $lbTrafficExtensionExtensionChainsExtensionsService,
int $lbTrafficExtensionLoadBalancingScheme
): void {
// Create a client.
$depServiceClient = new DepServiceClient();
// Prepare the request message.
$lbTrafficExtensionForwardingRules = [$lbTrafficExtensionForwardingRulesElement,];
$lbTrafficExtensionExtensionChainsMatchCondition = (new MatchCondition())
->setCelExpression($lbTrafficExtensionExtensionChainsMatchConditionCelExpression);
$extension = (new Extension())
->setName($lbTrafficExtensionExtensionChainsExtensionsName)
->setService($lbTrafficExtensionExtensionChainsExtensionsService);
$lbTrafficExtensionExtensionChainsExtensions = [$extension,];
$extensionChain = (new ExtensionChain())
->setName($lbTrafficExtensionExtensionChainsName)
->setMatchCondition($lbTrafficExtensionExtensionChainsMatchCondition)
->setExtensions($lbTrafficExtensionExtensionChainsExtensions);
$lbTrafficExtensionExtensionChains = [$extensionChain,];
$lbTrafficExtension = (new LbTrafficExtension())
->setName($lbTrafficExtensionName)
->setForwardingRules($lbTrafficExtensionForwardingRules)
->setExtensionChains($lbTrafficExtensionExtensionChains)
->setLoadBalancingScheme($lbTrafficExtensionLoadBalancingScheme);
$request = (new UpdateLbTrafficExtensionRequest())
->setLbTrafficExtension($lbTrafficExtension);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $depServiceClient->updateLbTrafficExtension($request);
$response->pollUntilComplete();
if ($response->operationSucceeded()) {
/** @var LbTrafficExtension $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
{
$lbTrafficExtensionName = '[NAME]';
$lbTrafficExtensionForwardingRulesElement = '[FORWARDING_RULES]';
$lbTrafficExtensionExtensionChainsName = '[NAME]';
$lbTrafficExtensionExtensionChainsMatchConditionCelExpression = '[CEL_EXPRESSION]';
$lbTrafficExtensionExtensionChainsExtensionsName = '[NAME]';
$lbTrafficExtensionExtensionChainsExtensionsService = '[SERVICE]';
$lbTrafficExtensionLoadBalancingScheme = LoadBalancingScheme::LOAD_BALANCING_SCHEME_UNSPECIFIED;
update_lb_traffic_extension_sample(
$lbTrafficExtensionName,
$lbTrafficExtensionForwardingRulesElement,
$lbTrafficExtensionExtensionChainsName,
$lbTrafficExtensionExtensionChainsMatchConditionCelExpression,
$lbTrafficExtensionExtensionChainsExtensionsName,
$lbTrafficExtensionExtensionChainsExtensionsService,
$lbTrafficExtensionLoadBalancingScheme
);
}
getLocation
Gets information about a location.
The async variant is DepServiceClient::getLocationAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Location\GetLocationRequest
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\Location\Location |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Location\GetLocationRequest;
use Google\Cloud\Location\Location;
use Google\Cloud\NetworkServices\V1\Client\DepServiceClient;
/**
* 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_location_sample(): void
{
// Create a client.
$depServiceClient = new DepServiceClient();
// Prepare the request message.
$request = new GetLocationRequest();
// Call the API and handle any network failures.
try {
/** @var Location $response */
$response = $depServiceClient->getLocation($request);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
listLocations
Lists information about the supported locations for this service.
The async variant is DepServiceClient::listLocationsAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Location\ListLocationsRequest
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\Location\ListLocationsRequest;
use Google\Cloud\Location\Location;
use Google\Cloud\NetworkServices\V1\Client\DepServiceClient;
/**
* 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 list_locations_sample(): void
{
// Create a client.
$depServiceClient = new DepServiceClient();
// Prepare the request message.
$request = new ListLocationsRequest();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $depServiceClient->listLocations($request);
/** @var Location $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());
}
}
getIamPolicy
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
The async variant is DepServiceClient::getIamPolicyAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Iam\V1\GetIamPolicyRequest
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\Iam\V1\Policy |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\GetIamPolicyRequest;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\NetworkServices\V1\Client\DepServiceClient;
/**
* @param string $resource REQUIRED: The resource for which the policy is being requested.
* See the operation documentation for the appropriate value for this field.
*/
function get_iam_policy_sample(string $resource): void
{
// Create a client.
$depServiceClient = new DepServiceClient();
// Prepare the request message.
$request = (new GetIamPolicyRequest())
->setResource($resource);
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $depServiceClient->getIamPolicy($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
{
$resource = '[RESOURCE]';
get_iam_policy_sample($resource);
}
setIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy.
Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED
errors.
The async variant is DepServiceClient::setIamPolicyAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Iam\V1\SetIamPolicyRequest
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\Iam\V1\Policy |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\Policy;
use Google\Cloud\Iam\V1\SetIamPolicyRequest;
use Google\Cloud\NetworkServices\V1\Client\DepServiceClient;
/**
* @param string $resource REQUIRED: The resource for which the policy is being specified.
* See the operation documentation for the appropriate value for this field.
*/
function set_iam_policy_sample(string $resource): void
{
// Create a client.
$depServiceClient = new DepServiceClient();
// Prepare the request message.
$policy = new Policy();
$request = (new SetIamPolicyRequest())
->setResource($resource)
->setPolicy($policy);
// Call the API and handle any network failures.
try {
/** @var Policy $response */
$response = $depServiceClient->setIamPolicy($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
{
$resource = '[RESOURCE]';
set_iam_policy_sample($resource);
}
testIamPermissions
Returns permissions that a caller has on the specified resource. If the
resource does not exist, this will return an empty set of
permissions, not a NOT_FOUND error.
Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
The async variant is DepServiceClient::testIamPermissionsAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Iam\V1\TestIamPermissionsRequest
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\Iam\V1\TestIamPermissionsResponse |
|
use Google\ApiCore\ApiException;
use Google\Cloud\Iam\V1\TestIamPermissionsRequest;
use Google\Cloud\Iam\V1\TestIamPermissionsResponse;
use Google\Cloud\NetworkServices\V1\Client\DepServiceClient;
/**
* @param string $resource REQUIRED: The resource for which the policy detail is being requested.
* See the operation documentation for the appropriate value for this field.
* @param string $permissionsElement The set of permissions to check for the `resource`. Permissions with
* wildcards (such as '*' or 'storage.*') are not allowed. For more
* information see
* [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
*/
function test_iam_permissions_sample(string $resource, string $permissionsElement): void
{
// Create a client.
$depServiceClient = new DepServiceClient();
// Prepare the request message.
$permissions = [$permissionsElement,];
$request = (new TestIamPermissionsRequest())
->setResource($resource)
->setPermissions($permissions);
// Call the API and handle any network failures.
try {
/** @var TestIamPermissionsResponse $response */
$response = $depServiceClient->testIamPermissions($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
{
$resource = '[RESOURCE]';
$permissionsElement = '[PERMISSIONS]';
test_iam_permissions_sample($resource, $permissionsElement);
}
createLbRouteExtensionAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\NetworkServices\V1\CreateLbRouteExtensionRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
|
createLbTrafficExtensionAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\NetworkServices\V1\CreateLbTrafficExtensionRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
|
deleteLbRouteExtensionAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\NetworkServices\V1\DeleteLbRouteExtensionRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
|
deleteLbTrafficExtensionAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\NetworkServices\V1\DeleteLbTrafficExtensionRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
|
getLbRouteExtensionAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\NetworkServices\V1\GetLbRouteExtensionRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\NetworkServices\V1\LbRouteExtension> |
|
getLbTrafficExtensionAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\NetworkServices\V1\GetLbTrafficExtensionRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\NetworkServices\V1\LbTrafficExtension> |
|
listLbRouteExtensionsAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\NetworkServices\V1\ListLbRouteExtensionsRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
|
listLbTrafficExtensionsAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\NetworkServices\V1\ListLbTrafficExtensionsRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
|
updateLbRouteExtensionAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\NetworkServices\V1\UpdateLbRouteExtensionRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
|
updateLbTrafficExtensionAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\NetworkServices\V1\UpdateLbTrafficExtensionRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
|
getLocationAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Location\GetLocationRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Location\Location> |
|
listLocationsAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Location\ListLocationsRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
|
getIamPolicyAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Iam\V1\GetIamPolicyRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Iam\V1\Policy> |
|
setIamPolicyAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Iam\V1\SetIamPolicyRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Iam\V1\Policy> |
|
testIamPermissionsAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Iam\V1\TestIamPermissionsRequest
|
optionalArgs |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Iam\V1\TestIamPermissionsResponse> |
|
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
| Returns | |
|---|---|
| Type | Description |
Google\LongRunning\Client\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::lbRouteExtensionName
Formats a string containing the fully-qualified path to represent a lb_route_extension resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
lbRouteExtension |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted lb_route_extension resource. |
static::lbTrafficExtensionName
Formats a string containing the fully-qualified path to represent a lb_traffic_extension resource.
| Parameters | |
|---|---|
| Name | Description |
project |
string
|
location |
string
|
lbTrafficExtension |
string
|
| Returns | |
|---|---|
| Type | Description |
string |
The formatted lb_traffic_extension 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::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
- lbRouteExtension: projects/{project}/locations/{location}/lbRouteExtensions/{lb_route_extension}
- lbTrafficExtension: projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}
- location: projects/{project}/locations/{location}
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. |