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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
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 | |
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ROUTE_TABLES_FIELD_NUMBER
public static final int ROUTE_TABLES_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ROUTING_VPCS_FIELD_NUMBER
public static final int ROUTING_VPCS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SPOKE_SUMMARY_FIELD_NUMBER
public static final int SPOKE_SUMMARY_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 Hub getDefaultInstance()
| Returns |
|---|
| Type | Description |
Hub | |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Hub.Builder newBuilder()
newBuilder(Hub prototype)
public static Hub.Builder newBuilder(Hub prototype)
| Parameter |
|---|
| Name | Description |
prototype | Hub
|
public static Hub parseDelimitedFrom(InputStream input)
| Returns |
|---|
| Type | Description |
Hub | |
public static Hub parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Hub | |
parseFrom(byte[] data)
public static Hub parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
| Returns |
|---|
| Type | Description |
Hub | |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Hub parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Hub | |
parseFrom(ByteString data)
public static Hub parseFrom(ByteString data)
| Returns |
|---|
| Type | Description |
Hub | |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Hub parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Hub | |
public static Hub parseFrom(CodedInputStream input)
| Returns |
|---|
| Type | Description |
Hub | |
public static Hub parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Hub | |
public static Hub parseFrom(InputStream input)
| Returns |
|---|
| Type | Description |
Hub | |
public static Hub parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Hub | |
parseFrom(ByteBuffer data)
public static Hub parseFrom(ByteBuffer data)
| Returns |
|---|
| Type | Description |
Hub | |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Hub parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
| Returns |
|---|
| Type | Description |
Hub | |
parser()
public static Parser<Hub> parser()
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 |
|---|
| Name | Description |
key | String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
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 |
|---|
| Type | Description |
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];
getDefaultInstanceForType()
public Hub getDefaultInstanceForType()
| Returns |
|---|
| Type | Description |
Hub | |
getDescription()
public String getDescription()
An optional description of the hub.
string description = 5;
| Returns |
|---|
| Type | Description |
String | The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
An optional description of the hub.
string description = 5;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for description.
|
getLabels() (deprecated)
public Map<String,String> getLabels()
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 |
|---|
| Type | Description |
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;
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;
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 |
|---|
| Name | Description |
key | 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 |
|---|
| Type | Description |
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 |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getParserForType()
public Parser<Hub> getParserForType()
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 |
|---|
| Name | Description |
index | int
The index of the element to return.
|
| Returns |
|---|
| Type | Description |
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 |
|---|
| Name | Description |
index | int
The index of the value to return.
|
| Returns |
|---|
| Type | Description |
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 |
|---|
| Type | Description |
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];
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 |
|---|
| Name | Description |
index | int
|
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 |
|---|
| Type | Description |
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;
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 |
|---|
| Name | Description |
index | int
|
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 |
|---|
| Type | Description |
List<? extends com.google.cloud.networkconnectivity.v1.RoutingVPCOrBuilder> | |
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
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];
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];
getState()
Output only. The current lifecycle state of this hub.
.google.cloud.networkconnectivity.v1.State state = 9 [(.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.v1.State state = 9 [(.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. 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 |
|---|
| Type | Description |
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 |
|---|
| Type | Description |
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 |
|---|
| Type | Description |
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];
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 |
|---|
| Type | Description |
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 |
|---|
| Type | Description |
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 |
|---|
| Type | Description |
boolean | Whether the updateTime field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
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()
Overrides
newBuilderForType()
public Hub.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Hub.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Hub.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
