Class Route.Builder (1.65.0) 

public static final class Route.Builder extends GeneratedMessageV3.Builder<Route.Builder> 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.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Route.Builder

Implements

RouteOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllAsPaths(Iterable<? extends RouteAsPath> values)

public Route.Builder addAllAsPaths(Iterable<? extends RouteAsPath> values)

[Output Only] AS path.

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.compute.v1.RouteAsPath>
Returns
Type Description
Route.Builder

addAllTags(Iterable<String> values)

public Route.Builder addAllTags(Iterable<String> values)

A list of instance tags to which this route applies.

repeated string tags = 3552281;

Parameter
Name Description
values Iterable<String>

The tags to add.
Returns
Type Description
Route.Builder

This builder for chaining.

addAllWarnings(Iterable<? extends Warnings> values)

public Route.Builder addAllWarnings(Iterable<? extends Warnings> values)

[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
values Iterable<? extends com.google.cloud.compute.v1.Warnings>
Returns
Type Description
Route.Builder

addAsPaths(RouteAsPath value)

public Route.Builder addAsPaths(RouteAsPath value)

[Output Only] AS path.

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

Parameter
Name Description
value RouteAsPath
Returns
Type Description
Route.Builder

addAsPaths(RouteAsPath.Builder builderForValue)

public Route.Builder addAsPaths(RouteAsPath.Builder builderForValue)

[Output Only] AS path.

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

Parameter
Name Description
builderForValue RouteAsPath.Builder
Returns
Type Description
Route.Builder

addAsPaths(int index, RouteAsPath value)

public Route.Builder addAsPaths(int index, RouteAsPath value)

[Output Only] AS path.

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

Parameters
Name Description
index int
value RouteAsPath
Returns
Type Description
Route.Builder

addAsPaths(int index, RouteAsPath.Builder builderForValue)

public Route.Builder addAsPaths(int index, RouteAsPath.Builder builderForValue)

[Output Only] AS path.

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

Parameters
Name Description
index int
builderForValue RouteAsPath.Builder
Returns
Type Description
Route.Builder

addAsPathsBuilder()

public RouteAsPath.Builder addAsPathsBuilder()

[Output Only] AS path.

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

Returns
Type Description
RouteAsPath.Builder

addAsPathsBuilder(int index)

public RouteAsPath.Builder addAsPathsBuilder(int index)

[Output Only] AS path.

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

Parameter
Name Description
index int
Returns
Type Description
RouteAsPath.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Route.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Route.Builder
Overrides

addTags(String value)

public Route.Builder addTags(String value)

A list of instance tags to which this route applies.

repeated string tags = 3552281;

Parameter
Name Description
value String

The tags to add.
Returns
Type Description
Route.Builder

This builder for chaining.

addTagsBytes(ByteString value)

public Route.Builder addTagsBytes(ByteString value)

A list of instance tags to which this route applies.

repeated string tags = 3552281;

Parameter
Name Description
value ByteString

The bytes of the tags to add.
Returns
Type Description
Route.Builder

This builder for chaining.

addWarnings(Warnings value)

public Route.Builder addWarnings(Warnings value)

[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
value Warnings
Returns
Type Description
Route.Builder

addWarnings(Warnings.Builder builderForValue)

public Route.Builder addWarnings(Warnings.Builder builderForValue)

[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
builderForValue Warnings.Builder
Returns
Type Description
Route.Builder

addWarnings(int index, Warnings value)

public Route.Builder addWarnings(int index, Warnings value)

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

Parameters
Name Description
index int
value Warnings
Returns
Type Description
Route.Builder

addWarnings(int index, Warnings.Builder builderForValue)

public Route.Builder addWarnings(int index, Warnings.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue Warnings.Builder
Returns
Type Description
Route.Builder

addWarningsBuilder()

public Warnings.Builder addWarningsBuilder()

[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
Warnings.Builder

addWarningsBuilder(int index)

public Warnings.Builder addWarningsBuilder(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.Builder

build()

public Route build()
Returns
Type Description
Route

buildPartial()

public Route buildPartial()
Returns
Type Description
Route

clear()

public Route.Builder clear()
Returns
Type Description
Route.Builder
Overrides

clearAsPaths()

public Route.Builder clearAsPaths()

[Output Only] AS path.

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

Returns
Type Description
Route.Builder

clearCreationTimestamp()

public Route.Builder clearCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
Route.Builder

This builder for chaining.

clearDescription()

public Route.Builder clearDescription()

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

optional string description = 422937596;

Returns
Type Description
Route.Builder

This builder for chaining.

clearDestRange()

public Route.Builder clearDestRange()

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
Route.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Route.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Route.Builder
Overrides

clearId()

public Route.Builder clearId()

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

optional uint64 id = 3355;

Returns
Type Description
Route.Builder

This builder for chaining.

clearKind()

public Route.Builder clearKind()

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

optional string kind = 3292052;

Returns
Type Description
Route.Builder

This builder for chaining.

clearName()

public Route.Builder clearName()

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
Route.Builder

This builder for chaining.

clearNetwork()

public Route.Builder clearNetwork()

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

optional string network = 232872494;

Returns
Type Description
Route.Builder

This builder for chaining.

clearNextHopGateway()

public Route.Builder clearNextHopGateway()

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
Route.Builder

This builder for chaining.

clearNextHopHub()

public Route.Builder clearNextHopHub()

[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
Route.Builder

This builder for chaining.

clearNextHopIlb()

public Route.Builder clearNextHopIlb()

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
Route.Builder

This builder for chaining.

clearNextHopInstance()

public Route.Builder clearNextHopInstance()

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
Route.Builder

This builder for chaining.

clearNextHopInterRegionCost()

public Route.Builder clearNextHopInterRegionCost()

[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
Route.Builder

This builder for chaining.

clearNextHopIp()

public Route.Builder clearNextHopIp()

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
Route.Builder

This builder for chaining.

clearNextHopMed()

public Route.Builder clearNextHopMed()

[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
Route.Builder

This builder for chaining.

clearNextHopNetwork()

public Route.Builder clearNextHopNetwork()

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

optional string next_hop_network = 262295788;

Returns
Type Description
Route.Builder

This builder for chaining.

clearNextHopOrigin()

public Route.Builder clearNextHopOrigin()

[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
Route.Builder

This builder for chaining.

clearNextHopPeering()

public Route.Builder clearNextHopPeering()

[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
Route.Builder

This builder for chaining.

clearNextHopVpnTunnel()

public Route.Builder clearNextHopVpnTunnel()

The URL to a VpnTunnel that should handle matching packets.

optional string next_hop_vpn_tunnel = 519844501;

Returns
Type Description
Route.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Route.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Route.Builder
Overrides

clearPriority()

public Route.Builder clearPriority()

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
Route.Builder

This builder for chaining.

clearRouteStatus()

public Route.Builder clearRouteStatus()

[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
Route.Builder

This builder for chaining.

clearRouteType()

public Route.Builder clearRouteType()

[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
Route.Builder

This builder for chaining.

clearSelfLink()

public Route.Builder clearSelfLink()

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

optional string self_link = 456214797;

Returns
Type Description
Route.Builder

This builder for chaining.

clearTags()

public Route.Builder clearTags()

A list of instance tags to which this route applies.

repeated string tags = 3552281;

Returns
Type Description
Route.Builder

This builder for chaining.

clearWarnings()

public Route.Builder clearWarnings()

[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
Route.Builder

clone()

public Route.Builder clone()
Returns
Type Description
Route.Builder
Overrides

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

getAsPathsBuilder(int index)

public RouteAsPath.Builder getAsPathsBuilder(int index)

[Output Only] AS path.

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

Parameter
Name Description
index int
Returns
Type Description
RouteAsPath.Builder

getAsPathsBuilderList()

public List<RouteAsPath.Builder> getAsPathsBuilderList()

[Output Only] AS path.

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

Returns
Type Description
List<Builder>

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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDestRange()

public 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 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 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()

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

getNextHopHub()

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

getNextHopInterRegionCost()

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

getNextHopOrigin()

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

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()

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

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.

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

Parameter
Name Description
index int
Returns
Type Description
Warnings

getWarningsBuilder(int index)

public Warnings.Builder getWarningsBuilder(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.Builder

getWarningsBuilderList()

public List<Warnings.Builder> getWarningsBuilderList()

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

getWarningsCount()

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Route other)

public Route.Builder mergeFrom(Route other)
Parameter
Name Description
other Route
Returns
Type Description
Route.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Route.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Route.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Route.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Route.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Route.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Route.Builder
Overrides

removeAsPaths(int index)

public Route.Builder removeAsPaths(int index)

[Output Only] AS path.

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

Parameter
Name Description
index int
Returns
Type Description
Route.Builder

removeWarnings(int index)

public Route.Builder removeWarnings(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
Route.Builder

setAsPaths(int index, RouteAsPath value)

public Route.Builder setAsPaths(int index, RouteAsPath value)

[Output Only] AS path.

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

Parameters
Name Description
index int
value RouteAsPath
Returns
Type Description
Route.Builder

setAsPaths(int index, RouteAsPath.Builder builderForValue)

public Route.Builder setAsPaths(int index, RouteAsPath.Builder builderForValue)

[Output Only] AS path.

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

Parameters
Name Description
index int
builderForValue RouteAsPath.Builder
Returns
Type Description
Route.Builder

setCreationTimestamp(String value)

public Route.Builder setCreationTimestamp(String value)

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Parameter
Name Description
value String

The creationTimestamp to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setCreationTimestampBytes(ByteString value)

public Route.Builder setCreationTimestampBytes(ByteString value)

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Parameter
Name Description
value ByteString

The bytes for creationTimestamp to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setDescription(String value)

public Route.Builder setDescription(String value)

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

optional string description = 422937596;

Parameter
Name Description
value String

The description to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public Route.Builder setDescriptionBytes(ByteString value)

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

optional string description = 422937596;

Parameter
Name Description
value ByteString

The bytes for description to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setDestRange(String value)

public Route.Builder setDestRange(String value)

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;

Parameter
Name Description
value String

The destRange to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setDestRangeBytes(ByteString value)

public Route.Builder setDestRangeBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for destRange to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Route.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Route.Builder
Overrides

setId(long value)

public Route.Builder setId(long value)

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

optional uint64 id = 3355;

Parameter
Name Description
value long

The id to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setKind(String value)

public Route.Builder setKind(String value)

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

optional string kind = 3292052;

Parameter
Name Description
value String

The kind to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setKindBytes(ByteString value)

public Route.Builder setKindBytes(ByteString value)

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

optional string kind = 3292052;

Parameter
Name Description
value ByteString

The bytes for kind to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setName(String value)

public Route.Builder setName(String value)

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;

Parameter
Name Description
value String

The name to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Route.Builder setNameBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setNetwork(String value)

public Route.Builder setNetwork(String value)

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

optional string network = 232872494;

Parameter
Name Description
value String

The network to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setNetworkBytes(ByteString value)

public Route.Builder setNetworkBytes(ByteString value)

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

optional string network = 232872494;

Parameter
Name Description
value ByteString

The bytes for network to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setNextHopGateway(String value)

public Route.Builder setNextHopGateway(String value)

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;

Parameter
Name Description
value String

The nextHopGateway to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setNextHopGatewayBytes(ByteString value)

public Route.Builder setNextHopGatewayBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for nextHopGateway to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setNextHopHub(String value)

public Route.Builder setNextHopHub(String value)

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

optional string next_hop_hub = 198679219;

Parameter
Name Description
value String

The nextHopHub to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setNextHopHubBytes(ByteString value)

public Route.Builder setNextHopHubBytes(ByteString value)

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

optional string next_hop_hub = 198679219;

Parameter
Name Description
value ByteString

The bytes for nextHopHub to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setNextHopIlb(String value)

public Route.Builder setNextHopIlb(String value)

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;

Parameter
Name Description
value String

The nextHopIlb to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setNextHopIlbBytes(ByteString value)

public Route.Builder setNextHopIlbBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for nextHopIlb to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setNextHopInstance(String value)

public Route.Builder setNextHopInstance(String value)

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;

Parameter
Name Description
value String

The nextHopInstance to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setNextHopInstanceBytes(ByteString value)

public Route.Builder setNextHopInstanceBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for nextHopInstance to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setNextHopInterRegionCost(int value)

public Route.Builder setNextHopInterRegionCost(int value)

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

Parameter
Name Description
value int

The nextHopInterRegionCost to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setNextHopIp(String value)

public Route.Builder setNextHopIp(String value)

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;

Parameter
Name Description
value String

The nextHopIp to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setNextHopIpBytes(ByteString value)

public Route.Builder setNextHopIpBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for nextHopIp to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setNextHopMed(int value)

public Route.Builder setNextHopMed(int value)

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

Parameter
Name Description
value int

The nextHopMed to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setNextHopNetwork(String value)

public Route.Builder setNextHopNetwork(String value)

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

optional string next_hop_network = 262295788;

Parameter
Name Description
value String

The nextHopNetwork to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setNextHopNetworkBytes(ByteString value)

public Route.Builder setNextHopNetworkBytes(ByteString value)

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

optional string next_hop_network = 262295788;

Parameter
Name Description
value ByteString

The bytes for nextHopNetwork to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setNextHopOrigin(String value)

public Route.Builder setNextHopOrigin(String value)

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

Parameter
Name Description
value String

The nextHopOrigin to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setNextHopOriginBytes(ByteString value)

public Route.Builder setNextHopOriginBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for nextHopOrigin to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setNextHopPeering(String value)

public Route.Builder setNextHopPeering(String value)

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

optional string next_hop_peering = 412682750;

Parameter
Name Description
value String

The nextHopPeering to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setNextHopPeeringBytes(ByteString value)

public Route.Builder setNextHopPeeringBytes(ByteString value)

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

optional string next_hop_peering = 412682750;

Parameter
Name Description
value ByteString

The bytes for nextHopPeering to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setNextHopVpnTunnel(String value)

public Route.Builder setNextHopVpnTunnel(String value)

The URL to a VpnTunnel that should handle matching packets.

optional string next_hop_vpn_tunnel = 519844501;

Parameter
Name Description
value String

The nextHopVpnTunnel to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setNextHopVpnTunnelBytes(ByteString value)

public Route.Builder setNextHopVpnTunnelBytes(ByteString value)

The URL to a VpnTunnel that should handle matching packets.

optional string next_hop_vpn_tunnel = 519844501;

Parameter
Name Description
value ByteString

The bytes for nextHopVpnTunnel to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setPriority(int value)

public Route.Builder setPriority(int value)

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;

Parameter
Name Description
value int

The priority to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Route.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Route.Builder
Overrides

setRouteStatus(String value)

public Route.Builder setRouteStatus(String value)

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

optional string route_status = 418162344;

Parameter
Name Description
value String

The routeStatus to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setRouteStatusBytes(ByteString value)

public Route.Builder setRouteStatusBytes(ByteString value)

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

optional string route_status = 418162344;

Parameter
Name Description
value ByteString

The bytes for routeStatus to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setRouteType(String value)

public Route.Builder setRouteType(String value)

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

Parameter
Name Description
value String

The routeType to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setRouteTypeBytes(ByteString value)

public Route.Builder setRouteTypeBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for routeType to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setSelfLink(String value)

public Route.Builder setSelfLink(String value)

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

optional string self_link = 456214797;

Parameter
Name Description
value String

The selfLink to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setSelfLinkBytes(ByteString value)

public Route.Builder setSelfLinkBytes(ByteString value)

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

optional string self_link = 456214797;

Parameter
Name Description
value ByteString

The bytes for selfLink to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setTags(int index, String value)

public Route.Builder setTags(int index, String value)

A list of instance tags to which this route applies.

repeated string tags = 3552281;

Parameters
Name Description
index int

The index to set the value at.
value String

The tags to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Route.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Route.Builder
Overrides

setWarnings(int index, Warnings value)

public Route.Builder setWarnings(int index, Warnings value)

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

Parameters
Name Description
index int
value Warnings
Returns
Type Description
Route.Builder

setWarnings(int index, Warnings.Builder builderForValue)

public Route.Builder setWarnings(int index, Warnings.Builder builderForValue)

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

Parameters
Name Description
index int
builderForValue Warnings.Builder
Returns
Type Description
Route.Builder