Reference documentation and code samples for the Compute V1 Client class GlobalAddressesClient.
Service Description: The GlobalAddresses API.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
$globalAddressesClient = new GlobalAddressesClient();
try {
$address = 'address';
$project = 'project';
$operationResponse = $globalAddressesClient->delete($address, $project);
$operationResponse->pollUntilComplete();
if ($operationResponse->operationSucceeded()) {
// if creating/modifying, retrieve the target resource
} else {
$error = $operationResponse->getError();
// handleError($error)
}
// Alternatively:
// start the operation, keep the operation name, and resume later
$operationResponse = $globalAddressesClient->delete($address, $project);
$operationName = $operationResponse->getName();
// ... do other work
$newOperationResponse = $globalAddressesClient->resumeOperation($operationName, 'delete');
while (!$newOperationResponse->isDone()) {
// ... do other work
$newOperationResponse->reload();
}
if ($newOperationResponse->operationSucceeded()) {
// if creating/modifying, retrieve the target resource
} else {
$error = $newOperationResponse->getError();
// handleError($error)
}
} finally {
$globalAddressesClient->close();
}
Methods
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 | |
__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. |
delete
Deletes the specified address resource.
| Parameters | |
|---|---|
| Name | Description |
address |
string
Name of the address resource to delete. |
project |
string
Project ID for this request. |
optionalArgs |
array
Optional. |
↳ requestId |
string
An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). |
↳ 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\GlobalAddressesClient;
use Google\Rpc\Status;
/**
* @param string $address Name of the address resource to delete.
* @param string $project Project ID for this request.
*/
function delete_sample(string $address, string $project): void
{
// Create a client.
$globalAddressesClient = new GlobalAddressesClient();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $globalAddressesClient->delete($address, $project);
$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());
}
}
/**
* 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
{
$address = '[ADDRESS]';
$project = '[PROJECT]';
delete_sample($address, $project);
}
get
Returns the specified address resource.
| Parameters | |
|---|---|
| Name | Description |
address |
string
Name of the address resource to return. |
project |
string
Project ID for this request. |
optionalArgs |
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\Address | |
use Google\ApiCore\ApiException;
use Google\Cloud\Compute\V1\Address;
use Google\Cloud\Compute\V1\GlobalAddressesClient;
/**
* @param string $address Name of the address resource to return.
* @param string $project Project ID for this request.
*/
function get_sample(string $address, string $project): void
{
// Create a client.
$globalAddressesClient = new GlobalAddressesClient();
// Call the API and handle any network failures.
try {
/** @var Address $response */
$response = $globalAddressesClient->get($address, $project);
printf('Response data: %s' . PHP_EOL, $response->serializeToJsonString());
} catch (ApiException $ex) {
printf('Call failed with message: %s' . PHP_EOL, $ex->getMessage());
}
}
/**
* 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
{
$address = '[ADDRESS]';
$project = '[PROJECT]';
get_sample($address, $project);
}
insert
Creates an address resource in the specified project by using the data included in the request.
| Parameters | |
|---|---|
| Name | Description |
addressResource |
Google\Cloud\Compute\V1\Address
The body resource for this request |
project |
string
Project ID for this request. |
optionalArgs |
array
Optional. |
↳ requestId |
string
An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). |
↳ 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\Address;
use Google\Cloud\Compute\V1\GlobalAddressesClient;
use Google\Rpc\Status;
/**
* @param string $project Project ID for this request.
*/
function insert_sample(string $project): void
{
// Create a client.
$globalAddressesClient = new GlobalAddressesClient();
// Prepare any non-scalar elements to be passed along with the request.
$addressResource = new Address();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $globalAddressesClient->insert($addressResource, $project);
$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());
}
}
/**
* 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 global addresses.
| Parameters | |
|---|---|
| Name | Description |
project |
string
Project ID for this request. |
optionalArgs |
array
Optional. |
↳ filter |
string
A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either |
↳ maxResults |
int
The maximum number of results per page that should be returned. If the number of available results is larger than |
↳ orderBy |
string
Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using |
↳ pageToken |
string
A page token is used to specify a page of values to be returned. If no page token is specified (the default), the first page of values will be returned. Any page token used here must have been generated by a previous call to the API. |
↳ returnPartialSuccess |
bool
Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. |
↳ 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\GlobalAddressesClient;
/**
* @param string $project Project ID for this request.
*/
function list_sample(string $project): void
{
// Create a client.
$globalAddressesClient = new GlobalAddressesClient();
// Call the API and handle any network failures.
try {
/** @var PagedListResponse $response */
$response = $globalAddressesClient->list($project);
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());
}
}
/**
* 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);
}
setLabels
Sets the labels on a GlobalAddress. To learn more about labels, read the Labeling Resources documentation.
| Parameters | |
|---|---|
| Name | Description |
globalSetLabelsRequestResource |
Google\Cloud\Compute\V1\GlobalSetLabelsRequest
The body resource for this request |
project |
string
Project ID for this request. |
resource |
string
Name or id of the resource for this request. |
optionalArgs |
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\GlobalAddressesClient;
use Google\Cloud\Compute\V1\GlobalSetLabelsRequest;
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.
$globalAddressesClient = new GlobalAddressesClient();
// Prepare any non-scalar elements to be passed along with the request.
$globalSetLabelsRequestResource = new GlobalSetLabelsRequest();
// Call the API and handle any network failures.
try {
/** @var OperationResponse $response */
$response = $globalAddressesClient->setLabels($globalSetLabelsRequestResource, $project, $resource);
$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());
}
}
/**
* 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);
}
Constants
SERVICE_NAME
Value: 'google.cloud.compute.v1.GlobalAddresses'The name of the service.
SERVICE_ADDRESS
Value: 'compute.googleapis.com'The default address of the service.
DEFAULT_SERVICE_PORT
Value: 443The default port of the service.
CODEGEN_NAME
Value: 'gapic'The name of the code generator, to be included in the agent header.