Google Cloud Network Connectivity V1 Client - Class Group (1.5.3)

Reference documentation and code samples for the Google Cloud Network Connectivity V1 Client class Group.

A group represents a subset of spokes attached to a hub.

Generated from protobuf message google.cloud.networkconnectivity.v1.Group

Namespace

Google \ Cloud \ NetworkConnectivity \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Immutable. The name of the group. Group names must be unique. They use the following form: projects/{project_number}/locations/global/hubs/{hub}/groups/{group_id}
↳ create_time Google\Protobuf\Timestamp

Output only. The time the group was created.
↳ update_time Google\Protobuf\Timestamp

Output only. The time the group was last updated.
↳ labels array|Google\Protobuf\Internal\MapField

Optional. Labels in key-value pair format. For more information about labels, see Requirements for labels.
↳ description string

Optional. The description of the group.
↳ uid string

Output only. The Google-generated UUID for the group. This value is unique across all group resources. If a group is deleted and another with the same name is created, the new route table is assigned a different unique_id.
↳ state int

Output only. The current lifecycle state of this group.

getName

Immutable. The name of the group. Group names must be unique. They use the following form: projects/{project_number}/locations/global/hubs/{hub}/groups/{group_id}

Returns
Type Description
string

setName

Immutable. The name of the group. Group names must be unique. They use the following form: projects/{project_number}/locations/global/hubs/{hub}/groups/{group_id}

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateTime

Output only. The time the group was created.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time the group was created.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

Output only. The time the group was last updated.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The time the group was last updated.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getLabels

Optional. Labels in key-value pair format. For more information about labels, see Requirements for labels.

Returns
Type Description
Google\Protobuf\Internal\MapField

setLabels

Optional. Labels in key-value pair format. For more information about labels, see Requirements for labels.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getDescription

Optional. The description of the group.

Returns
Type Description
string

setDescription

Optional. The description of the group.

Parameter
Name Description
var string
Returns
Type Description
$this

getUid

Output only. The Google-generated UUID for the group. This value is unique across all group resources. If a group is deleted and another with the same name is created, the new route table is assigned a different unique_id.

Returns
Type Description
string

setUid

Output only. The Google-generated UUID for the group. This value is unique across all group resources. If a group is deleted and another with the same name is created, the new route table is assigned a different unique_id.

Parameter
Name Description
var string
Returns
Type Description
$this

getState

Output only. The current lifecycle state of this group.

Returns
Type Description
int

setState

Output only. The current lifecycle state of this group.

Parameter
Name Description
var int
Returns
Type Description
$this