Compute V1 Client - Class Wire (2.3.0)

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

A pseudowire that connects two Interconnect connections.

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

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ admin_enabled bool

[Output Only] Indicates whether the wire is enabled. When false, the wire is disabled. When true and when the wire group of the wire is also enabled, the wire is enabled. Defaults to true.
↳ endpoints array<WireEndpoint>

Wire endpoints are specific Interconnect connections.
↳ label string

[Output Only] A label that identifies the wire. The format of this label combines the existing labels of the wire group endpoints and Interconnect connections used by this wire in alphabetical order as follows: ENDPOINT_A+CONNECTION_A1,ENDPOINT_B+CONNECTION_B1, where: - ENDPOINT_A and ENDPOINT_B: are the labels that you entered as map keys when you specified the wire group endpoint objects. - CONNECTION_A1 and CONNECTION_B1: are the labels that you entered as map keys when you specified the wire group Interconnect objects.
↳ wire_properties WireProperties

[Output Only] Properties of the wire.

getAdminEnabled

[Output Only] Indicates whether the wire is enabled.

When false, the wire is disabled. When true and when the wire group of the wire is also enabled, the wire is enabled. Defaults to true.

Returns
Type Description
bool

hasAdminEnabled

clearAdminEnabled

setAdminEnabled

[Output Only] Indicates whether the wire is enabled.

When false, the wire is disabled. When true and when the wire group of the wire is also enabled, the wire is enabled. Defaults to true.

Parameter
Name Description
var bool
Returns
Type Description
$this

getEndpoints

Wire endpoints are specific Interconnect connections.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setEndpoints

Wire endpoints are specific Interconnect connections.

Parameter
Name Description
var array<WireEndpoint>
Returns
Type Description
$this

getLabel

[Output Only] A label that identifies the wire. The format of this label combines the existing labels of the wire group endpoints and Interconnect connections used by this wire in alphabetical order as follows: ENDPOINT_A+CONNECTION_A1,ENDPOINT_B+CONNECTION_B1, where:

  • ENDPOINT_A and ENDPOINT_B: are the labels that you entered as map keys when you specified the wire group endpoint objects.
  • CONNECTION_A1 and CONNECTION_B1: are the labels that you entered as map keys when you specified the wire group Interconnect objects.
Returns
Type Description
string

hasLabel

clearLabel

setLabel

[Output Only] A label that identifies the wire. The format of this label combines the existing labels of the wire group endpoints and Interconnect connections used by this wire in alphabetical order as follows: ENDPOINT_A+CONNECTION_A1,ENDPOINT_B+CONNECTION_B1, where:

  • ENDPOINT_A and ENDPOINT_B: are the labels that you entered as map keys when you specified the wire group endpoint objects.
  • CONNECTION_A1 and CONNECTION_B1: are the labels that you entered as map keys when you specified the wire group Interconnect objects.
Parameter
Name Description
var string
Returns
Type Description
$this

getWireProperties

[Output Only] Properties of the wire.

Returns
Type Description
WireProperties|null

hasWireProperties

clearWireProperties

setWireProperties

[Output Only] Properties of the wire.

Parameter
Name Description
var WireProperties
Returns
Type Description
$this