- 1.77.0 (latest)
 - 1.75.0
 - 1.74.0
 - 1.73.0
 - 1.72.0
 - 1.71.0
 - 1.69.0
 - 1.67.0
 - 1.66.0
 - 1.63.0
 - 1.62.0
 - 1.61.0
 - 1.59.0
 - 1.58.0
 - 1.57.0
 - 1.56.0
 - 1.55.0
 - 1.54.0
 - 1.53.0
 - 1.52.0
 - 1.51.0
 - 1.50.0
 - 1.48.0
 - 1.47.0
 - 1.46.0
 - 1.45.0
 - 1.44.0
 - 1.43.0
 - 1.42.0
 - 1.41.0
 - 1.40.0
 - 1.39.0
 - 1.38.0
 - 1.36.0
 - 1.35.0
 - 1.34.0
 - 1.33.0
 - 1.32.0
 - 1.31.0
 - 1.30.0
 - 1.29.0
 - 1.28.0
 - 1.27.0
 - 1.26.0
 - 1.23.0
 - 1.22.0
 - 1.21.0
 - 1.20.0
 - 1.19.0
 - 1.18.0
 - 1.17.0
 - 1.16.0
 - 1.15.0
 - 1.14.0
 - 1.13.0
 - 1.12.0
 - 1.11.0
 - 1.10.0
 - 1.8.0
 - 1.7.0
 - 1.6.0
 - 1.5.0
 - 1.4.0
 - 1.3.0
 - 1.2.9
 - 1.1.1
 - 1.0.0
 - 0.5.0
 
public interface RouteOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
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 = 6;
| Parameter | |
|---|---|
| Name | Description | 
key | 
        String | 
      
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        |
getCreateTime()
public abstract Timestamp getCreateTime()Output only. The time the route was created.
 .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
| Returns | |
|---|---|
| Type | Description | 
Timestamp | 
        The createTime.  | 
      
getCreateTimeOrBuilder()
public abstract TimestampOrBuilder getCreateTimeOrBuilder()Output only. The time the route was created.
 .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
| Returns | |
|---|---|
| Type | Description | 
TimestampOrBuilder | 
        |
getDescription()
public abstract String getDescription()An optional description of the route.
 string description = 7;
| Returns | |
|---|---|
| Type | Description | 
String | 
        The description.  | 
      
getDescriptionBytes()
public abstract ByteString getDescriptionBytes()An optional description of the route.
 string description = 7;
| Returns | |
|---|---|
| Type | Description | 
ByteString | 
        The bytes for description.  | 
      
getIpCidrRange()
public abstract String getIpCidrRange()The destination IP address range.
 string ip_cidr_range = 1;
| Returns | |
|---|---|
| Type | Description | 
String | 
        The ipCidrRange.  | 
      
getIpCidrRangeBytes()
public abstract ByteString getIpCidrRangeBytes()The destination IP address range.
 string ip_cidr_range = 1;
| Returns | |
|---|---|
| Type | Description | 
ByteString | 
        The bytes for ipCidrRange.  | 
      
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 = 6;
| 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 = 6;
| 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 = 6;
| 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 = 6;
| Parameter | |
|---|---|
| Name | Description | 
key | 
        String | 
      
| Returns | |
|---|---|
| Type | Description | 
String | 
        |
getLocation()
public abstract String getLocation()Output only. The location of the route. Uses the following form: "projects/{project}/locations/{location}" Example: projects/1234/locations/us-central1
 string location = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description | 
String | 
        The location.  | 
      
getLocationBytes()
public abstract ByteString getLocationBytes()Output only. The location of the route. Uses the following form: "projects/{project}/locations/{location}" Example: projects/1234/locations/us-central1
 string location = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description | 
ByteString | 
        The bytes for location.  | 
      
getName()
public abstract String getName() Immutable. The name of the route. Route names must be unique. Route names
 use the following form:
      projects/{project_number}/locations/global/hubs/{hub}/routeTables/{route_table_id}/routes/{route_id}
 string name = 3 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description | 
String | 
        The name.  | 
      
getNameBytes()
public abstract ByteString getNameBytes() Immutable. The name of the route. Route names must be unique. Route names
 use the following form:
      projects/{project_number}/locations/global/hubs/{hub}/routeTables/{route_table_id}/routes/{route_id}
 string name = 3 [(.google.api.field_behavior) = IMMUTABLE];
| Returns | |
|---|---|
| Type | Description | 
ByteString | 
        The bytes for name.  | 
      
getNextHopVpcNetwork()
public abstract NextHopVpcNetwork getNextHopVpcNetwork()Immutable. The destination VPC network for packets on this route.
 
 .google.cloud.networkconnectivity.v1.NextHopVpcNetwork next_hop_vpc_network = 2 [(.google.api.field_behavior) = IMMUTABLE];
 
| Returns | |
|---|---|
| Type | Description | 
NextHopVpcNetwork | 
        The nextHopVpcNetwork.  | 
      
getNextHopVpcNetworkOrBuilder()
public abstract NextHopVpcNetworkOrBuilder getNextHopVpcNetworkOrBuilder()Immutable. The destination VPC network for packets on this route.
 
 .google.cloud.networkconnectivity.v1.NextHopVpcNetwork next_hop_vpc_network = 2 [(.google.api.field_behavior) = IMMUTABLE];
 
| Returns | |
|---|---|
| Type | Description | 
NextHopVpcNetworkOrBuilder | 
        |
getSpoke()
public abstract String getSpoke()Immutable. The spoke that this route leads to. Example: projects/12345/locations/global/spokes/SPOKE
 
 string spoke = 11 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
 
| Returns | |
|---|---|
| Type | Description | 
String | 
        The spoke.  | 
      
getSpokeBytes()
public abstract ByteString getSpokeBytes()Immutable. The spoke that this route leads to. Example: projects/12345/locations/global/spokes/SPOKE
 
 string spoke = 11 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }
 
| Returns | |
|---|---|
| Type | Description | 
ByteString | 
        The bytes for spoke.  | 
      
getState()
public abstract State getState()Output only. The current lifecycle state of the route.
 
 .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 the route.
 
 .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.  | 
      
getType()
public abstract RouteType getType()Output only. The route's type. Its type is determined by the properties of its IP address range.
 
 .google.cloud.networkconnectivity.v1.RouteType type = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
| Returns | |
|---|---|
| Type | Description | 
RouteType | 
        The type.  | 
      
getTypeValue()
public abstract int getTypeValue()Output only. The route's type. Its type is determined by the properties of its IP address range.
 
 .google.cloud.networkconnectivity.v1.RouteType type = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
| Returns | |
|---|---|
| Type | Description | 
int | 
        The enum numeric value on the wire for type.  | 
      
getUid()
public abstract String getUid() Output only. The Google-generated UUID for the route. This value is unique
 across all Network Connectivity Center route resources. If a
 route is deleted and another with the same name is created,
 the new route is assigned a different uid.
 string uid = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description | 
String | 
        The uid.  | 
      
getUidBytes()
public abstract ByteString getUidBytes() Output only. The Google-generated UUID for the route. This value is unique
 across all Network Connectivity Center route resources. If a
 route is deleted and another with the same name is created,
 the new route is assigned a different uid.
 string uid = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description | 
ByteString | 
        The bytes for uid.  | 
      
getUpdateTime()
public abstract Timestamp getUpdateTime()Output only. The time the route was last updated.
 .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
| Returns | |
|---|---|
| Type | Description | 
Timestamp | 
        The updateTime.  | 
      
getUpdateTimeOrBuilder()
public abstract TimestampOrBuilder getUpdateTimeOrBuilder()Output only. The time the route was last updated.
 .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
| Returns | |
|---|---|
| Type | Description | 
TimestampOrBuilder | 
        |
hasCreateTime()
public abstract boolean hasCreateTime()Output only. The time the route was created.
 .google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        Whether the createTime field is set.  | 
      
hasNextHopVpcNetwork()
public abstract boolean hasNextHopVpcNetwork()Immutable. The destination VPC network for packets on this route.
 
 .google.cloud.networkconnectivity.v1.NextHopVpcNetwork next_hop_vpc_network = 2 [(.google.api.field_behavior) = IMMUTABLE];
 
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        Whether the nextHopVpcNetwork field is set.  | 
      
hasUpdateTime()
public abstract boolean hasUpdateTime()Output only. The time the route was last updated.
 .google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
 
| Returns | |
|---|---|
| Type | Description | 
boolean | 
        Whether the updateTime field is set.  |