Interface RouteOrBuilder (1.65.0) 

public interface RouteOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAsPaths(int index)

public abstract 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 abstract int getAsPathsCount()

[Output Only] AS path.

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

Returns
Type Description
int

getAsPathsList()

public abstract 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 abstract 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 abstract 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 abstract String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
String

The creationTimestamp.

getCreationTimestampBytes()

public abstract ByteString getCreationTimestampBytes()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
ByteString

The bytes for creationTimestamp.

getDescription()

public abstract 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 abstract 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 abstract String getDestRange()

The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported. Must specify an IPv4 range (e.g. 192.0.2.0/24) or an IPv6 range in RFC 4291 format (e.g. 2001:db8::/32). IPv6 range will be displayed using RFC 5952 compressed format.

optional string dest_range = 381327712;

Returns
Type Description
String

The destRange.

getDestRangeBytes()

public abstract ByteString getDestRangeBytes()

The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported. Must specify an IPv4 range (e.g. 192.0.2.0/24) or an IPv6 range in RFC 4291 format (e.g. 2001:db8::/32). IPv6 range will be displayed using RFC 5952 compressed format.

optional string dest_range = 381327712;

Returns
Type Description
ByteString

The bytes for destRange.

getId()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract ByteString getNameBytes()

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
ByteString

The bytes for name.

getNetwork()

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

getNextHopHub()

public abstract String getNextHopHub()

[Output Only] The full resource name of the Network Connectivity Center hub that will handle matching packets.

optional string next_hop_hub = 198679219;

Returns
Type Description
String

The nextHopHub.

getNextHopHubBytes()

public abstract ByteString getNextHopHubBytes()

[Output Only] The full resource name of the Network Connectivity Center hub that will handle matching packets.

optional string next_hop_hub = 198679219;

Returns
Type Description
ByteString

The bytes for nextHopHub.

getNextHopIlb()

public abstract 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: - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule If an IP address is provided, must specify an IPv4 address in dot-decimal notation or an IPv6 address in RFC 4291 format. For example, the following are all valid IP addresses: - 10.128.0.56 - 2001:db8::2d9:51:0:0 - 2001:db8:0:0:2d9:51:0:0 IPv6 addresses will be displayed using RFC 5952 compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address.

optional string next_hop_ilb = 198679901;

Returns
Type Description
String

The nextHopIlb.

getNextHopIlbBytes()

public abstract ByteString getNextHopIlbBytes()

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: - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule If an IP address is provided, must specify an IPv4 address in dot-decimal notation or an IPv6 address in RFC 4291 format. For example, the following are all valid IP addresses: - 10.128.0.56 - 2001:db8::2d9:51:0:0 - 2001:db8:0:0:2d9:51:0:0 IPv6 addresses will be displayed using RFC 5952 compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address.

optional string next_hop_ilb = 198679901;

Returns
Type Description
ByteString

The bytes for nextHopIlb.

getNextHopInstance()

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

getNextHopInterRegionCost()

public abstract int getNextHopInterRegionCost()

[Output only] Internal fixed region-to-region cost that Google Cloud calculates based on factors such as network performance, distance, and available bandwidth between regions.

optional uint32 next_hop_inter_region_cost = 24442003;

Returns
Type Description
int

The nextHopInterRegionCost.

getNextHopIp()

public abstract String getNextHopIp()

The network IP address of an instance that should handle matching packets. Both IPv6 address and IPv4 addresses are supported. Must specify an IPv4 address in dot-decimal notation (e.g. 192.0.2.99) or an IPv6 address in RFC 4291 format (e.g. 2001:db8::2d9:51:0:0 or 2001:db8:0:0:2d9:51:0:0). IPv6 addresses will be displayed using RFC 5952 compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address.

optional string next_hop_ip = 110319529;

Returns
Type Description
String

The nextHopIp.

getNextHopIpBytes()

public abstract ByteString getNextHopIpBytes()

The network IP address of an instance that should handle matching packets. Both IPv6 address and IPv4 addresses are supported. Must specify an IPv4 address in dot-decimal notation (e.g. 192.0.2.99) or an IPv6 address in RFC 4291 format (e.g. 2001:db8::2d9:51:0:0 or 2001:db8:0:0:2d9:51:0:0). IPv6 addresses will be displayed using RFC 5952 compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address.

optional string next_hop_ip = 110319529;

Returns
Type Description
ByteString

The bytes for nextHopIp.

getNextHopMed()

public abstract int getNextHopMed()

[Output Only] Multi-Exit Discriminator, a BGP route metric that indicates the desirability of a particular route in a network.

optional uint32 next_hop_med = 198683530;

Returns
Type Description
int

The nextHopMed.

getNextHopNetwork()

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

getNextHopOrigin()

public abstract String getNextHopOrigin()

[Output Only] Indicates the origin of the route. Can be IGP (Interior Gateway Protocol), EGP (Exterior Gateway Protocol), or INCOMPLETE. Check the NextHopOrigin enum for the list of possible values.

optional string next_hop_origin = 48752808;

Returns
Type Description
String

The nextHopOrigin.

getNextHopOriginBytes()

public abstract ByteString getNextHopOriginBytes()

[Output Only] Indicates the origin of the route. Can be IGP (Interior Gateway Protocol), EGP (Exterior Gateway Protocol), or INCOMPLETE. Check the NextHopOrigin enum for the list of possible values.

optional string next_hop_origin = 48752808;

Returns
Type Description
ByteString

The bytes for nextHopOrigin.

getNextHopPeering()

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

getPriority()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract ByteString getRouteTypeBytes()

[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
ByteString

The bytes for routeType.

getSelfLink()

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

getTags(int index)

public abstract 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 abstract 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 abstract 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 abstract List<String> getTagsList()

A list of instance tags to which this route applies.

repeated string tags = 3552281;

Returns
Type Description
List<String>

A list containing the tags.

getWarnings(int index)

public abstract Warnings getWarnings(int index)

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

repeated .google.cloud.compute.v1.Warnings warnings = 498091095;

Parameter
Name Description
index int
Returns
Type Description
Warnings

getWarningsCount()

public abstract int getWarningsCount()

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

repeated .google.cloud.compute.v1.Warnings warnings = 498091095;

Returns
Type Description
int

getWarningsList()

public abstract List<Warnings> getWarningsList()

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

repeated .google.cloud.compute.v1.Warnings warnings = 498091095;

Returns
Type Description
List<Warnings>

getWarningsOrBuilder(int index)

public abstract WarningsOrBuilder getWarningsOrBuilder(int index)

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

repeated .google.cloud.compute.v1.Warnings warnings = 498091095;

Parameter
Name Description
index int
Returns
Type Description
WarningsOrBuilder

getWarningsOrBuilderList()

public abstract List<? extends WarningsOrBuilder> getWarningsOrBuilderList()

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

repeated .google.cloud.compute.v1.Warnings warnings = 498091095;

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

hasCreationTimestamp()

public abstract boolean hasCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
boolean

Whether the creationTimestamp field is set.

hasDescription()

public abstract boolean hasDescription()

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

optional string description = 422937596;

Returns
Type Description
boolean

Whether the description field is set.

hasDestRange()

public abstract boolean hasDestRange()

The destination range of outgoing packets that this route applies to. Both IPv4 and IPv6 are supported. Must specify an IPv4 range (e.g. 192.0.2.0/24) or an IPv6 range in RFC 4291 format (e.g. 2001:db8::/32). IPv6 range will be displayed using RFC 5952 compressed format.

optional string dest_range = 381327712;

Returns
Type Description
boolean

Whether the destRange field is set.

hasId()

public abstract boolean hasId()

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

optional uint64 id = 3355;

Returns
Type Description
boolean

Whether the id field is set.

hasKind()

public abstract boolean hasKind()

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

optional string kind = 3292052;

Returns
Type Description
boolean

Whether the kind field is set.

hasName()

public abstract boolean hasName()

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
boolean

Whether the name field is set.

hasNetwork()

public abstract boolean hasNetwork()

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

optional string network = 232872494;

Returns
Type Description
boolean

Whether the network field is set.

hasNextHopGateway()

public abstract boolean hasNextHopGateway()

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
boolean

Whether the nextHopGateway field is set.

hasNextHopHub()

public abstract boolean hasNextHopHub()

[Output Only] The full resource name of the Network Connectivity Center hub that will handle matching packets.

optional string next_hop_hub = 198679219;

Returns
Type Description
boolean

Whether the nextHopHub field is set.

hasNextHopIlb()

public abstract boolean hasNextHopIlb()

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: - https://www.googleapis.com/compute/v1/projects/project/regions/region /forwardingRules/forwardingRule - regions/region/forwardingRules/forwardingRule If an IP address is provided, must specify an IPv4 address in dot-decimal notation or an IPv6 address in RFC 4291 format. For example, the following are all valid IP addresses: - 10.128.0.56 - 2001:db8::2d9:51:0:0 - 2001:db8:0:0:2d9:51:0:0 IPv6 addresses will be displayed using RFC 5952 compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address.

optional string next_hop_ilb = 198679901;

Returns
Type Description
boolean

Whether the nextHopIlb field is set.

hasNextHopInstance()

public abstract boolean hasNextHopInstance()

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
boolean

Whether the nextHopInstance field is set.

hasNextHopInterRegionCost()

public abstract boolean hasNextHopInterRegionCost()

[Output only] Internal fixed region-to-region cost that Google Cloud calculates based on factors such as network performance, distance, and available bandwidth between regions.

optional uint32 next_hop_inter_region_cost = 24442003;

Returns
Type Description
boolean

Whether the nextHopInterRegionCost field is set.

hasNextHopIp()

public abstract boolean hasNextHopIp()

The network IP address of an instance that should handle matching packets. Both IPv6 address and IPv4 addresses are supported. Must specify an IPv4 address in dot-decimal notation (e.g. 192.0.2.99) or an IPv6 address in RFC 4291 format (e.g. 2001:db8::2d9:51:0:0 or 2001:db8:0:0:2d9:51:0:0). IPv6 addresses will be displayed using RFC 5952 compressed format (e.g. 2001:db8::2d9:51:0:0). Should never be an IPv4-mapped IPv6 address.

optional string next_hop_ip = 110319529;

Returns
Type Description
boolean

Whether the nextHopIp field is set.

hasNextHopMed()

public abstract boolean hasNextHopMed()

[Output Only] Multi-Exit Discriminator, a BGP route metric that indicates the desirability of a particular route in a network.

optional uint32 next_hop_med = 198683530;

Returns
Type Description
boolean

Whether the nextHopMed field is set.

hasNextHopNetwork()

public abstract boolean hasNextHopNetwork()

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

optional string next_hop_network = 262295788;

Returns
Type Description
boolean

Whether the nextHopNetwork field is set.

hasNextHopOrigin()

public abstract boolean hasNextHopOrigin()

[Output Only] Indicates the origin of the route. Can be IGP (Interior Gateway Protocol), EGP (Exterior Gateway Protocol), or INCOMPLETE. Check the NextHopOrigin enum for the list of possible values.

optional string next_hop_origin = 48752808;

Returns
Type Description
boolean

Whether the nextHopOrigin field is set.

hasNextHopPeering()

public abstract boolean hasNextHopPeering()

[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
boolean

Whether the nextHopPeering field is set.

hasNextHopVpnTunnel()

public abstract boolean hasNextHopVpnTunnel()

The URL to a VpnTunnel that should handle matching packets.

optional string next_hop_vpn_tunnel = 519844501;

Returns
Type Description
boolean

Whether the nextHopVpnTunnel field is set.

hasPriority()

public abstract boolean hasPriority()

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
boolean

Whether the priority field is set.

hasRouteStatus()

public abstract boolean hasRouteStatus()

[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
boolean

Whether the routeStatus field is set.

hasRouteType()

public abstract boolean hasRouteType()

[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
boolean

Whether the routeType field is set.

hasSelfLink()

public abstract boolean hasSelfLink()

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

optional string self_link = 456214797;

Returns
Type Description
boolean

Whether the selfLink field is set.