1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Compute
  7. \
  8. Resource
  9. \
  10. GlobalAddresses

GlobalAddresses

class GlobalAddresses extends Resource (View source)

The "globalAddresses" collection of methods.

Typical usage is:

 $computeService = new Google\Service\Compute(...);
 $globalAddresses = $computeService->globalAddresses;

Methods

Operation
delete(string $project, string $address, array $optParams = [])

Deletes the specified address resource. (globalAddresses.delete)

Address
get(string $project, string $address, array $optParams = [])

Returns the specified address resource. (globalAddresses.get)

Operation
insert(string $project, Address $postBody, array $optParams = [])

Creates an address resource in the specified project by using the data included in the request. (globalAddresses.insert)

AddressList
listGlobalAddresses(string $project, array $optParams = [])

Retrieves a list of global addresses. (globalAddresses.listGlobalAddresses)

Operation
move(string $project, string $address, GlobalAddressesMoveRequest $postBody, array $optParams = [])

Moves the specified address resource from one project to another project.

Operation
setLabels(string $project, string $resource, GlobalSetLabelsRequest $postBody, array $optParams = [])

Sets the labels on a GlobalAddress. To learn more about labels, read the Labeling Resources documentation. (globalAddresses.setLabels)

Details

at line 56
Operation delete(string $project, string $address, array $optParams = [])

Deletes the specified address resource. (globalAddresses.delete)

Parameters

string $project

Project ID for this request.
string $address

Name of the address resource to delete.
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 71
Address get(string $project, string $address, array $optParams = [])

Returns the specified address resource. (globalAddresses.get)

Parameters

string $project

Project ID for this request.
string $address

Name of the address resource to return.
array $optParams

Optional parameters.

Return Value

Address

Exceptions

Exception

at line 98
Operation insert(string $project, Address $postBody, array $optParams = [])

Creates an address resource in the specified project by using the data included in the request. (globalAddresses.insert)

Parameters

string $project

Project ID for this request.
Address $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 166
AddressList listGlobalAddresses(string $project, array $optParams = [])

Retrieves a list of global addresses. (globalAddresses.listGlobalAddresses)

Parameters

string $project

Project ID for this request.
array $optParams

Optional parameters.

Return Value

AddressList

Exceptions

Exception

at line 194
Operation move(string $project, string $address, GlobalAddressesMoveRequest $postBody, array $optParams = [])

Moves the specified address resource from one project to another project.

(globalAddresses.move)

Parameters

string $project

Source project ID which the Address is moved from.
string $address

Name of the address resource to move.
GlobalAddressesMoveRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 211
Operation setLabels(string $project, string $resource, GlobalSetLabelsRequest $postBody, array $optParams = [])

Sets the labels on a GlobalAddress. To learn more about labels, read the Labeling Resources documentation. (globalAddresses.setLabels)

Parameters

string $project

Project ID for this request.
string $resource

Name or id of the resource for this request.
GlobalSetLabelsRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception