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
Fields
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
Field Value
HUB_FIELD_NUMBER
public static final int HUB_FIELD_NUMBER
Field Value
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
Field Value
LINKED_INTERCONNECT_ATTACHMENTS_FIELD_NUMBER
public static final int LINKED_INTERCONNECT_ATTACHMENTS_FIELD_NUMBER
Field Value
LINKED_ROUTER_APPLIANCE_INSTANCES_FIELD_NUMBER
public static final int LINKED_ROUTER_APPLIANCE_INSTANCES_FIELD_NUMBER
Field Value
LINKED_VPN_TUNNELS_FIELD_NUMBER
public static final int LINKED_VPN_TUNNELS_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
Field Value
UNIQUE_ID_FIELD_NUMBER
public static final int UNIQUE_ID_FIELD_NUMBER
Field Value
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
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;
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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];
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The time the spoke was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstance()
public static Spoke getDefaultInstance()
Returns
getDefaultInstanceForType()
public Spoke getDefaultInstanceForType()
Returns
getDescription()
public String getDescription()
An optional description of the spoke.
string description = 5;
| Type | Description |
| String | The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
An optional description of the spoke.
string description = 5;
| Type | Description |
| ByteString | The bytes for description.
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
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) = { ... }
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) = { ... }
getLabels()
public Map<String,String> getLabels()
Returns
getLabelsCount()
public int getLabelsCount()
Optional labels in key:value format. For more information about labels, see
Requirements for
labels.
map<string, string> labels = 4;
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;
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;
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;
getLinkedInterconnectAttachments()
public LinkedInterconnectAttachments getLinkedInterconnectAttachments()
VLAN attachments that are associated with the spoke.
.google.cloud.networkconnectivity.v1.LinkedInterconnectAttachments linked_interconnect_attachments = 18;
getLinkedInterconnectAttachmentsOrBuilder()
public LinkedInterconnectAttachmentsOrBuilder getLinkedInterconnectAttachmentsOrBuilder()
VLAN attachments that are associated with the spoke.
.google.cloud.networkconnectivity.v1.LinkedInterconnectAttachments linked_interconnect_attachments = 18;
getLinkedRouterApplianceInstances()
public LinkedRouterApplianceInstances getLinkedRouterApplianceInstances()
Router appliance instances that are associated with the spoke.
.google.cloud.networkconnectivity.v1.LinkedRouterApplianceInstances linked_router_appliance_instances = 19;
getLinkedRouterApplianceInstancesOrBuilder()
public LinkedRouterApplianceInstancesOrBuilder getLinkedRouterApplianceInstancesOrBuilder()
Router appliance instances that are associated with the spoke.
.google.cloud.networkconnectivity.v1.LinkedRouterApplianceInstances linked_router_appliance_instances = 19;
getLinkedVpnTunnels()
public LinkedVpnTunnels getLinkedVpnTunnels()
VPN tunnels that are associated with the spoke.
.google.cloud.networkconnectivity.v1.LinkedVpnTunnels linked_vpn_tunnels = 17;
getLinkedVpnTunnelsOrBuilder()
public LinkedVpnTunnelsOrBuilder getLinkedVpnTunnelsOrBuilder()
VPN tunnels that are associated with the spoke.
.google.cloud.networkconnectivity.v1.LinkedVpnTunnels linked_vpn_tunnels = 17;
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];
| 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];
getParserForType()
public Parser<Spoke> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getState()
Output only. The current lifecycle state of this spoke.
.google.cloud.networkconnectivity.v1.State state = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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];
| 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];
| 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];
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
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];
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];
hasCreateTime()
public boolean hasCreateTime()
Output only. The time the spoke was created.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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;
| Type | Description |
| 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;
| Type | Description |
| 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;
| 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];
| Type | Description |
| boolean | Whether the updateTime field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilder()
public static Spoke.Builder newBuilder()
Returns
newBuilder(Spoke prototype)
public static Spoke.Builder newBuilder(Spoke prototype)
Parameter
| Name | Description |
| prototype | Spoke
|
Returns
newBuilderForType()
public Spoke.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Spoke.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public static Spoke parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Spoke parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Spoke parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Spoke parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Spoke parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Spoke parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Spoke parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Spoke parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Spoke parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Spoke parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Spoke parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Spoke parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Spoke> parser()
Returns
toBuilder()
public Spoke.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
