Compute V1 Client - Class GlobalForwardingRulesClient (1.22.0)

Reference documentation and code samples for the Compute V1 Client class GlobalForwardingRulesClient.

Service Description: The GlobalForwardingRules 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 \ Client

Methods

__construct

Constructor.

Parameters
Name	Description
`options`	`array` Optional. Options for configuring the service API wrapper.
`↳ apiEndpoint`	`string` The address of the API remote host. May optionally include the port, formatted as "
`↳ credentials`	`string\|array\|FetchAuthTokenInterface\|CredentialsWrapper` The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.
`↳ credentialsConfig`	`array` Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() .
`↳ disableRetries`	`bool` Determines whether or not retries defined by the client configuration should be disabled. Defaults to `false`.
`↳ clientConfig`	`string\|array` Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder.
`↳ transport`	`string\|TransportInterface` The transport used for executing network requests. At the moment, supports only `rest`. Advanced usage: Additionally, it is possible to pass in an already instantiated Google\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.
`↳ transportConfig`	`array` Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ '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

delete

Deletes the specified GlobalForwardingRule resource.

The async variant is GlobalForwardingRulesClient::deleteAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\DeleteGlobalForwardingRuleRequest` 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\GlobalForwardingRulesClient;
use Google\Cloud\Compute\V1\DeleteGlobalForwardingRuleRequest;
use Google\Rpc\Status;

/**
 * @param string $forwardingRule Name of the ForwardingRule resource to delete.
 * @param string $project        Project ID for this request.
 */
function delete_sample(string $forwardingRule, string $project): void
{
    // Create a client.
    $globalForwardingRulesClient = new GlobalForwardingRulesClient();

    // Prepare the request message.
    $request = (new DeleteGlobalForwardingRuleRequest())
        ->setForwardingRule($forwardingRule)
        ->setProject($project);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $globalForwardingRulesClient->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]';

    delete_sample($forwardingRule, $project);
}

get

Returns the specified GlobalForwardingRule resource. Gets a list of available forwarding rules by making a list() request.

The async variant is GlobalForwardingRulesClient::getAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\GetGlobalForwardingRuleRequest` 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`

Example

use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\Client\GlobalForwardingRulesClient;
use Google\Cloud\Compute\V1\ForwardingRule;
use Google\Cloud\Compute\V1\GetGlobalForwardingRuleRequest;

/**
 * @param string $forwardingRule Name of the ForwardingRule resource to return.
 * @param string $project        Project ID for this request.
 */
function get_sample(string $forwardingRule, string $project): void
{
    // Create a client.
    $globalForwardingRulesClient = new GlobalForwardingRulesClient();

    // Prepare the request message.
    $request = (new GetGlobalForwardingRuleRequest())
        ->setForwardingRule($forwardingRule)
        ->setProject($project);

    // Call the API and handle any network failures.
    try {
        /** @var ForwardingRule $response */
        $response = $globalForwardingRulesClient->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]';

    get_sample($forwardingRule, $project);
}

insert

Creates a GlobalForwardingRule resource in the specified project using the data included in the request.

The async variant is GlobalForwardingRulesClient::insertAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\InsertGlobalForwardingRuleRequest` 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\GlobalForwardingRulesClient;
use Google\Cloud\Compute\V1\ForwardingRule;
use Google\Cloud\Compute\V1\InsertGlobalForwardingRuleRequest;
use Google\Rpc\Status;

/**
 * @param string $project Project ID for this request.
 */
function insert_sample(string $project): void
{
    // Create a client.
    $globalForwardingRulesClient = new GlobalForwardingRulesClient();

    // Prepare the request message.
    $forwardingRuleResource = new ForwardingRule();
    $request = (new InsertGlobalForwardingRuleRequest())
        ->setForwardingRuleResource($forwardingRuleResource)
        ->setProject($project);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $globalForwardingRulesClient->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]';

    insert_sample($project);
}

list

Retrieves a list of GlobalForwardingRule resources available to the specified project.

The async variant is GlobalForwardingRulesClient::listAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\ListGlobalForwardingRulesRequest` 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\PagedListResponse;
use Google\Cloud\Compute\V1\Client\GlobalForwardingRulesClient;
use Google\Cloud\Compute\V1\ListGlobalForwardingRulesRequest;

/**
 * @param string $project Project ID for this request.
 */
function list_sample(string $project): void
{
    // Create a client.
    $globalForwardingRulesClient = new GlobalForwardingRulesClient();

    // Prepare the request message.
    $request = (new ListGlobalForwardingRulesRequest())
        ->setProject($project);

    // Call the API and handle any network failures.
    try {
        /** @var PagedListResponse $response */
        $response = $globalForwardingRulesClient->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]';

    list_sample($project);
}

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 GlobalForwardingRulesClient::patchAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\PatchGlobalForwardingRuleRequest` 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\GlobalForwardingRulesClient;
use Google\Cloud\Compute\V1\ForwardingRule;
use Google\Cloud\Compute\V1\PatchGlobalForwardingRuleRequest;
use Google\Rpc\Status;

/**
 * @param string $forwardingRule Name of the ForwardingRule resource to patch.
 * @param string $project        Project ID for this request.
 */
function patch_sample(string $forwardingRule, string $project): void
{
    // Create a client.
    $globalForwardingRulesClient = new GlobalForwardingRulesClient();

    // Prepare the request message.
    $forwardingRuleResource = new ForwardingRule();
    $request = (new PatchGlobalForwardingRuleRequest())
        ->setForwardingRule($forwardingRule)
        ->setForwardingRuleResource($forwardingRuleResource)
        ->setProject($project);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $globalForwardingRulesClient->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]';

    patch_sample($forwardingRule, $project);
}

setLabels

Sets the labels on the specified resource. To learn more about labels, read the Labeling resources documentation.

The async variant is GlobalForwardingRulesClient::setLabelsAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\SetLabelsGlobalForwardingRuleRequest` 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\GlobalForwardingRulesClient;
use Google\Cloud\Compute\V1\GlobalSetLabelsRequest;
use Google\Cloud\Compute\V1\SetLabelsGlobalForwardingRuleRequest;
use Google\Rpc\Status;

/**
 * @param string $project  Project ID for this request.
 * @param string $resource Name or id of the resource for this request.
 */
function set_labels_sample(string $project, string $resource): void
{
    // Create a client.
    $globalForwardingRulesClient = new GlobalForwardingRulesClient();

    // Prepare the request message.
    $globalSetLabelsRequestResource = new GlobalSetLabelsRequest();
    $request = (new SetLabelsGlobalForwardingRuleRequest())
        ->setGlobalSetLabelsRequestResource($globalSetLabelsRequestResource)
        ->setProject($project)
        ->setResource($resource);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $globalForwardingRulesClient->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]';
    $resource = '[RESOURCE]';

    set_labels_sample($project, $resource);
}

setTarget

Changes target URL for the GlobalForwardingRule resource. The new target should be of the same type as the old target.

The async variant is GlobalForwardingRulesClient::setTargetAsync() .

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\SetTargetGlobalForwardingRuleRequest` 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`

Example

use Google\ApiCore\ApiException;
use Google\ApiCore\OperationResponse;
use Google\Cloud\Compute\V1\Client\GlobalForwardingRulesClient;
use Google\Cloud\Compute\V1\SetTargetGlobalForwardingRuleRequest;
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.
 */
function set_target_sample(string $forwardingRule, string $project): void
{
    // Create a client.
    $globalForwardingRulesClient = new GlobalForwardingRulesClient();

    // Prepare the request message.
    $targetReferenceResource = new TargetReference();
    $request = (new SetTargetGlobalForwardingRuleRequest())
        ->setForwardingRule($forwardingRule)
        ->setProject($project)
        ->setTargetReferenceResource($targetReferenceResource);

    // Call the API and handle any network failures.
    try {
        /** @var OperationResponse $response */
        $response = $globalForwardingRulesClient->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]';

    set_target_sample($forwardingRule, $project);
}

deleteAsync

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\DeleteGlobalForwardingRuleRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>`

getAsync

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\GetGlobalForwardingRuleRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Compute\V1\ForwardingRule>`

insertAsync

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\InsertGlobalForwardingRuleRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>`

listAsync

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\ListGlobalForwardingRulesRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>`

patchAsync

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\PatchGlobalForwardingRuleRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>`

setLabelsAsync

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\SetLabelsGlobalForwardingRuleRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>`

setTargetAsync

Parameters
Name	Description
`request`	`Google\Cloud\Compute\V1\SetTargetGlobalForwardingRuleRequest`
`optionalArgs`	`array`

Returns
Type	Description
`GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>`

getOperationsClient

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

Returns
Type	Description
`Google\Cloud\Compute\V1\GlobalOperationsClient`

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`