class ProjectsLocationsAddressGroups extends Resource (View source)

The "addressGroups" collection of methods.

Typical usage is:

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

Methods

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

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

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

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

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

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

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

Deletes a single address group. (addressGroups.delete)

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

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

getIamPolicy(string $resource, array $optParams = [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (addressGroups.getIamPolicy)

listProjectsLocationsAddressGroups(string $parent, array $optParams = [])

Lists address groups in a given project and location.

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

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

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

Updates the parameters of a single address group. (addressGroups.patch)

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

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

setIamPolicy(string $resource, GoogleIamV1SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (addressGroups.setIamPolicy)

testIamPermissions(string $resource, GoogleIamV1TestIamPermissionsRequest $postBody, array $optParams = [])

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.

Details

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

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

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

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

Deletes a single 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

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

GoogleIamV1Policy getIamPolicy(string $resource, array $optParams = [])

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. (addressGroups.getIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

array $optParams

Optional parameters.

Return Value

GoogleIamV1Policy

Exceptions

Exception

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

Lists address groups in a given project and location.

(addressGroups.listProjectsLocationsAddressGroups)

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

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

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

Updates the parameters of a single 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

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

GoogleIamV1Policy setIamPolicy(string $resource, GoogleIamV1SetIamPolicyRequest $postBody, array $optParams = [])

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. (addressGroups.setIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

GoogleIamV1SetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleIamV1Policy

Exceptions

Exception

GoogleIamV1TestIamPermissionsResponse testIamPermissions(string $resource, GoogleIamV1TestIamPermissionsRequest $postBody, array $optParams = [])

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking.

This operation may "fail open" without warning. (addressGroups.testIamPermissions)

Parameters

string $resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

GoogleIamV1TestIamPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleIamV1TestIamPermissionsResponse

Exceptions

Exception