Class Spoke (1.54.0) 

public final class Spoke extends GeneratedMessageV3 implements SpokeOrBuilder

A Network Connectivity Center spoke represents one or more network connectivity resources.

When you create a spoke, you associate it with a hub. You must also identify a value for exactly one of the following fields:

  • linked_vpn_tunnels
  • linked_interconnect_attachments
  • linked_router_appliance_instances
  • linked_vpc_network

Protobuf type google.cloud.networkconnectivity.v1.Spoke

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Spoke

Implements

SpokeOrBuilder

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

GROUP_FIELD_NUMBER

public static final int GROUP_FIELD_NUMBER
Field Value
Type Description
int

HUB_FIELD_NUMBER

public static final int HUB_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

LINKED_INTERCONNECT_ATTACHMENTS_FIELD_NUMBER

public static final int LINKED_INTERCONNECT_ATTACHMENTS_FIELD_NUMBER
Field Value
Type Description
int

LINKED_PRODUCER_VPC_NETWORK_FIELD_NUMBER

public static final int LINKED_PRODUCER_VPC_NETWORK_FIELD_NUMBER
Field Value
Type Description
int

LINKED_ROUTER_APPLIANCE_INSTANCES_FIELD_NUMBER

public static final int LINKED_ROUTER_APPLIANCE_INSTANCES_FIELD_NUMBER
Field Value
Type Description
int

LINKED_VPC_NETWORK_FIELD_NUMBER

public static final int LINKED_VPC_NETWORK_FIELD_NUMBER
Field Value
Type Description
int

LINKED_VPN_TUNNELS_FIELD_NUMBER

public static final int LINKED_VPN_TUNNELS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

REASONS_FIELD_NUMBER

public static final int REASONS_FIELD_NUMBER
Field Value
Type Description
int

SPOKE_TYPE_FIELD_NUMBER

public static final int SPOKE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

UNIQUE_ID_FIELD_NUMBER

public static final int UNIQUE_ID_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Spoke getDefaultInstance()
Returns
Type Description
Spoke

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Spoke.Builder newBuilder()
Returns
Type Description
Spoke.Builder

newBuilder(Spoke prototype)

public static Spoke.Builder newBuilder(Spoke prototype)
Parameter
Name Description
prototype Spoke
Returns
Type Description
Spoke.Builder

parseDelimitedFrom(InputStream input)

public static Spoke parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Spoke
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Spoke parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Spoke
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Spoke parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Spoke
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Spoke parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Spoke
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Spoke parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Spoke
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Spoke parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Spoke
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Spoke parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Spoke
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Spoke parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Spoke
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Spoke parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Spoke
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Spoke parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Spoke
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Spoke parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Spoke
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Spoke parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Spoke
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Spoke> parser()
Returns
Type Description
Parser<Spoke>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

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

map<string, string> labels = 4;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCreateTime()

public Timestamp getCreateTime()

Output only. The time the spoke was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time the spoke was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Spoke getDefaultInstanceForType()
Returns
Type Description
Spoke

getDescription()

public String getDescription()

An optional description of the spoke.

string description = 5;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

An optional description of the spoke.

string description = 5;

Returns
Type Description
ByteString

The bytes for description.

getGroup()

public String getGroup()

Optional. The name of the group that this spoke is associated with.

string group = 23 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The group.

getGroupBytes()

public ByteString getGroupBytes()

Optional. The name of the group that this spoke is associated with.

string group = 23 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for group.

getHub()

public String getHub()

Immutable. The name of the hub that this spoke is attached to.

string hub = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The hub.

getHubBytes()

public ByteString getHubBytes()

Immutable. The name of the hub that this spoke is attached to.

string hub = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for hub.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

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

map<string, string> labels = 4;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

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

map<string, string> labels = 4;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

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

map<string, string> labels = 4;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

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

map<string, string> labels = 4;

Parameter
Name Description
key String
Returns
Type Description
String

getLinkedInterconnectAttachments()

public LinkedInterconnectAttachments getLinkedInterconnectAttachments()

VLAN attachments that are associated with the spoke.

.google.cloud.networkconnectivity.v1.LinkedInterconnectAttachments linked_interconnect_attachments = 18;

Returns
Type Description
LinkedInterconnectAttachments

The linkedInterconnectAttachments.

getLinkedInterconnectAttachmentsOrBuilder()

public LinkedInterconnectAttachmentsOrBuilder getLinkedInterconnectAttachmentsOrBuilder()

VLAN attachments that are associated with the spoke.

.google.cloud.networkconnectivity.v1.LinkedInterconnectAttachments linked_interconnect_attachments = 18;

Returns
Type Description
LinkedInterconnectAttachmentsOrBuilder

getLinkedProducerVpcNetwork()

public LinkedProducerVpcNetwork getLinkedProducerVpcNetwork()

Optional. The linked producer VPC that is associated with the spoke.

.google.cloud.networkconnectivity.v1.LinkedProducerVpcNetwork linked_producer_vpc_network = 26 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LinkedProducerVpcNetwork

The linkedProducerVpcNetwork.

getLinkedProducerVpcNetworkOrBuilder()

public LinkedProducerVpcNetworkOrBuilder getLinkedProducerVpcNetworkOrBuilder()

Optional. The linked producer VPC that is associated with the spoke.

.google.cloud.networkconnectivity.v1.LinkedProducerVpcNetwork linked_producer_vpc_network = 26 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LinkedProducerVpcNetworkOrBuilder

getLinkedRouterApplianceInstances()

public LinkedRouterApplianceInstances getLinkedRouterApplianceInstances()

Router appliance instances that are associated with the spoke.

.google.cloud.networkconnectivity.v1.LinkedRouterApplianceInstances linked_router_appliance_instances = 19;

Returns
Type Description
LinkedRouterApplianceInstances

The linkedRouterApplianceInstances.

getLinkedRouterApplianceInstancesOrBuilder()

public LinkedRouterApplianceInstancesOrBuilder getLinkedRouterApplianceInstancesOrBuilder()

Router appliance instances that are associated with the spoke.

.google.cloud.networkconnectivity.v1.LinkedRouterApplianceInstances linked_router_appliance_instances = 19;

Returns
Type Description
LinkedRouterApplianceInstancesOrBuilder

getLinkedVpcNetwork()

public LinkedVpcNetwork getLinkedVpcNetwork()

Optional. VPC network that is associated with the spoke.

.google.cloud.networkconnectivity.v1.LinkedVpcNetwork linked_vpc_network = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LinkedVpcNetwork

The linkedVpcNetwork.

getLinkedVpcNetworkOrBuilder()

public LinkedVpcNetworkOrBuilder getLinkedVpcNetworkOrBuilder()

Optional. VPC network that is associated with the spoke.

.google.cloud.networkconnectivity.v1.LinkedVpcNetwork linked_vpc_network = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LinkedVpcNetworkOrBuilder

getLinkedVpnTunnels()

public LinkedVpnTunnels getLinkedVpnTunnels()

VPN tunnels that are associated with the spoke.

.google.cloud.networkconnectivity.v1.LinkedVpnTunnels linked_vpn_tunnels = 17;

Returns
Type Description
LinkedVpnTunnels

The linkedVpnTunnels.

getLinkedVpnTunnelsOrBuilder()

public LinkedVpnTunnelsOrBuilder getLinkedVpnTunnelsOrBuilder()

VPN tunnels that are associated with the spoke.

.google.cloud.networkconnectivity.v1.LinkedVpnTunnels linked_vpn_tunnels = 17;

Returns
Type Description
LinkedVpnTunnelsOrBuilder

getName()

public String getName()

Immutable. The name of the spoke. Spoke names must be unique. They use the following form: projects/{project_number}/locations/{region}/spokes/{spoke_id}

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Immutable. The name of the spoke. Spoke names must be unique. They use the following form: projects/{project_number}/locations/{region}/spokes/{spoke_id}

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Spoke> getParserForType()
Returns
Type Description
Parser<Spoke>
Overrides

getReasons(int index)

public Spoke.StateReason getReasons(int index)

Output only. The reasons for current state of the spoke. Only present when the spoke is in the INACTIVE state.

repeated .google.cloud.networkconnectivity.v1.Spoke.StateReason reasons = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Spoke.StateReason

getReasonsCount()

public int getReasonsCount()

Output only. The reasons for current state of the spoke. Only present when the spoke is in the INACTIVE state.

repeated .google.cloud.networkconnectivity.v1.Spoke.StateReason reasons = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getReasonsList()

public List<Spoke.StateReason> getReasonsList()

Output only. The reasons for current state of the spoke. Only present when the spoke is in the INACTIVE state.

repeated .google.cloud.networkconnectivity.v1.Spoke.StateReason reasons = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<StateReason>

getReasonsOrBuilder(int index)

public Spoke.StateReasonOrBuilder getReasonsOrBuilder(int index)

Output only. The reasons for current state of the spoke. Only present when the spoke is in the INACTIVE state.

repeated .google.cloud.networkconnectivity.v1.Spoke.StateReason reasons = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
Spoke.StateReasonOrBuilder

getReasonsOrBuilderList()

public List<? extends Spoke.StateReasonOrBuilder> getReasonsOrBuilderList()

Output only. The reasons for current state of the spoke. Only present when the spoke is in the INACTIVE state.

repeated .google.cloud.networkconnectivity.v1.Spoke.StateReason reasons = 21 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<? extends com.google.cloud.networkconnectivity.v1.Spoke.StateReasonOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSpokeType()

public SpokeType getSpokeType()

Output only. The type of resource associated with the spoke.

.google.cloud.networkconnectivity.v1.SpokeType spoke_type = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SpokeType

The spokeType.

getSpokeTypeValue()

public int getSpokeTypeValue()

Output only. The type of resource associated with the spoke.

.google.cloud.networkconnectivity.v1.SpokeType spoke_type = 22 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for spokeType.

getState()

public State getState()

Output only. The current lifecycle state of this spoke.

.google.cloud.networkconnectivity.v1.State state = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
State

The state.

getStateValue()

public int getStateValue()

Output only. The current lifecycle state of this spoke.

.google.cloud.networkconnectivity.v1.State state = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getUniqueId()

public String getUniqueId()

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

string unique_id = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The uniqueId.

getUniqueIdBytes()

public ByteString getUniqueIdBytes()

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

string unique_id = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for uniqueId.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The time the spoke was last updated.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The time the spoke was last updated.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. The time the spoke was created.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasLinkedInterconnectAttachments()

public boolean hasLinkedInterconnectAttachments()

VLAN attachments that are associated with the spoke.

.google.cloud.networkconnectivity.v1.LinkedInterconnectAttachments linked_interconnect_attachments = 18;

Returns
Type Description
boolean

Whether the linkedInterconnectAttachments field is set.

hasLinkedProducerVpcNetwork()

public boolean hasLinkedProducerVpcNetwork()

Optional. The linked producer VPC that is associated with the spoke.

.google.cloud.networkconnectivity.v1.LinkedProducerVpcNetwork linked_producer_vpc_network = 26 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the linkedProducerVpcNetwork field is set.

hasLinkedRouterApplianceInstances()

public boolean hasLinkedRouterApplianceInstances()

Router appliance instances that are associated with the spoke.

.google.cloud.networkconnectivity.v1.LinkedRouterApplianceInstances linked_router_appliance_instances = 19;

Returns
Type Description
boolean

Whether the linkedRouterApplianceInstances field is set.

hasLinkedVpcNetwork()

public boolean hasLinkedVpcNetwork()

Optional. VPC network that is associated with the spoke.

.google.cloud.networkconnectivity.v1.LinkedVpcNetwork linked_vpc_network = 20 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the linkedVpcNetwork field is set.

hasLinkedVpnTunnels()

public boolean hasLinkedVpnTunnels()

VPN tunnels that are associated with the spoke.

.google.cloud.networkconnectivity.v1.LinkedVpnTunnels linked_vpn_tunnels = 17;

Returns
Type Description
boolean

Whether the linkedVpnTunnels field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The time the spoke was last updated.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Spoke.Builder newBuilderForType()
Returns
Type Description
Spoke.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Spoke.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Spoke.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Spoke.Builder toBuilder()
Returns
Type Description
Spoke.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException