Interface SpokeOrBuilder (1.54.0) 

public interface SpokeOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract 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

getCreateTime()

public abstract 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 abstract 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

getDescription()

public abstract String getDescription()

An optional description of the spoke.

string description = 5;

Returns
Type Description
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

An optional description of the spoke.

string description = 5;

Returns
Type Description
ByteString

The bytes for description.

getGroup()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getReasons(int index)

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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>

getSpokeType()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.