Reference documentation and code samples for the Compute V1 Client class TargetHttpProxiesClient.
Service Description: The TargetHttpProxies API.
This class is currently experimental and may be subject to changes.
Namespace
Google \ Cloud \ Compute \ V1 \ ClientMethods
__construct
Constructor.
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.
aggregatedList
Retrieves the list of all TargetHttpProxy resources, regional and global, available to the specified project.
The async variant is Google\Cloud\Compute\V1\Client\BaseClient\self::aggregatedListAsync() .
request
Google\Cloud\Compute\V1\AggregatedListTargetHttpProxiesRequest
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.
delete
Deletes the specified TargetHttpProxy resource.
The async variant is Google\Cloud\Compute\V1\Client\BaseClient\self::deleteAsync() .
request
Google\Cloud\Compute\V1\DeleteTargetHttpProxyRequest
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.
get
Returns the specified TargetHttpProxy resource.
The async variant is Google\Cloud\Compute\V1\Client\BaseClient\self::getAsync() .
request
Google\Cloud\Compute\V1\GetTargetHttpProxyRequest
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.
insert
Creates a TargetHttpProxy resource in the specified project using the data included in the request.
The async variant is Google\Cloud\Compute\V1\Client\BaseClient\self::insertAsync() .
request
Google\Cloud\Compute\V1\InsertTargetHttpProxyRequest
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.
list
Retrieves the list of TargetHttpProxy resources available to the specified project.
The async variant is Google\Cloud\Compute\V1\Client\BaseClient\self::listAsync() .
request
Google\Cloud\Compute\V1\ListTargetHttpProxiesRequest
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.
patch
Patches the specified TargetHttpProxy resource with the data included in the request. This method supports PATCH semantics and uses JSON merge patch format and processing rules.
The async variant is Google\Cloud\Compute\V1\Client\BaseClient\self::patchAsync() .
request
Google\Cloud\Compute\V1\PatchTargetHttpProxyRequest
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.
setUrlMap
Changes the URL map for TargetHttpProxy.
The async variant is Google\Cloud\Compute\V1\Client\BaseClient\self::setUrlMapAsync() .
request
Google\Cloud\Compute\V1\SetUrlMapTargetHttpProxyRequest
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.
aggregatedListAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
deleteAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
insertAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
listAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
patchAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
setUrlMapAsync
optionalArgs = []
array
GuzzleHttp\Promise\PromiseInterface
getOperationsClient
Return an GlobalOperationsClient object with the same endpoint as $this.
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.
operationName
string
The name of the long running operation
methodName
string
The name of the method used to start the operation
