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

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.

↳ auto_accept
AutoAccept

Optional. The auto-accept setting for this group.

↳ route_table
string

Output only. The name of the route table that corresponds to this group. They use the following form: projects/{project_number}/locations/global/hubs/{hub_id}/routeTables/{route_table_id}

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

hasCreateTime

clearCreateTime

setCreateTime

Output only. The time the group was created.

Parameter
Name
Description
Returns
Type
Description
$this

getUpdateTime

Output only. The time the group was last updated.

Returns
Type
Description

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The time the group was last updated.

Parameter
Name
Description
Returns
Type
Description
$this

getLabels

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

Returns
Type
Description

setLabels

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

Parameter
Name
Description
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

getAutoAccept

Optional. The auto-accept setting for this group.

Returns
Type
Description
AutoAccept |null

hasAutoAccept

clearAutoAccept

setAutoAccept

Optional. The auto-accept setting for this group.

Parameter
Name
Description
Returns
Type
Description
$this

getRouteTable

Output only. The name of the route table that corresponds to this group.

They use the following form: projects/{project_number}/locations/global/hubs/{hub_id}/routeTables/{route_table_id}

Returns
Type
Description
string

setRouteTable

Output only. The name of the route table that corresponds to this group.

They use the following form: projects/{project_number}/locations/global/hubs/{hub_id}/routeTables/{route_table_id}

Parameter
Name
Description
var
string
Returns
Type
Description
$this
Design a Mobile Site
View Site in Mobile | Classic
Share by: