Reference documentation and code samples for the Compute V1 Client class ForwardingRulesClient.
Service Description: The ForwardingRules API.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods.
Namespace
Google \ Cloud \ Compute \ 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. At the moment, supports only |
↳ 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 = [ 'rest' => [...], ]; See the Google\ApiCore\Transport\RestTransport::build() method 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. |
↳ logger |
false|LoggerInterface
A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag |
aggregatedList
Retrieves an aggregated list of forwarding rules. To prevent failure, Google recommends that you set the returnPartialSuccess
parameter to true
.
The async variant is ForwardingRulesClient::aggregatedListAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\AggregatedListForwardingRulesRequest
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\Compute\V1\AggregatedListForwardingRulesRequest;
use Google\Cloud\Compute\V1\Client\ForwardingRulesClient;
/**
* @param string $project Project ID for this request.
*/
function aggregated_list_sample(string $project): void
{
// Create a client.
$forwardingRulesClient = new ForwardingRulesClient();
// Prepare the request message.
$request = (new AggregatedListForwardingRulesRequest())
->setProject($project);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $forwardingRulesClient->aggregatedList($request);
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
{
$project = '[PROJECT]';
aggregated_list_sample($project);
}
delete
Deletes the specified ForwardingRule resource.
The async variant is ForwardingRulesClient::deleteAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\DeleteForwardingRuleRequest
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\Compute\V1\Client\ForwardingRulesClient;
use Google\Cloud\Compute\V1\DeleteForwardingRuleRequest;
use Google\Rpc\Status;
/**
* @param string $forwardingRule Name of the ForwardingRule resource to delete.
* @param string $project Project ID for this request.
* @param string $region Name of the region scoping this request.
*/
function delete_sample(string $forwardingRule, string $project, string $region): void
{
// Create a client.
$forwardingRulesClient = new ForwardingRulesClient();
// Prepare the request message.
$request = (new DeleteForwardingRuleRequest())
->setForwardingRule($forwardingRule)
->setProject($project)
->setRegion($region);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $forwardingRulesClient->delete($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
{
$forwardingRule = '[FORWARDING_RULE]';
$project = '[PROJECT]';
$region = '[REGION]';
delete_sample($forwardingRule, $project, $region);
}
get
Returns the specified ForwardingRule resource.
The async variant is ForwardingRulesClient::getAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\GetForwardingRuleRequest
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\Compute\V1\ForwardingRule |
use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\Client\ForwardingRulesClient;
use Google\Cloud\Compute\V1\ForwardingRule;
use Google\Cloud\Compute\V1\GetForwardingRuleRequest;
/**
* @param string $forwardingRule Name of the ForwardingRule resource to return.
* @param string $project Project ID for this request.
* @param string $region Name of the region scoping this request.
*/
function get_sample(string $forwardingRule, string $project, string $region): void
{
// Create a client.
$forwardingRulesClient = new ForwardingRulesClient();
// Prepare the request message.
$request = (new GetForwardingRuleRequest())
->setForwardingRule($forwardingRule)
->setProject($project)
->setRegion($region);
// Call the API and handle any network failures.
try {
/** @var ForwardingRule $response */
$response = $forwardingRulesClient->get($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
{
$forwardingRule = '[FORWARDING_RULE]';
$project = '[PROJECT]';
$region = '[REGION]';
get_sample($forwardingRule, $project, $region);
}
insert
Creates a ForwardingRule resource in the specified project and region using the data included in the request.
The async variant is ForwardingRulesClient::insertAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\InsertForwardingRuleRequest
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\Compute\V1\Client\ForwardingRulesClient;
use Google\Cloud\Compute\V1\ForwardingRule;
use Google\Cloud\Compute\V1\InsertForwardingRuleRequest;
use Google\Rpc\Status;
/**
* @param string $project Project ID for this request.
* @param string $region Name of the region scoping this request.
*/
function insert_sample(string $project, string $region): void
{
// Create a client.
$forwardingRulesClient = new ForwardingRulesClient();
// Prepare the request message.
$forwardingRuleResource = new ForwardingRule();
$request = (new InsertForwardingRuleRequest())
->setForwardingRuleResource($forwardingRuleResource)
->setProject($project)
->setRegion($region);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $forwardingRulesClient->insert($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
{
$project = '[PROJECT]';
$region = '[REGION]';
insert_sample($project, $region);
}
list
Retrieves a list of ForwardingRule resources available to the specified project and region.
The async variant is ForwardingRulesClient::listAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\ListForwardingRulesRequest
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\Compute\V1\Client\ForwardingRulesClient;
use Google\Cloud\Compute\V1\ListForwardingRulesRequest;
/**
* @param string $project Project ID for this request.
* @param string $region Name of the region scoping this request.
*/
function list_sample(string $project, string $region): void
{
// Create a client.
$forwardingRulesClient = new ForwardingRulesClient();
// Prepare the request message.
$request = (new ListForwardingRulesRequest())
->setProject($project)
->setRegion($region);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $forwardingRulesClient->list($request);
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
{
$project = '[PROJECT]';
$region = '[REGION]';
list_sample($project, $region);
}
patch
Updates the specified forwarding rule with the data included in the request. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. Currently, you can only patch the network_tier field.
The async variant is ForwardingRulesClient::patchAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\PatchForwardingRuleRequest
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\Compute\V1\Client\ForwardingRulesClient;
use Google\Cloud\Compute\V1\ForwardingRule;
use Google\Cloud\Compute\V1\PatchForwardingRuleRequest;
use Google\Rpc\Status;
/**
* @param string $forwardingRule Name of the ForwardingRule resource to patch.
* @param string $project Project ID for this request.
* @param string $region Name of the region scoping this request.
*/
function patch_sample(string $forwardingRule, string $project, string $region): void
{
// Create a client.
$forwardingRulesClient = new ForwardingRulesClient();
// Prepare the request message.
$forwardingRuleResource = new ForwardingRule();
$request = (new PatchForwardingRuleRequest())
->setForwardingRule($forwardingRule)
->setForwardingRuleResource($forwardingRuleResource)
->setProject($project)
->setRegion($region);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $forwardingRulesClient->patch($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
{
$forwardingRule = '[FORWARDING_RULE]';
$project = '[PROJECT]';
$region = '[REGION]';
patch_sample($forwardingRule, $project, $region);
}
setLabels
Sets the labels on the specified resource. To learn more about labels, read the Labeling Resources documentation.
The async variant is ForwardingRulesClient::setLabelsAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\SetLabelsForwardingRuleRequest
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\Compute\V1\Client\ForwardingRulesClient;
use Google\Cloud\Compute\V1\RegionSetLabelsRequest;
use Google\Cloud\Compute\V1\SetLabelsForwardingRuleRequest;
use Google\Rpc\Status;
/**
* @param string $project Project ID for this request.
* @param string $region The region for this request.
* @param string $resource Name or id of the resource for this request.
*/
function set_labels_sample(string $project, string $region, string $resource): void
{
// Create a client.
$forwardingRulesClient = new ForwardingRulesClient();
// Prepare the request message.
$regionSetLabelsRequestResource = new RegionSetLabelsRequest();
$request = (new SetLabelsForwardingRuleRequest())
->setProject($project)
->setRegion($region)
->setRegionSetLabelsRequestResource($regionSetLabelsRequestResource)
->setResource($resource);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $forwardingRulesClient->setLabels($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
{
$project = '[PROJECT]';
$region = '[REGION]';
$resource = '[RESOURCE]';
set_labels_sample($project, $region, $resource);
}
setTarget
Changes target URL for forwarding rule. The new target should be of the same type as the old target.
The async variant is ForwardingRulesClient::setTargetAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\SetTargetForwardingRuleRequest
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\Compute\V1\Client\ForwardingRulesClient;
use Google\Cloud\Compute\V1\SetTargetForwardingRuleRequest;
use Google\Cloud\Compute\V1\TargetReference;
use Google\Rpc\Status;
/**
* @param string $forwardingRule Name of the ForwardingRule resource in which target is to be set.
* @param string $project Project ID for this request.
* @param string $region Name of the region scoping this request.
*/
function set_target_sample(string $forwardingRule, string $project, string $region): void
{
// Create a client.
$forwardingRulesClient = new ForwardingRulesClient();
// Prepare the request message.
$targetReferenceResource = new TargetReference();
$request = (new SetTargetForwardingRuleRequest())
->setForwardingRule($forwardingRule)
->setProject($project)
->setRegion($region)
->setTargetReferenceResource($targetReferenceResource);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $forwardingRulesClient->setTarget($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
{
$forwardingRule = '[FORWARDING_RULE]';
$project = '[PROJECT]';
$region = '[REGION]';
set_target_sample($forwardingRule, $project, $region);
}
aggregatedListAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\AggregatedListForwardingRulesRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
deleteAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\DeleteForwardingRuleRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
getAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\GetForwardingRuleRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Compute\V1\ForwardingRule> |
insertAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\InsertForwardingRuleRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
listAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\ListForwardingRulesRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
patchAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\PatchForwardingRuleRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
setLabelsAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\SetLabelsForwardingRuleRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
setTargetAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\SetTargetForwardingRuleRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
getOperationsClient
Return an RegionOperationsClient object with the same endpoint as $this.
Returns | |
---|---|
Type | Description |
Google\Cloud\Compute\V1\RegionOperationsClient |
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 |