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

Addresses

class Addresses extends Resource (View source)

The "addresses" collection of methods.

Typical usage is:

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

Methods

AddressAggregatedList
aggregatedList(string $project, array $optParams = [])

Retrieves an aggregated list of addresses. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

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

Deletes the specified address resource. (addresses.delete)

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

Returns the specified address resource. (addresses.get)

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

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

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

Retrieves a list of addresses contained within the specified region.

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

Moves the specified address resource. (addresses.move)

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

Sets the labels on an Address. To learn more about labels, read the Labeling Resources documentation. (addresses.setLabels)

Details

at line 111
AddressAggregatedList aggregatedList(string $project, array $optParams = [])

Retrieves an aggregated list of addresses. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

(addresses.aggregatedList)

Parameters

string $project

Project ID for this request.
array $optParams

Optional parameters.

Return Value

AddressAggregatedList

Exceptions

Exception

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

Deletes the specified address resource. (addresses.delete)

Parameters

string $project

Project ID for this request.
string $region

Name of the region for this request.
string $address

Name of the address resource to delete.
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

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

Returns the specified address resource. (addresses.get)

Parameters

string $project

Project ID for this request.
string $region

Name of the region for this request.
string $address

Name of the address resource to return.
array $optParams

Optional parameters.

Return Value

Address

Exceptions

Exception

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

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

Parameters

string $project

Project ID for this request.
string $region

Name of the region for this request.
Address $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 252
AddressList listAddresses(string $project, string $region, array $optParams = [])

Retrieves a list of addresses contained within the specified region.

(addresses.listAddresses)

Parameters

string $project

Project ID for this request.
string $region

Name of the region for this request.
array $optParams

Optional parameters.

Return Value

AddressList

Exceptions

Exception

at line 280
Operation move(string $project, string $region, string $address, RegionAddressesMoveRequest $postBody, array $optParams = [])

Moves the specified address resource. (addresses.move)

Parameters

string $project

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

Name of the region for this request.
string $address

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

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 309
Operation setLabels(string $project, string $region, string $resource, RegionSetLabelsRequest $postBody, array $optParams = [])

Sets the labels on an Address. To learn more about labels, read the Labeling Resources documentation. (addresses.setLabels)

Parameters

string $project

Project ID for this request.
string $region

The region for this request.
string $resource

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

Optional parameters.

Return Value

Operation

Exceptions

Exception