Class Spoke (1.3.0)

public final class Spoke extends GeneratedMessageV3 implements SpokeOrBuilder

A spoke represents a connection between your Google Cloud network resources and a non-Google-Cloud network. 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

Protobuf type google.cloud.networkconnectivity.v1.Spoke

Implements

SpokeOrBuilder

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

HUB_FIELD_NUMBER

public static final int HUB_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

LINKED_INTERCONNECT_ATTACHMENTS_FIELD_NUMBER

public static final int LINKED_INTERCONNECT_ATTACHMENTS_FIELD_NUMBER
Field Value
TypeDescription
int

LINKED_ROUTER_APPLIANCE_INSTANCES_FIELD_NUMBER

public static final int LINKED_ROUTER_APPLIANCE_INSTANCES_FIELD_NUMBER
Field Value
TypeDescription
int

LINKED_VPN_TUNNELS_FIELD_NUMBER

public static final int LINKED_VPN_TUNNELS_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

UNIQUE_ID_FIELD_NUMBER

public static final int UNIQUE_ID_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Spoke getDefaultInstance()
Returns
TypeDescription
Spoke

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Spoke.Builder newBuilder()
Returns
TypeDescription
Spoke.Builder

newBuilder(Spoke prototype)

public static Spoke.Builder newBuilder(Spoke prototype)
Parameter
NameDescription
prototypeSpoke
Returns
TypeDescription
Spoke.Builder

parseDelimitedFrom(InputStream input)

public static Spoke parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Spoke
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Spoke parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Spoke
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Spoke parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Spoke
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Spoke parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Spoke
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Spoke parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Spoke
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Spoke parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Spoke
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Spoke parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Spoke
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Spoke parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Spoke
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Spoke parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Spoke
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Spoke parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Spoke
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Spoke parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Spoke
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Spoke parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Spoke
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Spoke> parser()
Returns
TypeDescription
Parser<Spoke>

Methods

containsLabels(String key)

public boolean containsLabels(String key)

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

map<string, string> labels = 4;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public Spoke getDefaultInstanceForType()
Returns
TypeDescription
Spoke

getDescription()

public String getDescription()

An optional description of the spoke.

string description = 5;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

An optional description of the spoke.

string description = 5;

Returns
TypeDescription
ByteString

The bytes for description.

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
TypeDescription
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
TypeDescription
ByteString

The bytes for hub.

getLabels()

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

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

map<string, string> labels = 4;

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

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

map<string, string> labels = 4;

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

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

map<string, string> labels = 4;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

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

map<string, string> labels = 4;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getLinkedInterconnectAttachments()

public LinkedInterconnectAttachments getLinkedInterconnectAttachments()

VLAN attachments that are associated with the spoke.

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

Returns
TypeDescription
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
TypeDescription
LinkedInterconnectAttachmentsOrBuilder

getLinkedRouterApplianceInstances()

public LinkedRouterApplianceInstances getLinkedRouterApplianceInstances()

Router appliance instances that are associated with the spoke.

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

Returns
TypeDescription
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
TypeDescription
LinkedRouterApplianceInstancesOrBuilder

getLinkedVpnTunnels()

public LinkedVpnTunnels getLinkedVpnTunnels()

VPN tunnels that are associated with the spoke.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<Spoke> getParserForType()
Returns
TypeDescription
Parser<Spoke>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for uniqueId.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the linkedInterconnectAttachments 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
TypeDescription
boolean

Whether the linkedRouterApplianceInstances 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
TypeDescription
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
TypeDescription
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Spoke.Builder newBuilderForType()
Returns
TypeDescription
Spoke.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Spoke.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Spoke.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Spoke.Builder toBuilder()
Returns
TypeDescription
Spoke.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException