Compute V1 Client - Class WireGroup (2.3.0)

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

A resource that represents a group of redundant wires.

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

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ admin_enabled
bool

Indicates whether the wires in the wire group are enabled. When false, the wires in the wire group are disabled. When true and when there is simultaneously no wire-specific override of adminEnabled to false, a given wire is enabled. Defaults to true.

↳ creation_timestamp
string

[Output Only] Creation timestamp inRFC3339 text format.

↳ description
string

An optional description of the wire group.

↳ endpoints
array| Google\Protobuf\Internal\MapField

A map that contains the logical endpoints of the wire group. Specify key-value pairs for the map as follows: - Key: an RFC1035 user-specified label. - Value: an Endpoint object.

↳ id
int|string

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

↳ kind
string

[Output Only] Type of the resource. Alwayscompute#wireGroups for wire groups.

↳ 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 withRFC1035. 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.

↳ reconciling
bool

[Output Only] Indicates whether there are wire changes yet to be processed.

↳ self_link
string

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

↳ topology
WireGroupTopology

Topology details for the wire group configuration.

↳ wire_properties
WireProperties

Properties for all wires in the wire group.

↳ wires
array< Wire >

The single/redundant wire(s) managed by the wire group.

getAdminEnabled

Indicates whether the wires in the wire group are enabled. When false, the wires in the wire group are disabled. When true and when there is simultaneously no wire-specific override of adminEnabled to false, a given wire is enabled. Defaults to true.

Returns
Type
Description
bool

hasAdminEnabled

clearAdminEnabled

setAdminEnabled

Indicates whether the wires in the wire group are enabled. When false, the wires in the wire group are disabled. When true and when there is simultaneously no wire-specific override of adminEnabled to false, a given wire is enabled. Defaults to true.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

getCreationTimestamp

[Output Only] Creation timestamp inRFC3339 text format.

Returns
Type
Description
string

hasCreationTimestamp

clearCreationTimestamp

setCreationTimestamp

[Output Only] Creation timestamp inRFC3339 text format.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getDescription

An optional description of the wire group.

Returns
Type
Description
string

hasDescription

clearDescription

setDescription

An optional description of the wire group.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getEndpoints

A map that contains the logical endpoints of the wire group. Specify key-value pairs for the map as follows:

  • Key: an RFC1035 user-specified label.
  • Value: an Endpoint object.
Returns
Type
Description

setEndpoints

A map that contains the logical endpoints of the wire group. Specify key-value pairs for the map as follows:

  • Key: an RFC1035 user-specified label.
  • Value: an Endpoint object.
Parameter
Name
Description
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

getKind

[Output Only] Type of the resource. Alwayscompute#wireGroups for wire groups.

Returns
Type
Description
string

hasKind

clearKind

setKind

[Output Only] Type of the resource. Alwayscompute#wireGroups for wire groups.

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

getReconciling

[Output Only] Indicates whether there are wire changes yet to be processed.

Returns
Type
Description
bool

hasReconciling

clearReconciling

setReconciling

[Output Only] Indicates whether there are wire changes yet to be processed.

Parameter
Name
Description
var
bool
Returns
Type
Description
$this

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

Returns
Type
Description
string

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

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getTopology

Topology details for the wire group configuration.

Returns
Type
Description

hasTopology

clearTopology

setTopology

Topology details for the wire group configuration.

Parameter
Name
Description
Returns
Type
Description
$this

getWireProperties

Properties for all wires in the wire group.

Returns
Type
Description

hasWireProperties

clearWireProperties

setWireProperties

Properties for all wires in the wire group.

Parameter
Name
Description
Returns
Type
Description
$this

getWires

The single/redundant wire(s) managed by the wire group.

Returns
Type
Description

setWires

The single/redundant wire(s) managed by the wire group.

Parameter
Name
Description
var
array< Wire >
Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: