Compute V1 Client - Class InterconnectGroup (1.32.0)

Reference documentation and code samples for the Compute V1 Client class InterconnectGroup.

An interconnect group resource allows customers to create, analyze, and expand their redundant connections.

Generated from protobuf message google.cloud.compute.v1.InterconnectGroup

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ configured InterconnectGroupConfigured
↳ creation_timestamp string

[Output Only] Creation timestamp in RFC3339 text format.
↳ description string

An optional description of this resource. Provide this property when you create the resource.
↳ etag string

Opaque system-generated token that uniquely identifies the configuration. If provided when patching a configuration in update mode, the provided token must match the current token or the update is rejected. This provides a reliable means of doing read-modify-write (optimistic locking) as described by API 154.
↳ id int|string

[Output Only] The unique identifier for the resource type. The server generates this identifier.
↳ intent InterconnectGroupIntent
↳ interconnects array|Google\Protobuf\Internal\MapField

Interconnects in the InterconnectGroup. Keys are arbitrary user-specified strings. Users are encouraged, but not required, to use their preferred format for resource links as keys. Note that there are add-members and remove-members methods in gcloud. The size of this map is limited by an "Interconnects per group" quota.
↳ kind string

[Output Only] Type of the resource. Always compute#InterconnectGroup
↳ name string

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
↳ physical_structure InterconnectGroupPhysicalStructure
↳ self_link string

[Output Only] Server-defined URL for the resource.

getConfigured

Generated from protobuf field optional .google.cloud.compute.v1.InterconnectGroupConfigured configured = 295631422;

Returns
Type Description
InterconnectGroupConfigured|null

hasConfigured

clearConfigured

setConfigured

Generated from protobuf field optional .google.cloud.compute.v1.InterconnectGroupConfigured configured = 295631422;

Parameter
Name Description
var InterconnectGroupConfigured
Returns
Type Description
$this

getCreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Returns
Type Description
string

hasCreationTimestamp

clearCreationTimestamp

setCreationTimestamp

[Output Only] Creation timestamp in RFC3339 text format.

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

An optional description of this resource. Provide this property when you create the resource.

Returns
Type Description
string

hasDescription

clearDescription

setDescription

An optional description of this resource. Provide this property when you create the resource.

Parameter
Name Description
var string
Returns
Type Description
$this

getEtag

Opaque system-generated token that uniquely identifies the configuration. If provided when patching a configuration in update mode, the provided token must match the current token or the update is rejected. This provides a reliable means of doing read-modify-write (optimistic locking) as described by API 154.

Returns
Type Description
string

hasEtag

clearEtag

setEtag

Opaque system-generated token that uniquely identifies the configuration. If provided when patching a configuration in update mode, the provided token must match the current token or the update is rejected. This provides a reliable means of doing read-modify-write (optimistic locking) as described by API 154.

Parameter
Name Description
var string
Returns
Type Description
$this

getId

[Output Only] The unique identifier for the resource type. The server generates this identifier.

Returns
Type Description
int|string

hasId

clearId

setId

[Output Only] The unique identifier for the resource type. The server generates this identifier.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getIntent

Generated from protobuf field optional .google.cloud.compute.v1.InterconnectGroupIntent intent = 426849948;

Returns
Type Description
InterconnectGroupIntent|null

hasIntent

clearIntent

setIntent

Generated from protobuf field optional .google.cloud.compute.v1.InterconnectGroupIntent intent = 426849948;

Parameter
Name Description
var InterconnectGroupIntent
Returns
Type Description
$this

getInterconnects

Interconnects in the InterconnectGroup. Keys are arbitrary user-specified strings. Users are encouraged, but not required, to use their preferred format for resource links as keys. Note that there are add-members and remove-members methods in gcloud. The size of this map is limited by an "Interconnects per group" quota.

Returns
Type Description
Google\Protobuf\Internal\MapField

setInterconnects

Interconnects in the InterconnectGroup. Keys are arbitrary user-specified strings. Users are encouraged, but not required, to use their preferred format for resource links as keys. Note that there are add-members and remove-members methods in gcloud. The size of this map is limited by an "Interconnects per group" quota.

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

getKind

[Output Only] Type of the resource. Always compute#InterconnectGroup

Returns
Type Description
string

hasKind

clearKind

setKind

[Output Only] Type of the resource. Always compute#InterconnectGroup

Parameter
Name Description
var string
Returns
Type Description
$this

getName

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Returns
Type Description
string

hasName

clearName

setName

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.

Parameter
Name Description
var string
Returns
Type Description
$this

getPhysicalStructure

Generated from protobuf field optional .google.cloud.compute.v1.InterconnectGroupPhysicalStructure physical_structure = 195307531;

Returns
Type Description
InterconnectGroupPhysicalStructure|null

hasPhysicalStructure

clearPhysicalStructure

setPhysicalStructure

Generated from protobuf field optional .google.cloud.compute.v1.InterconnectGroupPhysicalStructure physical_structure = 195307531;

Parameter
Name Description
var InterconnectGroupPhysicalStructure
Returns
Type Description
$this

getSelfLink

[Output Only] Server-defined URL for the resource.

Returns
Type Description
string

hasSelfLink

clearSelfLink

setSelfLink

[Output Only] Server-defined URL for the resource.

Parameter
Name Description
var string
Returns
Type Description
$this