public final class Route extends GeneratedMessageV3 implements RouteOrBuilder
A route defines a path from VM instances within a spoke to a specific
destination resource. Only VPC spokes have routes.
Protobuf type google.cloud.networkconnectivity.v1.Route
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 |
|
IP_CIDR_RANGE_FIELD_NUMBER
public static final int IP_CIDR_RANGE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
LOCATION_FIELD_NUMBER
public static final int LOCATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NEXT_HOP_INTERCONNECT_ATTACHMENT_FIELD_NUMBER
public static final int NEXT_HOP_INTERCONNECT_ATTACHMENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NEXT_HOP_ROUTER_APPLIANCE_INSTANCE_FIELD_NUMBER
public static final int NEXT_HOP_ROUTER_APPLIANCE_INSTANCE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NEXT_HOP_VPC_NETWORK_FIELD_NUMBER
public static final int NEXT_HOP_VPC_NETWORK_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NEXT_HOP_VPN_TUNNEL_FIELD_NUMBER
public static final int NEXT_HOP_VPN_TUNNEL_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PRIORITY_FIELD_NUMBER
public static final int PRIORITY_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SPOKE_FIELD_NUMBER
public static final int SPOKE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UID_FIELD_NUMBER
public static final int UID_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 Route getDefaultInstance()
| Returns |
| Type |
Description |
Route |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Route.Builder newBuilder()
newBuilder(Route prototype)
public static Route.Builder newBuilder(Route prototype)
| Parameter |
| Name |
Description |
prototype |
Route
|
public static Route parseDelimitedFrom(InputStream input)
| Returns |
| Type |
Description |
Route |
|
public static Route parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Route |
|
parseFrom(byte[] data)
public static Route parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
| Returns |
| Type |
Description |
Route |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Route parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Route |
|
parseFrom(ByteString data)
public static Route parseFrom(ByteString data)
| Returns |
| Type |
Description |
Route |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Route parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Route |
|
public static Route parseFrom(CodedInputStream input)
| Returns |
| Type |
Description |
Route |
|
public static Route parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Route |
|
public static Route parseFrom(InputStream input)
| Returns |
| Type |
Description |
Route |
|
public static Route parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Route |
|
parseFrom(ByteBuffer data)
public static Route parseFrom(ByteBuffer data)
| Returns |
| Type |
Description |
Route |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Route parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Route |
|
parser()
public static Parser<Route> 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 = 6;
| 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 route was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
Timestamp |
The createTime.
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The time the route was created.
.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public Route getDefaultInstanceForType()
| Returns |
| Type |
Description |
Route |
|
getDescription()
public String getDescription()
An optional description of the route.
string description = 7;
| Returns |
| Type |
Description |
String |
The description.
|
getDescriptionBytes()
public ByteString getDescriptionBytes()
An optional description of the route.
string description = 7;
| Returns |
| Type |
Description |
ByteString |
The bytes for description.
|
getIpCidrRange()
public String getIpCidrRange()
The destination IP address range.
string ip_cidr_range = 1;
| Returns |
| Type |
Description |
String |
The ipCidrRange.
|
getIpCidrRangeBytes()
public ByteString getIpCidrRangeBytes()
The destination IP address range.
string ip_cidr_range = 1;
| Returns |
| Type |
Description |
ByteString |
The bytes for ipCidrRange.
|
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 = 6;
| 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 = 6;
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 = 6;
| Returns |
| Type |
Description |
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 = 6;
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
String |
|
getLocation()
public String getLocation()
Output only. The origin 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 ByteString getLocationBytes()
Output only. The origin 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()
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 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.
|
getNextHopInterconnectAttachment()
public NextHopInterconnectAttachment getNextHopInterconnectAttachment()
Immutable. The next-hop VLAN attachment for packets on this route.
.google.cloud.networkconnectivity.v1.NextHopInterconnectAttachment next_hop_interconnect_attachment = 16 [(.google.api.field_behavior) = IMMUTABLE];
getNextHopInterconnectAttachmentOrBuilder()
public NextHopInterconnectAttachmentOrBuilder getNextHopInterconnectAttachmentOrBuilder()
Immutable. The next-hop VLAN attachment for packets on this route.
.google.cloud.networkconnectivity.v1.NextHopInterconnectAttachment next_hop_interconnect_attachment = 16 [(.google.api.field_behavior) = IMMUTABLE];
getNextHopRouterApplianceInstance()
public NextHopRouterApplianceInstance getNextHopRouterApplianceInstance()
Immutable. The next-hop Router appliance instance for packets on this
route.
.google.cloud.networkconnectivity.v1.NextHopRouterApplianceInstance next_hop_router_appliance_instance = 15 [(.google.api.field_behavior) = IMMUTABLE];
getNextHopRouterApplianceInstanceOrBuilder()
public NextHopRouterApplianceInstanceOrBuilder getNextHopRouterApplianceInstanceOrBuilder()
Immutable. The next-hop Router appliance instance for packets on this
route.
.google.cloud.networkconnectivity.v1.NextHopRouterApplianceInstance next_hop_router_appliance_instance = 15 [(.google.api.field_behavior) = IMMUTABLE];
getNextHopVpcNetwork()
public 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];
getNextHopVpcNetworkOrBuilder()
public 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];
getNextHopVpnTunnel()
public NextHopVPNTunnel getNextHopVpnTunnel()
Immutable. The next-hop VPN tunnel for packets on this route.
.google.cloud.networkconnectivity.v1.NextHopVPNTunnel next_hop_vpn_tunnel = 14 [(.google.api.field_behavior) = IMMUTABLE];
getNextHopVpnTunnelOrBuilder()
public NextHopVPNTunnelOrBuilder getNextHopVpnTunnelOrBuilder()
Immutable. The next-hop VPN tunnel for packets on this route.
.google.cloud.networkconnectivity.v1.NextHopVPNTunnel next_hop_vpn_tunnel = 14 [(.google.api.field_behavior) = IMMUTABLE];
getParserForType()
public Parser<Route> getParserForType()
Overrides
getPriority()
public long getPriority()
Output only. The priority of this route. Priority is used to break ties in
cases where a destination matches more than one route. In these cases the
route with the lowest-numbered priority value wins.
int64 priority = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
| Type |
Description |
long |
The priority.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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 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()
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 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 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];
getTypeValue()
public 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()
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 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 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 TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The time the route was last updated.
.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime()
public 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.
|
hasNextHopInterconnectAttachment()
public boolean hasNextHopInterconnectAttachment()
Immutable. The next-hop VLAN attachment for packets on this route.
.google.cloud.networkconnectivity.v1.NextHopInterconnectAttachment next_hop_interconnect_attachment = 16 [(.google.api.field_behavior) = IMMUTABLE];
| Returns |
| Type |
Description |
boolean |
Whether the nextHopInterconnectAttachment field is set.
|
hasNextHopRouterApplianceInstance()
public boolean hasNextHopRouterApplianceInstance()
Immutable. The next-hop Router appliance instance for packets on this
route.
.google.cloud.networkconnectivity.v1.NextHopRouterApplianceInstance next_hop_router_appliance_instance = 15 [(.google.api.field_behavior) = IMMUTABLE];
| Returns |
| Type |
Description |
boolean |
Whether the nextHopRouterApplianceInstance field is set.
|
hasNextHopVpcNetwork()
public 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.
|
hasNextHopVpnTunnel()
public boolean hasNextHopVpnTunnel()
Immutable. The next-hop VPN tunnel for packets on this route.
.google.cloud.networkconnectivity.v1.NextHopVPNTunnel next_hop_vpn_tunnel = 14 [(.google.api.field_behavior) = IMMUTABLE];
| Returns |
| Type |
Description |
boolean |
Whether the nextHopVpnTunnel field is set.
|
hasUpdateTime()
public 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.
|
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 Route.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Route.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public Route.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
