Interface HubOrBuilder (1.54.0) 

public interface HubOrBuilder 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 hub 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 hub 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 hub.

string description = 5;

Returns
Type Description
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

An optional description of the hub.

string description = 5;

Returns
Type Description
ByteString

The bytes for description.

getExportPsc()

public abstract boolean getExportPsc()

Optional. Whether Private Service Connect transitivity is enabled for the hub. If true, Private Service Connect endpoints in VPC spokes attached to the hub are made accessible to other VPC spokes attached to the hub. The default value is false.

optional bool export_psc = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The exportPsc.

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

getName()

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

getPolicyMode()

public abstract PolicyMode getPolicyMode()

Optional. The policy mode of this hub. This field can be either PRESET or CUSTOM. If unspecified, the policy_mode defaults to PRESET.

.google.cloud.networkconnectivity.v1.PolicyMode policy_mode = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PolicyMode

The policyMode.

getPolicyModeValue()

public abstract int getPolicyModeValue()

Optional. The policy mode of this hub. This field can be either PRESET or CUSTOM. If unspecified, the policy_mode defaults to PRESET.

.google.cloud.networkconnectivity.v1.PolicyMode policy_mode = 13 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for policyMode.

getPresetTopology()

public abstract PresetTopology getPresetTopology()

Optional. The topology implemented in this hub. Currently, this field is only used when policy_mode = PRESET. The available preset topologies are MESH and STAR. If preset_topology is unspecified and policy_mode = PRESET, the preset_topology defaults to MESH. When policy_mode = CUSTOM, the preset_topology is set to PRESET_TOPOLOGY_UNSPECIFIED.

.google.cloud.networkconnectivity.v1.PresetTopology preset_topology = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
PresetTopology

The presetTopology.

getPresetTopologyValue()

public abstract int getPresetTopologyValue()

Optional. The topology implemented in this hub. Currently, this field is only used when policy_mode = PRESET. The available preset topologies are MESH and STAR. If preset_topology is unspecified and policy_mode = PRESET, the preset_topology defaults to MESH. When policy_mode = CUSTOM, the preset_topology is set to PRESET_TOPOLOGY_UNSPECIFIED.

.google.cloud.networkconnectivity.v1.PresetTopology preset_topology = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for presetTopology.

getRouteTables(int index)

public abstract 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 abstract 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 abstract 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 abstract List<String> 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
Type Description
List<String>

A list containing the routeTables.

getRoutingVpcs(int index)

public abstract 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
Returns
Type Description
RoutingVPC

getRoutingVpcsCount()

public abstract 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 abstract 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
Type Description
List<RoutingVPC>

getRoutingVpcsOrBuilder(int index)

public abstract 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
Returns
Type Description
RoutingVPCOrBuilder

getRoutingVpcsOrBuilderList()

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

getSpokeSummary()

public abstract 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
Type Description
SpokeSummary

The spokeSummary.

getSpokeSummaryOrBuilder()

public abstract 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
Type Description
SpokeSummaryOrBuilder

getState()

public abstract 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
Type Description
State

The state.

getStateValue()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract TimestampOrBuilder getUpdateTimeOrBuilder()

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

hasExportPsc()

public abstract boolean hasExportPsc()

Optional. Whether Private Service Connect transitivity is enabled for the hub. If true, Private Service Connect endpoints in VPC spokes attached to the hub are made accessible to other VPC spokes attached to the hub. The default value is false.

optional bool export_psc = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the exportPsc field is set.

hasSpokeSummary()

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