Google Cloud Network Security V1 Client - Class CreateAddressGroupRequest (1.1.0)

Reference documentation and code samples for the Google Cloud Network Security V1 Client class CreateAddressGroupRequest.

Request used by the CreateAddressGroup method.

Generated from protobuf message google.cloud.networksecurity.v1.CreateAddressGroupRequest

Namespace

Google \ Cloud \ NetworkSecurity \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The parent resource of the AddressGroup. Must be in the format projects/*/locations/{location}.

↳ address_group_id string

Required. Short name of the AddressGroup resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. "authz_policy".

↳ address_group AddressGroup

Required. AddressGroup resource to be created.

↳ request_id string

Optional. 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. The server will guarantee that for at least 60 minutes since the first request. 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).

getParent

Required. The parent resource of the AddressGroup. Must be in the format projects/*/locations/{location}.

Returns
Type Description
string

setParent

Required. The parent resource of the AddressGroup. Must be in the format projects/*/locations/{location}.

Parameter
Name Description
var string
Returns
Type Description
$this

getAddressGroupId

Required. Short name of the AddressGroup resource to be created.

This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. "authz_policy".

Returns
Type Description
string

setAddressGroupId

Required. Short name of the AddressGroup resource to be created.

This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. "authz_policy".

Parameter
Name Description
var string
Returns
Type Description
$this

getAddressGroup

Required. AddressGroup resource to be created.

Returns
Type Description
AddressGroup|null

hasAddressGroup

clearAddressGroup

setAddressGroup

Required. AddressGroup resource to be created.

Parameter
Name Description
var AddressGroup
Returns
Type Description
$this

getRequestId

Optional. 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. The server will guarantee that for at least 60 minutes since the first request.

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).

Returns
Type Description
string

setRequestId

Optional. 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. The server will guarantee that for at least 60 minutes since the first request.

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).

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameters
Name Description
parent string

Required. The parent resource of the AddressGroup. Must be in the format projects/*/locations/{location}. Please see AddressGroupServiceClient::organizationLocationName() for help formatting this field.

addressGroup AddressGroup

Required. AddressGroup resource to be created.

addressGroupId string

Required. Short name of the AddressGroup resource to be created. This value should be 1-63 characters long, containing only letters, numbers, hyphens, and underscores, and should not start with a number. E.g. "authz_policy".

Returns
Type Description
CreateAddressGroupRequest