Class Route (1.30.0)

public final class Route extends GeneratedMessageV3 implements RouteOrBuilder

Represents a Route resource. A route defines a path from VM instances in the VPC network to a specific destination. This destination can be inside or outside the VPC network. For more information, read the Routes overview.

Protobuf type google.cloud.compute.v1.Route

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Route

Implements

RouteOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

AS_PATHS_FIELD_NUMBER

public static final int AS_PATHS_FIELD_NUMBER

Field Value
Type	Description
`int`

CREATION_TIMESTAMP_FIELD_NUMBER

public static final int CREATION_TIMESTAMP_FIELD_NUMBER

Field Value
Type	Description
`int`

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER

Field Value
Type	Description
`int`

DEST_RANGE_FIELD_NUMBER

public static final int DEST_RANGE_FIELD_NUMBER

Field Value
Type	Description
`int`

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER

Field Value
Type	Description
`int`

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER

Field Value
Type	Description
`int`

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value
Type	Description
`int`

NETWORK_FIELD_NUMBER

public static final int NETWORK_FIELD_NUMBER

Field Value
Type	Description
`int`

NEXT_HOP_GATEWAY_FIELD_NUMBER

public static final int NEXT_HOP_GATEWAY_FIELD_NUMBER

Field Value
Type	Description
`int`

NEXT_HOP_ILB_FIELD_NUMBER

public static final int NEXT_HOP_ILB_FIELD_NUMBER

Field Value
Type	Description
`int`

NEXT_HOP_INSTANCE_FIELD_NUMBER

public static final int NEXT_HOP_INSTANCE_FIELD_NUMBER

Field Value
Type	Description
`int`

NEXT_HOP_IP_FIELD_NUMBER

public static final int NEXT_HOP_IP_FIELD_NUMBER

Field Value
Type	Description
`int`

NEXT_HOP_NETWORK_FIELD_NUMBER

public static final int NEXT_HOP_NETWORK_FIELD_NUMBER

Field Value
Type	Description
`int`

NEXT_HOP_PEERING_FIELD_NUMBER

public static final int NEXT_HOP_PEERING_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`

ROUTE_STATUS_FIELD_NUMBER

public static final int ROUTE_STATUS_FIELD_NUMBER

Field Value
Type	Description
`int`

ROUTE_TYPE_FIELD_NUMBER

public static final int ROUTE_TYPE_FIELD_NUMBER

Field Value
Type	Description
`int`

SELF_LINK_FIELD_NUMBER

public static final int SELF_LINK_FIELD_NUMBER

Field Value
Type	Description
`int`

TAGS_FIELD_NUMBER

public static final int TAGS_FIELD_NUMBER

Field Value
Type	Description
`int`

WARNINGS_FIELD_NUMBER

public static final int WARNINGS_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()

Returns
Type	Description
`Descriptor`

newBuilder()

public static Route.Builder newBuilder()

Returns
Type	Description
`Route.Builder`

newBuilder(Route prototype)

public static Route.Builder newBuilder(Route prototype)

Parameter
Name	Description
`prototype`	`Route`

Returns
Type	Description
`Route.Builder`

parseDelimitedFrom(InputStream input)

public static Route parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`Route`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Route parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Route`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static Route parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`Route`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Route parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Route`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static Route parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`Route`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Route parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Route`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static Route parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`Route`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Route parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Route`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static Route parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`Route`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Route parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Route`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static Route parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`Route`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Route parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Route`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<Route> parser()

Returns
Type	Description
`Parser<Route>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

getAsPaths(int index)

public RouteAsPath getAsPaths(int index)

[Output Only] AS path.

repeated .google.cloud.compute.v1.RouteAsPath as_paths = 137568929;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`RouteAsPath`

getAsPathsCount()

public int getAsPathsCount()

[Output Only] AS path.

repeated .google.cloud.compute.v1.RouteAsPath as_paths = 137568929;

Returns
Type	Description
`int`

getAsPathsList()

public List<RouteAsPath> getAsPathsList()

[Output Only] AS path.

repeated .google.cloud.compute.v1.RouteAsPath as_paths = 137568929;

Returns
Type	Description
`List<RouteAsPath>`

getAsPathsOrBuilder(int index)

public RouteAsPathOrBuilder getAsPathsOrBuilder(int index)

[Output Only] AS path.

repeated .google.cloud.compute.v1.RouteAsPath as_paths = 137568929;

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`RouteAsPathOrBuilder`

getAsPathsOrBuilderList()

public List<? extends RouteAsPathOrBuilder> getAsPathsOrBuilderList()

[Output Only] AS path.

repeated .google.cloud.compute.v1.RouteAsPath as_paths = 137568929;

Returns
Type	Description
`List<? extends com.google.cloud.compute.v1.RouteAsPathOrBuilder>`

getCreationTimestamp()

public String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type	Description
`String`	The creationTimestamp.

getCreationTimestampBytes()

public ByteString getCreationTimestampBytes()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type	Description
`ByteString`	The bytes for creationTimestamp.

getDefaultInstanceForType()

public Route getDefaultInstanceForType()

Returns
Type	Description
`Route`

getDescription()

public String getDescription()

An optional description of this resource. Provide this field when you create the resource.

optional string description = 422937596;

Returns
Type	Description
`String`	The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

An optional description of this resource. Provide this field when you create the resource.

optional string description = 422937596;

Returns
Type	Description
`ByteString`	The bytes for description.

getDestRange()

public String getDestRange()

The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported.

optional string dest_range = 381327712;

Returns
Type	Description
`String`	The destRange.

getDestRangeBytes()

public ByteString getDestRangeBytes()

The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported.

optional string dest_range = 381327712;

Returns
Type	Description
`ByteString`	The bytes for destRange.

getId()

public long getId()

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
Type	Description
`long`	The id.

getKind()

public String getKind()

[Output Only] Type of this resource. Always compute#routes for Route resources.

optional string kind = 3292052;

Returns
Type	Description
`String`	The kind.

getKindBytes()

public ByteString getKindBytes()

[Output Only] Type of this resource. Always compute#routes for Route resources.

optional string kind = 3292052;

Returns
Type	Description
`ByteString`	The bytes for kind.

getName()

public String getName()

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression a-z?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit.

optional string name = 3373707;

Returns
Type	Description
`String`	The name.

getNameBytes()

public ByteString getNameBytes()

optional string name = 3373707;

Returns
Type	Description
`ByteString`	The bytes for name.

getNetwork()

public String getNetwork()

Fully-qualified URL of the network that this route applies to.

optional string network = 232872494;

Returns
Type	Description
`String`	The network.

getNetworkBytes()

public ByteString getNetworkBytes()

Fully-qualified URL of the network that this route applies to.

optional string network = 232872494;

Returns
Type	Description
`ByteString`	The bytes for network.

getNextHopGateway()

public String getNextHopGateway()

The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/ project/global/gateways/default-internet-gateway

optional string next_hop_gateway = 377175298;

Returns
Type	Description
`String`	The nextHopGateway.

getNextHopGatewayBytes()

public ByteString getNextHopGatewayBytes()

The URL to a gateway that should handle matching packets. You can only specify the internet gateway using a full or partial valid URL: projects/ project/global/gateways/default-internet-gateway

optional string next_hop_gateway = 377175298;

Returns
Type	Description
`ByteString`	The bytes for nextHopGateway.

getNextHopIlb()

public String getNextHopIlb()

The URL to a forwarding rule of type loadBalancingScheme=INTERNAL that should handle matching packets or the IP address of the forwarding Rule. For example, the following are all valid URLs: - 10.128.0.56 - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule

optional string next_hop_ilb = 198679901;

Returns
Type	Description
`String`	The nextHopIlb.

getNextHopIlbBytes()

public ByteString getNextHopIlbBytes()

optional string next_hop_ilb = 198679901;

Returns
Type	Description
`ByteString`	The bytes for nextHopIlb.

getNextHopInstance()

public String getNextHopInstance()

The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/

optional string next_hop_instance = 393508247;

Returns
Type	Description
`String`	The nextHopInstance.

getNextHopInstanceBytes()

public ByteString getNextHopInstanceBytes()

The URL to an instance that should handle matching packets. You can specify this as a full or partial URL. For example: https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/

optional string next_hop_instance = 393508247;

Returns
Type	Description
`ByteString`	The bytes for nextHopInstance.

getNextHopIp()

public String getNextHopIp()

The network IP address of an instance that should handle matching packets. Only IPv4 is supported.

optional string next_hop_ip = 110319529;

Returns
Type	Description
`String`	The nextHopIp.

getNextHopIpBytes()

public ByteString getNextHopIpBytes()

The network IP address of an instance that should handle matching packets. Only IPv4 is supported.

optional string next_hop_ip = 110319529;

Returns
Type	Description
`ByteString`	The bytes for nextHopIp.

getNextHopNetwork()

public String getNextHopNetwork()

The URL of the local network if it should handle matching packets.

optional string next_hop_network = 262295788;

Returns
Type	Description
`String`	The nextHopNetwork.

getNextHopNetworkBytes()

public ByteString getNextHopNetworkBytes()

The URL of the local network if it should handle matching packets.

optional string next_hop_network = 262295788;

Returns
Type	Description
`ByteString`	The bytes for nextHopNetwork.

getNextHopPeering()

public String getNextHopPeering()

[Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.

optional string next_hop_peering = 412682750;

Returns
Type	Description
`String`	The nextHopPeering.

getNextHopPeeringBytes()

public ByteString getNextHopPeeringBytes()

[Output Only] The network peering name that should handle matching packets, which should conform to RFC1035.

optional string next_hop_peering = 412682750;

Returns
Type	Description
`ByteString`	The bytes for nextHopPeering.

getNextHopVpnTunnel()

public String getNextHopVpnTunnel()

The URL to a VpnTunnel that should handle matching packets.

optional string next_hop_vpn_tunnel = 519844501;

Returns
Type	Description
`String`	The nextHopVpnTunnel.

getNextHopVpnTunnelBytes()

public ByteString getNextHopVpnTunnelBytes()

The URL to a VpnTunnel that should handle matching packets.

optional string next_hop_vpn_tunnel = 519844501;

Returns
Type	Description
`ByteString`	The bytes for nextHopVpnTunnel.

getParserForType()

public Parser<Route> getParserForType()

Returns
Type	Description
`Parser<Route>`

Overrides

GeneratedMessageV3.getParserForType()

getPriority()

public int getPriority()

The priority of this route. Priority is used to break ties in cases where there is more than one matching route of equal prefix length. In cases where multiple routes have equal prefix length, the one with the lowest-numbered priority value wins. The default value is 1000. The priority value must be from 0 to 65535, inclusive.

optional uint32 priority = 445151652;

Returns
Type	Description
`int`	The priority.

getRouteStatus()

public String getRouteStatus()

[Output only] The status of the route. Check the RouteStatus enum for the list of possible values.

optional string route_status = 418162344;

Returns
Type	Description
`String`	The routeStatus.

getRouteStatusBytes()

public ByteString getRouteStatusBytes()

[Output only] The status of the route. Check the RouteStatus enum for the list of possible values.

optional string route_status = 418162344;

Returns
Type	Description
`ByteString`	The bytes for routeStatus.

getRouteType()

public String getRouteType()

[Output Only] The type of this route, which can be one of the following values: - 'TRANSIT' for a transit route that this router learned from another Cloud Router and will readvertise to one of its BGP peers - 'SUBNET' for a route from a subnet of the VPC - 'BGP' for a route learned from a BGP peer of this router - 'STATIC' for a static route Check the RouteType enum for the list of possible values.

optional string route_type = 375888752;

Returns
Type	Description
`String`	The routeType.

getRouteTypeBytes()

public ByteString getRouteTypeBytes()

optional string route_type = 375888752;

Returns
Type	Description
`ByteString`	The bytes for routeType.

getSelfLink()

public String getSelfLink()

[Output Only] Server-defined fully-qualified URL for this resource.

optional string self_link = 456214797;

Returns
Type	Description
`String`	The selfLink.

getSelfLinkBytes()

public ByteString getSelfLinkBytes()

[Output Only] Server-defined fully-qualified URL for this resource.

optional string self_link = 456214797;

Returns
Type	Description
`ByteString`	The bytes for selfLink.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

getTags(int index)

public String getTags(int index)

A list of instance tags to which this route applies.

repeated string tags = 3552281;

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`String`	The tags at the given index.

getTagsBytes(int index)

public ByteString getTagsBytes(int index)

A list of instance tags to which this route applies.

repeated string tags = 3552281;

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the tags at the given index.

getTagsCount()

public int getTagsCount()

A list of instance tags to which this route applies.

repeated string tags = 3552281;

Returns
Type	Description
`int`	The count of tags.

getTagsList()

public ProtocolStringList getTagsList()

A list of instance tags to which this route applies.

repeated string tags = 3552281;

Returns
Type	Description
`ProtocolStringList`	A list containing the tags.

getWarnings(int index)

public Warnings getWarnings(int index)

[Output Only] If potential misconfigurations are detected for this route, this field will be populated with warning messages.