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

OrganizationsLocationsAddressGroups

class OrganizationsLocationsAddressGroups extends Resource (View source)

The "addressGroups" collection of methods.

Typical usage is:

 $networksecurityService = new Google\Service\NetworkSecurity(...);
 $addressGroups = $networksecurityService->organizations_locations_addressGroups;

Methods

Operation
addItems(string $addressGroup, AddAddressGroupItemsRequest $postBody, array $optParams = [])

Adds items to an address group. (addressGroups.addItems)

Operation
cloneItems(string $addressGroup, CloneAddressGroupItemsRequest $postBody, array $optParams = [])

Clones items from one address group to another. (addressGroups.cloneItems)

Operation
create(string $parent, AddressGroup $postBody, array $optParams = [])

Creates a new address group in a given project and location.

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

Deletes an address group. (addressGroups.delete)

AddressGroup
get(string $name, array $optParams = [])

Gets details of a single address group. (addressGroups.get)

ListAddressGroupsResponse
listOrganizationsLocationsAddressGroups(string $parent, array $optParams = [])

Lists address groups in a given project and location.

ListAddressGroupReferencesResponse
listReferences(string $addressGroup, array $optParams = [])

Lists references of an address group. (addressGroups.listReferences)

Operation
patch(string $name, AddressGroup $postBody, array $optParams = [])

Updates parameters of an address group. (addressGroups.patch)

Operation
removeItems(string $addressGroup, RemoveAddressGroupItemsRequest $postBody, array $optParams = [])

Removes items from an address group. (addressGroups.removeItems)

Details

at line 49
Operation addItems(string $addressGroup, AddAddressGroupItemsRequest $postBody, array $optParams = [])

Adds items to an address group. (addressGroups.addItems)

Parameters

string $addressGroup

Required. A name of the AddressGroup to add items to. Must be in the format projects|organization/locations/{location}/addressGroups.
AddAddressGroupItemsRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 66
Operation cloneItems(string $addressGroup, CloneAddressGroupItemsRequest $postBody, array $optParams = [])

Clones items from one address group to another. (addressGroups.cloneItems)

Parameters

string $addressGroup

Required. A name of the AddressGroup to clone items to. Must be in the format projects|organization/locations/{location}/addressGroups.
CloneAddressGroupItemsRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 99
Operation create(string $parent, AddressGroup $postBody, array $optParams = [])

Creates a new address group in a given project and location.

(addressGroups.create)

Parameters

string $parent

Required. The parent resource of the AddressGroup. Must be in the format projects/locations/{location}.
AddressGroup $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 126
Operation delete(string $name, array $optParams = [])

Deletes an address group. (addressGroups.delete)

Parameters

string $name

Required. A name of the AddressGroup to delete. Must be in the format projects/locations/{location}/addressGroups.
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 141
AddressGroup get(string $name, array $optParams = [])

Gets details of a single address group. (addressGroups.get)

Parameters

string $name

Required. A name of the AddressGroup to get. Must be in the format projects/locations/{location}/addressGroups.
array $optParams

Optional parameters.

Return Value

AddressGroup

Exceptions

Exception

at line 164
ListAddressGroupsResponse listOrganizationsLocationsAddressGroups(string $parent, array $optParams = [])

Lists address groups in a given project and location.

(addressGroups.listOrganizationsLocationsAddressGroups)

Parameters

string $parent

Required. The project and location from which the AddressGroups should be listed, specified in the format projects/locations/{location}.
array $optParams

Optional parameters.

Return Value

ListAddressGroupsResponse

Exceptions

Exception

at line 187
ListAddressGroupReferencesResponse listReferences(string $addressGroup, array $optParams = [])

Lists references of an address group. (addressGroups.listReferences)

Parameters

string $addressGroup

Required. A name of the AddressGroup to clone items to. Must be in the format projects|organization/locations/{location}/addressGroups.
array $optParams

Optional parameters.

Return Value

ListAddressGroupReferencesResponse

Exceptions

Exception

at line 220
Operation patch(string $name, AddressGroup $postBody, array $optParams = [])

Updates parameters of an address group. (addressGroups.patch)

Parameters

string $name

Required. Name of the AddressGroup resource. It matches pattern projects/locations/{location}/addressGroups/.
AddressGroup $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

at line 237
Operation removeItems(string $addressGroup, RemoveAddressGroupItemsRequest $postBody, array $optParams = [])

Removes items from an address group. (addressGroups.removeItems)

Parameters

string $addressGroup

Required. A name of the AddressGroup to remove items from. Must be in the format projects|organization/locations/{location}/addressGroups.
RemoveAddressGroupItemsRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception