Class Spoke (1.44.0)

public final class Spoke extends GeneratedMessageV3 implements SpokeOrBuilder

A Spoke is an abstraction of a network attachment being attached to a Hub. A Spoke can be underlying a VPN tunnel, a VLAN (interconnect) attachment, a Router appliance, etc.

Protobuf type google.cloud.networkconnectivity.v1alpha1.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

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_ROUTER_APPLIANCE_INSTANCES_FIELD_NUMBER

public static final int LINKED_ROUTER_APPLIANCE_INSTANCES_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

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)

User-defined 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()

The time when the Spoke was created.

.google.protobuf.Timestamp create_time = 2;

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

The time when the Spoke was created.

.google.protobuf.Timestamp create_time = 2;

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Spoke getDefaultInstanceForType()
Returns
Type Description
Spoke

getDescription()

public String getDescription()

Short description of the spoke resource

string description = 5;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Short description of the spoke resource

string description = 5;

Returns
Type Description
ByteString

The bytes for description.

getHub()

public String getHub()

The resource URL of the hub resource that the spoke is attached to

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

Returns
Type Description
String

The hub.

getHubBytes()

public ByteString getHubBytes()

The resource URL of the hub resource that the spoke is attached to

string hub = 6 [(.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()

User-defined labels.

map<string, string> labels = 4;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

User-defined labels.

map<string, string> labels = 4;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

User-defined 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)

User-defined labels.

map<string, string> labels = 4;

Parameter
Name Description
key String
Returns
Type Description
String

getLinkedInterconnectAttachments(int index)

public String getLinkedInterconnectAttachments(int index)

The URIs of linked interconnect attachment resources

repeated string linked_interconnect_attachments = 13 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The linkedInterconnectAttachments at the given index.

getLinkedInterconnectAttachmentsBytes(int index)

public ByteString getLinkedInterconnectAttachmentsBytes(int index)

The URIs of linked interconnect attachment resources

repeated string linked_interconnect_attachments = 13 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the linkedInterconnectAttachments at the given index.

getLinkedInterconnectAttachmentsCount()

public int getLinkedInterconnectAttachmentsCount()

The URIs of linked interconnect attachment resources

repeated string linked_interconnect_attachments = 13 [(.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of linkedInterconnectAttachments.

getLinkedInterconnectAttachmentsList()

public ProtocolStringList getLinkedInterconnectAttachmentsList()

The URIs of linked interconnect attachment resources

repeated string linked_interconnect_attachments = 13 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the linkedInterconnectAttachments.

getLinkedRouterApplianceInstances(int index)

public RouterApplianceInstance getLinkedRouterApplianceInstances(int index)

The URIs of linked Router appliance resources

repeated .google.cloud.networkconnectivity.v1alpha1.RouterApplianceInstance linked_router_appliance_instances = 14;

Parameter
Name Description
index int
Returns
Type Description
RouterApplianceInstance

getLinkedRouterApplianceInstancesCount()

public int getLinkedRouterApplianceInstancesCount()

The URIs of linked Router appliance resources

repeated .google.cloud.networkconnectivity.v1alpha1.RouterApplianceInstance linked_router_appliance_instances = 14;

Returns
Type Description
int

getLinkedRouterApplianceInstancesList()

public List<RouterApplianceInstance> getLinkedRouterApplianceInstancesList()

The URIs of linked Router appliance resources

repeated .google.cloud.networkconnectivity.v1alpha1.RouterApplianceInstance linked_router_appliance_instances = 14;

Returns
Type Description
List<RouterApplianceInstance>

getLinkedRouterApplianceInstancesOrBuilder(int index)

public RouterApplianceInstanceOrBuilder getLinkedRouterApplianceInstancesOrBuilder(int index)

The URIs of linked Router appliance resources

repeated .google.cloud.networkconnectivity.v1alpha1.RouterApplianceInstance linked_router_appliance_instances = 14;

Parameter
Name Description
index int
Returns
Type Description
RouterApplianceInstanceOrBuilder

getLinkedRouterApplianceInstancesOrBuilderList()

public List<? extends RouterApplianceInstanceOrBuilder> getLinkedRouterApplianceInstancesOrBuilderList()

The URIs of linked Router appliance resources

repeated .google.cloud.networkconnectivity.v1alpha1.RouterApplianceInstance linked_router_appliance_instances = 14;

Returns
Type Description
List<? extends com.google.cloud.networkconnectivity.v1alpha1.RouterApplianceInstanceOrBuilder>

getLinkedVpnTunnels(int index)

public String getLinkedVpnTunnels(int index)

The URIs of linked VPN tunnel resources

repeated string linked_vpn_tunnels = 12 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The linkedVpnTunnels at the given index.

getLinkedVpnTunnelsBytes(int index)

public ByteString getLinkedVpnTunnelsBytes(int index)

The URIs of linked VPN tunnel resources

repeated string linked_vpn_tunnels = 12 [(.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the linkedVpnTunnels at the given index.

getLinkedVpnTunnelsCount()

public int getLinkedVpnTunnelsCount()

The URIs of linked VPN tunnel resources

repeated string linked_vpn_tunnels = 12 [(.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of linkedVpnTunnels.

getLinkedVpnTunnelsList()

public ProtocolStringList getLinkedVpnTunnelsList()

The URIs of linked VPN tunnel resources

repeated string linked_vpn_tunnels = 12 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the linkedVpnTunnels.

getName()

public String getName()

Immutable. The name of a Spoke resource.

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Immutable. The name of a Spoke resource.

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

public State getState()

Output only. The current lifecycle state of this Hub.

.google.cloud.networkconnectivity.v1alpha1.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 Hub.

.google.cloud.networkconnectivity.v1alpha1.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. Google-generated UUID for this resource. This is unique across all Spoke resources. If a Spoke resource is deleted and another with the same name is created, it gets 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. Google-generated UUID for this resource. This is unique across all Spoke resources. If a Spoke resource is deleted and another with the same name is created, it gets 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()

The time when the Spoke was updated.

.google.protobuf.Timestamp update_time = 3;

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

The time when the Spoke was updated.

.google.protobuf.Timestamp update_time = 3;

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

The time when the Spoke was created.

.google.protobuf.Timestamp create_time = 2;

Returns
Type Description
boolean

Whether the createTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

The time when the Spoke was updated.

.google.protobuf.Timestamp update_time = 3;

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