Compute V1 Client - Class TargetHttpProxiesClient (2.5.0)

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

Service Description: The TargetHttpProxies API.

This class provides the ability to make remote calls to the backing service through methodcalls that map to API methods.

Namespace

Google \ Cloud \ Compute \ V1 \ Client

Methods

__construct

Constructor.

Parameters
NameDescription
optionsarray|Google\ApiCore\Options\ClientOptions

Optional. Options for configuring the service API wrapper.

↳ apiEndpointstring

The address of the API remote host. May optionally include the port, formatted as "

↳ credentialsFetchAuthTokenInterface|CredentialsWrapper

This option should only be used with a pre-constructedGoogle\Auth\FetchAuthTokenInterface orGoogle\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored.Important: If you are providing a path to a credentials file, or a decoded credentials file as a PHP array, this usage is now DEPRECATED. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. It is recommended to create the credentials explicitlyuse Google\Auth\Credentials\ServiceAccountCredentials; use Google\Cloud\Compute\V1\TargetHttpProxiesClient; $creds = new ServiceAccountCredentials($scopes, $json); $options = new TargetHttpProxiesClient(['credentials' => $creds]);https://cloud.google.com/docs/authentication/external/externally-sourced-credentials

↳ credentialsConfigarray

Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, seeGoogle\ApiCore\CredentialsWrapper::build() .

↳ disableRetriesbool

Determines whether or not retries defined by the client configuration should be disabled. Defaults tofalse.

↳ clientConfigstring|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.

↳ transportstring|TransportInterface

The transport used for executing network requests. At the moment, supports onlyrest.Advanced usage: Additionally, it is possible to pass in an already instantiatedGoogle\ApiCore\Transport\TransportInterface object. Note that when this object is provided, any settings in $transportConfig, and any $apiEndpoint setting, will be ignored.

↳ transportConfigarray

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 theGoogle\ApiCore\Transport\RestTransport::build() method for the supported options.

↳ clientCertSourcecallable

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.

↳ loggerfalse|LoggerInterface

A PSR-3 compliant logger. If set to false, logging is disabled, ignoring the 'GOOGLE_SDK_PHP_LOGGING' environment flag

↳ universeDomainstring

The service domain for the client. Defaults to 'googleapis.com'.

aggregatedList

Parameters
NameDescription
requestGoogle\Cloud\Compute\V1\AggregatedListTargetHttpProxiesRequest

A request to house fields associated with the call.

callOptionsarray

Optional.

↳ retrySettingsRetrySettings|array

Retry settings to use for this call. Can be aGoogle\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation onGoogle\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\ApiCore\PagedListResponse
Example
use Google\ApiCore\ApiException;use Google\ApiCore\PagedListResponse;use Google\Cloud\Compute\V1\AggregatedListTargetHttpProxiesRequest;use Google\Cloud\Compute\V1\Client\TargetHttpProxiesClient;/** * @param string $project Name of the project scoping this request. */function aggregated_list_sample(string $project): void{    // Create a client.    $targetHttpProxiesClient = new TargetHttpProxiesClient();    // Prepare the request message.    $request = (new AggregatedListTargetHttpProxiesRequest())        ->setProject($project);    // Call the API and handle any network failures.    try {        /** @var PagedListResponse $response */        $response = $targetHttpProxiesClient->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 TargetHttpProxy resource.

The async variant isTargetHttpProxiesClient::deleteAsync() .

Parameters
NameDescription
requestGoogle\Cloud\Compute\V1\DeleteTargetHttpProxyRequest

A request to house fields associated with the call.

callOptionsarray

Optional.

↳ retrySettingsRetrySettings|array

Retry settings to use for this call. Can be aGoogle\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation onGoogle\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\ApiCore\OperationResponse
Example
use Google\ApiCore\ApiException;use Google\ApiCore\OperationResponse;use Google\Cloud\Compute\V1\Client\TargetHttpProxiesClient;use Google\Cloud\Compute\V1\DeleteTargetHttpProxyRequest;use Google\Rpc\Status;/** * @param string $project         Project ID for this request. * @param string $targetHttpProxy Name of the TargetHttpProxy resource to delete. */function delete_sample(string $project, string $targetHttpProxy): void{    // Create a client.    $targetHttpProxiesClient = new TargetHttpProxiesClient();    // Prepare the request message.    $request = (new DeleteTargetHttpProxyRequest())        ->setProject($project)        ->setTargetHttpProxy($targetHttpProxy);    // Call the API and handle any network failures.    try {        /** @var OperationResponse $response */        $response = $targetHttpProxiesClient->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{    $project = '[PROJECT]';    $targetHttpProxy = '[TARGET_HTTP_PROXY]';    delete_sample($project, $targetHttpProxy);}

get

Returns the specified TargetHttpProxy resource.

The async variant isTargetHttpProxiesClient::getAsync() .

Parameters
NameDescription
requestGoogle\Cloud\Compute\V1\GetTargetHttpProxyRequest

A request to house fields associated with the call.

callOptionsarray

Optional.

↳ retrySettingsRetrySettings|array

Retry settings to use for this call. Can be aGoogle\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation onGoogle\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\Cloud\Compute\V1\TargetHttpProxy
Example
use Google\ApiCore\ApiException;use Google\Cloud\Compute\V1\Client\TargetHttpProxiesClient;use Google\Cloud\Compute\V1\GetTargetHttpProxyRequest;use Google\Cloud\Compute\V1\TargetHttpProxy;/** * @param string $project         Project ID for this request. * @param string $targetHttpProxy Name of the TargetHttpProxy resource to return. */function get_sample(string $project, string $targetHttpProxy): void{    // Create a client.    $targetHttpProxiesClient = new TargetHttpProxiesClient();    // Prepare the request message.    $request = (new GetTargetHttpProxyRequest())        ->setProject($project)        ->setTargetHttpProxy($targetHttpProxy);    // Call the API and handle any network failures.    try {        /** @var TargetHttpProxy $response */        $response = $targetHttpProxiesClient->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{    $project = '[PROJECT]';    $targetHttpProxy = '[TARGET_HTTP_PROXY]';    get_sample($project, $targetHttpProxy);}

insert

Creates a TargetHttpProxy resource in the specifiedproject using the data included in the request.

The async variant isTargetHttpProxiesClient::insertAsync() .

Parameters
NameDescription
requestGoogle\Cloud\Compute\V1\InsertTargetHttpProxyRequest

A request to house fields associated with the call.

callOptionsarray

Optional.

↳ retrySettingsRetrySettings|array

Retry settings to use for this call. Can be aGoogle\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation onGoogle\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\ApiCore\OperationResponse
Example
use Google\ApiCore\ApiException;use Google\ApiCore\OperationResponse;use Google\Cloud\Compute\V1\Client\TargetHttpProxiesClient;use Google\Cloud\Compute\V1\InsertTargetHttpProxyRequest;use Google\Cloud\Compute\V1\TargetHttpProxy;use Google\Rpc\Status;/** * @param string $project Project ID for this request. */function insert_sample(string $project): void{    // Create a client.    $targetHttpProxiesClient = new TargetHttpProxiesClient();    // Prepare the request message.    $targetHttpProxyResource = new TargetHttpProxy();    $request = (new InsertTargetHttpProxyRequest())        ->setProject($project)        ->setTargetHttpProxyResource($targetHttpProxyResource);    // Call the API and handle any network failures.    try {        /** @var OperationResponse $response */        $response = $targetHttpProxiesClient->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 the list of TargetHttpProxy resources availableto the specified project.

The async variant isTargetHttpProxiesClient::listAsync() .

Parameters
NameDescription
requestGoogle\Cloud\Compute\V1\ListTargetHttpProxiesRequest

A request to house fields associated with the call.

callOptionsarray

Optional.

↳ retrySettingsRetrySettings|array

Retry settings to use for this call. Can be aGoogle\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation onGoogle\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\ApiCore\PagedListResponse
Example
use Google\ApiCore\ApiException;use Google\ApiCore\PagedListResponse;use Google\Cloud\Compute\V1\Client\TargetHttpProxiesClient;use Google\Cloud\Compute\V1\ListTargetHttpProxiesRequest;/** * @param string $project Project ID for this request. */function list_sample(string $project): void{    // Create a client.    $targetHttpProxiesClient = new TargetHttpProxiesClient();    // Prepare the request message.    $request = (new ListTargetHttpProxiesRequest())        ->setProject($project);    // Call the API and handle any network failures.    try {        /** @var PagedListResponse $response */        $response = $targetHttpProxiesClient->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

Patches the specified TargetHttpProxy resource with the data included inthe request. This method supports PATCHsemantics and usesJSON mergepatch format and processing rules.

The async variant isTargetHttpProxiesClient::patchAsync() .

Parameters
NameDescription
requestGoogle\Cloud\Compute\V1\PatchTargetHttpProxyRequest

A request to house fields associated with the call.

callOptionsarray

Optional.

↳ retrySettingsRetrySettings|array

Retry settings to use for this call. Can be aGoogle\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation onGoogle\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\ApiCore\OperationResponse
Example
use Google\ApiCore\ApiException;use Google\ApiCore\OperationResponse;use Google\Cloud\Compute\V1\Client\TargetHttpProxiesClient;use Google\Cloud\Compute\V1\PatchTargetHttpProxyRequest;use Google\Cloud\Compute\V1\TargetHttpProxy;use Google\Rpc\Status;/** * @param string $project         Project ID for this request. * @param string $targetHttpProxy Name of the TargetHttpProxy resource to patch. */function patch_sample(string $project, string $targetHttpProxy): void{    // Create a client.    $targetHttpProxiesClient = new TargetHttpProxiesClient();    // Prepare the request message.    $targetHttpProxyResource = new TargetHttpProxy();    $request = (new PatchTargetHttpProxyRequest())        ->setProject($project)        ->setTargetHttpProxy($targetHttpProxy)        ->setTargetHttpProxyResource($targetHttpProxyResource);    // Call the API and handle any network failures.    try {        /** @var OperationResponse $response */        $response = $targetHttpProxiesClient->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{    $project = '[PROJECT]';    $targetHttpProxy = '[TARGET_HTTP_PROXY]';    patch_sample($project, $targetHttpProxy);}

setUrlMap

Changes the URL map for TargetHttpProxy.

The async variant isTargetHttpProxiesClient::setUrlMapAsync() .

Parameters
NameDescription
requestGoogle\Cloud\Compute\V1\SetUrlMapTargetHttpProxyRequest

A request to house fields associated with the call.

callOptionsarray

Optional.

↳ retrySettingsRetrySettings|array

Retry settings to use for this call. Can be aGoogle\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation onGoogle\ApiCore\RetrySettings for example usage.

Returns
TypeDescription
Google\ApiCore\OperationResponse
Example
use Google\ApiCore\ApiException;use Google\ApiCore\OperationResponse;use Google\Cloud\Compute\V1\Client\TargetHttpProxiesClient;use Google\Cloud\Compute\V1\SetUrlMapTargetHttpProxyRequest;use Google\Cloud\Compute\V1\UrlMapReference;use Google\Rpc\Status;/** * @param string $project         Project ID for this request. * @param string $targetHttpProxy Name of the TargetHttpProxy to set a URL map for. */function set_url_map_sample(string $project, string $targetHttpProxy): void{    // Create a client.    $targetHttpProxiesClient = new TargetHttpProxiesClient();    // Prepare the request message.    $urlMapReferenceResource = new UrlMapReference();    $request = (new SetUrlMapTargetHttpProxyRequest())        ->setProject($project)        ->setTargetHttpProxy($targetHttpProxy)        ->setUrlMapReferenceResource($urlMapReferenceResource);    // Call the API and handle any network failures.    try {        /** @var OperationResponse $response */        $response = $targetHttpProxiesClient->setUrlMap($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]';    $targetHttpProxy = '[TARGET_HTTP_PROXY]';    set_url_map_sample($project, $targetHttpProxy);}

aggregatedListAsync

Parameters
NameDescription
requestGoogle\Cloud\Compute\V1\AggregatedListTargetHttpProxiesRequest
optionalArgsarray
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

deleteAsync

Parameters
NameDescription
requestGoogle\Cloud\Compute\V1\DeleteTargetHttpProxyRequest
optionalArgsarray
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

getAsync

Parameters
NameDescription
requestGoogle\Cloud\Compute\V1\GetTargetHttpProxyRequest
optionalArgsarray
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Compute\V1\TargetHttpProxy>

insertAsync

Parameters
NameDescription
requestGoogle\Cloud\Compute\V1\InsertTargetHttpProxyRequest
optionalArgsarray
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

listAsync

Parameters
NameDescription
requestGoogle\Cloud\Compute\V1\ListTargetHttpProxiesRequest
optionalArgsarray
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse>

patchAsync

Parameters
NameDescription
requestGoogle\Cloud\Compute\V1\PatchTargetHttpProxyRequest
optionalArgsarray
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

setUrlMapAsync

Parameters
NameDescription
requestGoogle\Cloud\Compute\V1\SetUrlMapTargetHttpProxyRequest
optionalArgsarray
Returns
TypeDescription
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse>

getOperationsClient

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

Returns
TypeDescription
GlobalOperationsClient

resumeOperation

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

Parameters
NameDescription
operationNamestring

The name of the long running operation

methodNamestring

The name of the method used to start the operation

Returns
TypeDescription
Google\ApiCore\OperationResponse

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-01-23 UTC.