Class Hub (1.32.0)

public final class Hub extends GeneratedMessageV3 implements HubOrBuilder

A Network Connectivity Center hub is a global management resource to which you attach spokes. A single hub can contain spokes from multiple regions. However, if any of a hub's spokes use the site-to-site data transfer feature, the resources associated with those spokes must all be in the same VPC network. Spokes that do not use site-to-site data transfer can be associated with any VPC network in your project.

Protobuf type google.cloud.networkconnectivity.v1.Hub

Implements

HubOrBuilder

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

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

ROUTE_TABLES_FIELD_NUMBER

public static final int ROUTE_TABLES_FIELD_NUMBER
Field Value
TypeDescription
int

ROUTING_VPCS_FIELD_NUMBER

public static final int ROUTING_VPCS_FIELD_NUMBER
Field Value
TypeDescription
int

SPOKE_SUMMARY_FIELD_NUMBER

public static final int SPOKE_SUMMARY_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 Hub getDefaultInstance()
Returns
TypeDescription
Hub

getDescriptor()

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

newBuilder()

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

newBuilder(Hub prototype)

public static Hub.Builder newBuilder(Hub prototype)
Parameter
NameDescription
prototypeHub
Returns
TypeDescription
Hub.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

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
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 hub 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 hub was created.

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

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

public Hub getDefaultInstanceForType()
Returns
TypeDescription
Hub

getDescription()

public String getDescription()

An optional description of the hub.

string description = 5;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

An optional description of the hub.

string description = 5;

Returns
TypeDescription
ByteString

The bytes for description.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
String

getName()

public String getName()

Immutable. The name of the hub. Hub names must be unique. They use the following form: projects/{project_number}/locations/global/hubs/{hub_id}

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

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Immutable. The name of the hub. Hub names must be unique. They use the following form: projects/{project_number}/locations/global/hubs/{hub_id}

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

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

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

getRouteTables(int index)

public String getRouteTables(int index)

Output only. The route tables that belong to this hub. They use the following form: projects/{project_number}/locations/global/hubs/{hub_id}/routeTables/{route_table_id}

This field is read-only. Network Connectivity Center automatically populates it based on the route tables nested under the hub.

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

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The routeTables at the given index.

getRouteTablesBytes(int index)

public ByteString getRouteTablesBytes(int index)

Output only. The route tables that belong to this hub. They use the following form: projects/{project_number}/locations/global/hubs/{hub_id}/routeTables/{route_table_id}

This field is read-only. Network Connectivity Center automatically populates it based on the route tables nested under the hub.

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

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the routeTables at the given index.

getRouteTablesCount()

public int getRouteTablesCount()

Output only. The route tables that belong to this hub. They use the following form: projects/{project_number}/locations/global/hubs/{hub_id}/routeTables/{route_table_id}

This field is read-only. Network Connectivity Center automatically populates it based on the route tables nested under the hub.

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

Returns
TypeDescription
int

The count of routeTables.

getRouteTablesList()

public ProtocolStringList getRouteTablesList()

Output only. The route tables that belong to this hub. They use the following form: projects/{project_number}/locations/global/hubs/{hub_id}/routeTables/{route_table_id}

This field is read-only. Network Connectivity Center automatically populates it based on the route tables nested under the hub.

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

Returns
TypeDescription
ProtocolStringList

A list containing the routeTables.

getRoutingVpcs(int index)

public RoutingVPC getRoutingVpcs(int index)

The VPC networks associated with this hub's spokes.

This field is read-only. Network Connectivity Center automatically populates it based on the set of spokes attached to the hub.

repeated .google.cloud.networkconnectivity.v1.RoutingVPC routing_vpcs = 10;

Parameter
NameDescription
indexint
Returns
TypeDescription
RoutingVPC

getRoutingVpcsCount()

public int getRoutingVpcsCount()

The VPC networks associated with this hub's spokes.

This field is read-only. Network Connectivity Center automatically populates it based on the set of spokes attached to the hub.

repeated .google.cloud.networkconnectivity.v1.RoutingVPC routing_vpcs = 10;

Returns
TypeDescription
int

getRoutingVpcsList()

public List<RoutingVPC> getRoutingVpcsList()

The VPC networks associated with this hub's spokes.

This field is read-only. Network Connectivity Center automatically populates it based on the set of spokes attached to the hub.

repeated .google.cloud.networkconnectivity.v1.RoutingVPC routing_vpcs = 10;

Returns
TypeDescription
List<RoutingVPC>

getRoutingVpcsOrBuilder(int index)

public RoutingVPCOrBuilder getRoutingVpcsOrBuilder(int index)

The VPC networks associated with this hub's spokes.

This field is read-only. Network Connectivity Center automatically populates it based on the set of spokes attached to the hub.

repeated .google.cloud.networkconnectivity.v1.RoutingVPC routing_vpcs = 10;

Parameter
NameDescription
indexint
Returns
TypeDescription
RoutingVPCOrBuilder

getRoutingVpcsOrBuilderList()

public List<? extends RoutingVPCOrBuilder> getRoutingVpcsOrBuilderList()

The VPC networks associated with this hub's spokes.

This field is read-only. Network Connectivity Center automatically populates it based on the set of spokes attached to the hub.

repeated .google.cloud.networkconnectivity.v1.RoutingVPC routing_vpcs = 10;

Returns
TypeDescription
List<? extends com.google.cloud.networkconnectivity.v1.RoutingVPCOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSpokeSummary()

public SpokeSummary getSpokeSummary()

Output only. A summary of the spokes associated with a hub. The summary includes a count of spokes according to type and according to state. If any spokes are inactive, the summary also lists the reasons they are inactive, including a count for each reason.

.google.cloud.networkconnectivity.v1.SpokeSummary spoke_summary = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
SpokeSummary

The spokeSummary.

getSpokeSummaryOrBuilder()

public SpokeSummaryOrBuilder getSpokeSummaryOrBuilder()

Output only. A summary of the spokes associated with a hub. The summary includes a count of spokes according to type and according to state. If any spokes are inactive, the summary also lists the reasons they are inactive, including a count for each reason.

.google.cloud.networkconnectivity.v1.SpokeSummary spoke_summary = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
SpokeSummaryOrBuilder

getState()

public State getState()

Output only. The current lifecycle state of this hub.

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

Returns
TypeDescription
State

The state.

getStateValue()

public int getStateValue()

Output only. The current lifecycle state of this hub.

.google.cloud.networkconnectivity.v1.State state = 9 [(.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 hub. This value is unique across all hub resources. If a hub is deleted and another with the same name is created, the new hub is assigned a different unique_id.

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

Returns
TypeDescription
String

The uniqueId.

getUniqueIdBytes()

public ByteString getUniqueIdBytes()

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

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

Returns
TypeDescription
ByteString

The bytes for uniqueId.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The time the hub 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 hub 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 hub was created.

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

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasSpokeSummary()

public boolean hasSpokeSummary()

Output only. A summary of the spokes associated with a hub. The summary includes a count of spokes according to type and according to state. If any spokes are inactive, the summary also lists the reasons they are inactive, including a count for each reason.

.google.cloud.networkconnectivity.v1.SpokeSummary spoke_summary = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
boolean

Whether the spokeSummary field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The time the hub 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 Hub.Builder newBuilderForType()
Returns
TypeDescription
Hub.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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