Reference documentation and code samples for the Compute V1 Client class RegionTargetTcpProxiesClient.
Service Description: The RegionTargetTcpProxies 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 |
delete
Deletes the specified TargetTcpProxy resource.
The async variant is RegionTargetTcpProxiesClient::deleteAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\DeleteRegionTargetTcpProxyRequest
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\RegionTargetTcpProxiesClient;
use Google\Cloud\Compute\V1\DeleteRegionTargetTcpProxyRequest;
use Google\Rpc\Status;
/**
* @param string $project Project ID for this request.
* @param string $region Name of the region scoping this request.
* @param string $targetTcpProxy Name of the TargetTcpProxy resource to delete.
*/
function delete_sample(string $project, string $region, string $targetTcpProxy): void
{
// Create a client.
$regionTargetTcpProxiesClient = new RegionTargetTcpProxiesClient();
// Prepare the request message.
$request = (new DeleteRegionTargetTcpProxyRequest())
->setProject($project)
->setRegion($region)
->setTargetTcpProxy($targetTcpProxy);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $regionTargetTcpProxiesClient->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]';
$region = '[REGION]';
$targetTcpProxy = '[TARGET_TCP_PROXY]';
delete_sample($project, $region, $targetTcpProxy);
}
get
Returns the specified TargetTcpProxy resource.
The async variant is RegionTargetTcpProxiesClient::getAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\GetRegionTargetTcpProxyRequest
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\TargetTcpProxy |
use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\Client\RegionTargetTcpProxiesClient;
use Google\Cloud\Compute\V1\GetRegionTargetTcpProxyRequest;
use Google\Cloud\Compute\V1\TargetTcpProxy;
/**
* @param string $project Project ID for this request.
* @param string $region Name of the region scoping this request.
* @param string $targetTcpProxy Name of the TargetTcpProxy resource to return.
*/
function get_sample(string $project, string $region, string $targetTcpProxy): void
{
// Create a client.
$regionTargetTcpProxiesClient = new RegionTargetTcpProxiesClient();
// Prepare the request message.
$request = (new GetRegionTargetTcpProxyRequest())
->setProject($project)
->setRegion($region)
->setTargetTcpProxy($targetTcpProxy);
// Call the API and handle any network failures.
try {
/** @var TargetTcpProxy $response */
$response = $regionTargetTcpProxiesClient->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]';
$region = '[REGION]';
$targetTcpProxy = '[TARGET_TCP_PROXY]';
get_sample($project, $region, $targetTcpProxy);
}
insert
Creates a TargetTcpProxy resource in the specified project and region using the data included in the request.
The async variant is RegionTargetTcpProxiesClient::insertAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\InsertRegionTargetTcpProxyRequest
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\RegionTargetTcpProxiesClient;
use Google\Cloud\Compute\V1\InsertRegionTargetTcpProxyRequest;
use Google\Cloud\Compute\V1\TargetTcpProxy;
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.
$regionTargetTcpProxiesClient = new RegionTargetTcpProxiesClient();
// Prepare the request message.
$targetTcpProxyResource = new TargetTcpProxy();
$request = (new InsertRegionTargetTcpProxyRequest())
->setProject($project)
->setRegion($region)
->setTargetTcpProxyResource($targetTcpProxyResource);
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $regionTargetTcpProxiesClient->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 TargetTcpProxy resources available to the specified project in a given region.
The async variant is RegionTargetTcpProxiesClient::listAsync() .
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\ListRegionTargetTcpProxiesRequest
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\RegionTargetTcpProxiesClient;
use Google\Cloud\Compute\V1\ListRegionTargetTcpProxiesRequest;
/**
* @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.
$regionTargetTcpProxiesClient = new RegionTargetTcpProxiesClient();
// Prepare the request message.
$request = (new ListRegionTargetTcpProxiesRequest())
->setProject($project)
->setRegion($region);
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $regionTargetTcpProxiesClient->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);
}
deleteAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\DeleteRegionTargetTcpProxyRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
getAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\GetRegionTargetTcpProxyRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\Cloud\Compute\V1\TargetTcpProxy> |
insertAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\InsertRegionTargetTcpProxyRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\OperationResponse> |
listAsync
Parameters | |
---|---|
Name | Description |
request |
Google\Cloud\Compute\V1\ListRegionTargetTcpProxiesRequest
|
optionalArgs |
array
|
Returns | |
---|---|
Type | Description |
GuzzleHttp\Promise\PromiseInterface<Google\ApiCore\PagedListResponse> |
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 |