Class Route.Builder (1.71.0) 

public static final class Route.Builder extends GeneratedMessageV3.Builder<Route.Builder> implements RouteOrBuilder

A route defines a path from VM instances within a spoke to a specific destination resource. Only VPC spokes have routes.

Protobuf type google.cloud.networkconnectivity.v1.Route

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

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

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

clearCreateTime()

public Route.Builder clearCreateTime()

Output only. The time the route was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Route.Builder

clearDescription()

public Route.Builder clearDescription()

An optional description of the route.

string description = 7;

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

clearIpCidrRange()

public Route.Builder clearIpCidrRange()

The destination IP address range.

string ip_cidr_range = 1;

Returns
Type Description
Route.Builder

This builder for chaining.

clearLabels()

public Route.Builder clearLabels()
Returns
Type Description
Route.Builder

clearLocation()

public Route.Builder clearLocation()

Output only. The origin location of the route. Uses the following form: "projects/{project}/locations/{location}" Example: projects/1234/locations/us-central1

string location = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Route.Builder

This builder for chaining.

clearName()

public Route.Builder clearName()

Immutable. The name of the route. Route names must be unique. Route names use the following form: projects/{project_number}/locations/global/hubs/{hub}/routeTables/{route_table_id}/routes/{route_id}

string name = 3 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
Route.Builder

This builder for chaining.

clearNextHopInterconnectAttachment()

public Route.Builder clearNextHopInterconnectAttachment()

Immutable. The next-hop VLAN attachment for packets on this route.

.google.cloud.networkconnectivity.v1.NextHopInterconnectAttachment next_hop_interconnect_attachment = 16 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
Route.Builder

clearNextHopRouterApplianceInstance()

public Route.Builder clearNextHopRouterApplianceInstance()

Immutable. The next-hop Router appliance instance for packets on this route.

.google.cloud.networkconnectivity.v1.NextHopRouterApplianceInstance next_hop_router_appliance_instance = 15 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
Route.Builder

clearNextHopVpcNetwork()

public Route.Builder clearNextHopVpcNetwork()

Immutable. The destination VPC network for packets on this route.

.google.cloud.networkconnectivity.v1.NextHopVpcNetwork next_hop_vpc_network = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
Route.Builder

clearNextHopVpnTunnel()

public Route.Builder clearNextHopVpnTunnel()

Immutable. The next-hop VPN tunnel for packets on this route.

.google.cloud.networkconnectivity.v1.NextHopVPNTunnel next_hop_vpn_tunnel = 14 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
Route.Builder

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

Output only. The priority of this route. Priority is used to break ties in cases where a destination matches more than one route. In these cases the route with the lowest-numbered priority value wins.

int64 priority = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Route.Builder

This builder for chaining.

clearSpoke()

public Route.Builder clearSpoke()

Immutable. The spoke that this route leads to. Example: projects/12345/locations/global/spokes/SPOKE

string spoke = 11 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
Route.Builder

This builder for chaining.

clearState()

public Route.Builder clearState()

Output only. The current lifecycle state of the route.

.google.cloud.networkconnectivity.v1.State state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Route.Builder

This builder for chaining.

clearType()

public Route.Builder clearType()

Output only. The route's type. Its type is determined by the properties of its IP address range.

.google.cloud.networkconnectivity.v1.RouteType type = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Route.Builder

This builder for chaining.

clearUid()

public Route.Builder clearUid()

Output only. The Google-generated UUID for the route. This value is unique across all Network Connectivity Center route resources. If a route is deleted and another with the same name is created, the new route is assigned a different uid.

string uid = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Route.Builder

This builder for chaining.

clearUpdateTime()

public Route.Builder clearUpdateTime()

Output only. The time the route was last updated.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Route.Builder

clone()

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

containsLabels(String key)

public boolean containsLabels(String key)

Optional labels in key-value pair format. For more information about labels, see Requirements for labels.

map<string, string> labels = 6;

Parameter
Name Description
key String
Returns
Type Description
boolean

getCreateTime()

public Timestamp getCreateTime()

Output only. The time the route was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. The time the route was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time the route was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Route getDefaultInstanceForType()
Returns
Type Description
Route

getDescription()

public String getDescription()

An optional description of the route.

string description = 7;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

An optional description of the route.

string description = 7;

Returns
Type Description
ByteString

The bytes for description.

getDescriptorForType()

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

getIpCidrRange()

public String getIpCidrRange()

The destination IP address range.

string ip_cidr_range = 1;

Returns
Type Description
String

The ipCidrRange.

getIpCidrRangeBytes()

public ByteString getIpCidrRangeBytes()

The destination IP address range.

string ip_cidr_range = 1;

Returns
Type Description
ByteString

The bytes for ipCidrRange.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional labels in key-value pair format. For more information about labels, see Requirements for labels.

map<string, string> labels = 6;

Returns
Type Description
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Optional labels in key-value pair format. For more information about labels, see Requirements for labels.

map<string, string> labels = 6;

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Optional labels in key-value pair format. For more information about labels, see Requirements for labels.

map<string, string> labels = 6;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Optional labels in key-value pair format. For more information about labels, see Requirements for labels.

map<string, string> labels = 6;

Parameter
Name Description
key String
Returns
Type Description
String

getLocation()

public String getLocation()

Output only. The origin location of the route. Uses the following form: "projects/{project}/locations/{location}" Example: projects/1234/locations/us-central1

string location = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The location.

getLocationBytes()

public ByteString getLocationBytes()

Output only. The origin location of the route. Uses the following form: "projects/{project}/locations/{location}" Example: projects/1234/locations/us-central1

string location = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for location.

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getName()

public String getName()

Immutable. The name of the route. Route names must be unique. Route names use the following form: projects/{project_number}/locations/global/hubs/{hub}/routeTables/{route_table_id}/routes/{route_id}

string name = 3 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Immutable. The name of the route. Route names must be unique. Route names use the following form: projects/{project_number}/locations/global/hubs/{hub}/routeTables/{route_table_id}/routes/{route_id}

string name = 3 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
ByteString

The bytes for name.

getNextHopInterconnectAttachment()

public NextHopInterconnectAttachment getNextHopInterconnectAttachment()

Immutable. The next-hop VLAN attachment for packets on this route.

.google.cloud.networkconnectivity.v1.NextHopInterconnectAttachment next_hop_interconnect_attachment = 16 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
NextHopInterconnectAttachment

The nextHopInterconnectAttachment.

getNextHopInterconnectAttachmentBuilder()

public NextHopInterconnectAttachment.Builder getNextHopInterconnectAttachmentBuilder()

Immutable. The next-hop VLAN attachment for packets on this route.

.google.cloud.networkconnectivity.v1.NextHopInterconnectAttachment next_hop_interconnect_attachment = 16 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
NextHopInterconnectAttachment.Builder

getNextHopInterconnectAttachmentOrBuilder()

public NextHopInterconnectAttachmentOrBuilder getNextHopInterconnectAttachmentOrBuilder()

Immutable. The next-hop VLAN attachment for packets on this route.

.google.cloud.networkconnectivity.v1.NextHopInterconnectAttachment next_hop_interconnect_attachment = 16 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
NextHopInterconnectAttachmentOrBuilder

getNextHopRouterApplianceInstance()

public NextHopRouterApplianceInstance getNextHopRouterApplianceInstance()

Immutable. The next-hop Router appliance instance for packets on this route.

.google.cloud.networkconnectivity.v1.NextHopRouterApplianceInstance next_hop_router_appliance_instance = 15 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
NextHopRouterApplianceInstance

The nextHopRouterApplianceInstance.

getNextHopRouterApplianceInstanceBuilder()

public NextHopRouterApplianceInstance.Builder getNextHopRouterApplianceInstanceBuilder()

Immutable. The next-hop Router appliance instance for packets on this route.

.google.cloud.networkconnectivity.v1.NextHopRouterApplianceInstance next_hop_router_appliance_instance = 15 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
NextHopRouterApplianceInstance.Builder

getNextHopRouterApplianceInstanceOrBuilder()

public NextHopRouterApplianceInstanceOrBuilder getNextHopRouterApplianceInstanceOrBuilder()

Immutable. The next-hop Router appliance instance for packets on this route.

.google.cloud.networkconnectivity.v1.NextHopRouterApplianceInstance next_hop_router_appliance_instance = 15 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
NextHopRouterApplianceInstanceOrBuilder

getNextHopVpcNetwork()

public NextHopVpcNetwork getNextHopVpcNetwork()

Immutable. The destination VPC network for packets on this route.

.google.cloud.networkconnectivity.v1.NextHopVpcNetwork next_hop_vpc_network = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
NextHopVpcNetwork

The nextHopVpcNetwork.

getNextHopVpcNetworkBuilder()

public NextHopVpcNetwork.Builder getNextHopVpcNetworkBuilder()

Immutable. The destination VPC network for packets on this route.

.google.cloud.networkconnectivity.v1.NextHopVpcNetwork next_hop_vpc_network = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
NextHopVpcNetwork.Builder

getNextHopVpcNetworkOrBuilder()

public NextHopVpcNetworkOrBuilder getNextHopVpcNetworkOrBuilder()

Immutable. The destination VPC network for packets on this route.

.google.cloud.networkconnectivity.v1.NextHopVpcNetwork next_hop_vpc_network = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
NextHopVpcNetworkOrBuilder

getNextHopVpnTunnel()

public NextHopVPNTunnel getNextHopVpnTunnel()

Immutable. The next-hop VPN tunnel for packets on this route.

.google.cloud.networkconnectivity.v1.NextHopVPNTunnel next_hop_vpn_tunnel = 14 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
NextHopVPNTunnel

The nextHopVpnTunnel.

getNextHopVpnTunnelBuilder()

public NextHopVPNTunnel.Builder getNextHopVpnTunnelBuilder()

Immutable. The next-hop VPN tunnel for packets on this route.

.google.cloud.networkconnectivity.v1.NextHopVPNTunnel next_hop_vpn_tunnel = 14 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
NextHopVPNTunnel.Builder

getNextHopVpnTunnelOrBuilder()

public NextHopVPNTunnelOrBuilder getNextHopVpnTunnelOrBuilder()

Immutable. The next-hop VPN tunnel for packets on this route.

.google.cloud.networkconnectivity.v1.NextHopVPNTunnel next_hop_vpn_tunnel = 14 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
NextHopVPNTunnelOrBuilder

getPriority()

public long getPriority()

Output only. The priority of this route. Priority is used to break ties in cases where a destination matches more than one route. In these cases the route with the lowest-numbered priority value wins.

int64 priority = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
long

The priority.

getSpoke()

public String getSpoke()

Immutable. The spoke that this route leads to. Example: projects/12345/locations/global/spokes/SPOKE

string spoke = 11 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The spoke.

getSpokeBytes()

public ByteString getSpokeBytes()

Immutable. The spoke that this route leads to. Example: projects/12345/locations/global/spokes/SPOKE

string spoke = 11 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for spoke.

getState()

public State getState()

Output only. The current lifecycle state of the route.

.google.cloud.networkconnectivity.v1.State state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
State

The state.

getStateValue()

public int getStateValue()

Output only. The current lifecycle state of the route.

.google.cloud.networkconnectivity.v1.State state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getType()

public RouteType getType()

Output only. The route's type. Its type is determined by the properties of its IP address range.

.google.cloud.networkconnectivity.v1.RouteType type = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
RouteType

The type.

getTypeValue()

public int getTypeValue()

Output only. The route's type. Its type is determined by the properties of its IP address range.

.google.cloud.networkconnectivity.v1.RouteType type = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for type.

getUid()

public String getUid()

Output only. The Google-generated UUID for the route. This value is unique across all Network Connectivity Center route resources. If a route is deleted and another with the same name is created, the new route is assigned a different uid.

string uid = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The uid.

getUidBytes()

public ByteString getUidBytes()

Output only. The Google-generated UUID for the route. This value is unique across all Network Connectivity Center route resources. If a route is deleted and another with the same name is created, the new route is assigned a different uid.

string uid = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for uid.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The time the route was last updated.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. The time the route was last updated.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The time the route was last updated.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public boolean hasCreateTime()

Output only. The time the route was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasNextHopInterconnectAttachment()

public boolean hasNextHopInterconnectAttachment()

Immutable. The next-hop VLAN attachment for packets on this route.

.google.cloud.networkconnectivity.v1.NextHopInterconnectAttachment next_hop_interconnect_attachment = 16 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
boolean

Whether the nextHopInterconnectAttachment field is set.

hasNextHopRouterApplianceInstance()

public boolean hasNextHopRouterApplianceInstance()

Immutable. The next-hop Router appliance instance for packets on this route.

.google.cloud.networkconnectivity.v1.NextHopRouterApplianceInstance next_hop_router_appliance_instance = 15 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
boolean

Whether the nextHopRouterApplianceInstance field is set.

hasNextHopVpcNetwork()

public boolean hasNextHopVpcNetwork()

Immutable. The destination VPC network for packets on this route.

.google.cloud.networkconnectivity.v1.NextHopVpcNetwork next_hop_vpc_network = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
boolean

Whether the nextHopVpcNetwork field is set.

hasNextHopVpnTunnel()

public boolean hasNextHopVpnTunnel()

Immutable. The next-hop VPN tunnel for packets on this route.

.google.cloud.networkconnectivity.v1.NextHopVPNTunnel next_hop_vpn_tunnel = 14 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
boolean

Whether the nextHopVpnTunnel field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The time the route was last updated.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public Route.Builder mergeCreateTime(Timestamp value)

Output only. The time the route was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Route.Builder

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

mergeNextHopInterconnectAttachment(NextHopInterconnectAttachment value)

public Route.Builder mergeNextHopInterconnectAttachment(NextHopInterconnectAttachment value)

Immutable. The next-hop VLAN attachment for packets on this route.

.google.cloud.networkconnectivity.v1.NextHopInterconnectAttachment next_hop_interconnect_attachment = 16 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value NextHopInterconnectAttachment
Returns
Type Description
Route.Builder

mergeNextHopRouterApplianceInstance(NextHopRouterApplianceInstance value)

public Route.Builder mergeNextHopRouterApplianceInstance(NextHopRouterApplianceInstance value)

Immutable. The next-hop Router appliance instance for packets on this route.

.google.cloud.networkconnectivity.v1.NextHopRouterApplianceInstance next_hop_router_appliance_instance = 15 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value NextHopRouterApplianceInstance
Returns
Type Description
Route.Builder

mergeNextHopVpcNetwork(NextHopVpcNetwork value)

public Route.Builder mergeNextHopVpcNetwork(NextHopVpcNetwork value)

Immutable. The destination VPC network for packets on this route.

.google.cloud.networkconnectivity.v1.NextHopVpcNetwork next_hop_vpc_network = 2 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value NextHopVpcNetwork
Returns
Type Description
Route.Builder

mergeNextHopVpnTunnel(NextHopVPNTunnel value)

public Route.Builder mergeNextHopVpnTunnel(NextHopVPNTunnel value)

Immutable. The next-hop VPN tunnel for packets on this route.

.google.cloud.networkconnectivity.v1.NextHopVPNTunnel next_hop_vpn_tunnel = 14 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value NextHopVPNTunnel
Returns
Type Description
Route.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

mergeUpdateTime(Timestamp value)

public Route.Builder mergeUpdateTime(Timestamp value)

Output only. The time the route was last updated.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Route.Builder

putAllLabels(Map<String,String> values)

public Route.Builder putAllLabels(Map<String,String> values)

Optional labels in key-value pair format. For more information about labels, see Requirements for labels.

map<string, string> labels = 6;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
Route.Builder

putLabels(String key, String value)

public Route.Builder putLabels(String key, String value)

Optional labels in key-value pair format. For more information about labels, see Requirements for labels.

map<string, string> labels = 6;

Parameters
Name Description
key String
value String
Returns
Type Description
Route.Builder

removeLabels(String key)

public Route.Builder removeLabels(String key)

Optional labels in key-value pair format. For more information about labels, see Requirements for labels.

map<string, string> labels = 6;

Parameter
Name Description
key String
Returns
Type Description
Route.Builder

setCreateTime(Timestamp value)

public Route.Builder setCreateTime(Timestamp value)

Output only. The time the route was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Route.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Route.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The time the route was created.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Route.Builder

setDescription(String value)

public Route.Builder setDescription(String value)

An optional description of the route.

string description = 7;

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

string description = 7;

Parameter
Name Description
value ByteString

The bytes for description 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

setIpCidrRange(String value)

public Route.Builder setIpCidrRange(String value)

The destination IP address range.

string ip_cidr_range = 1;

Parameter
Name Description
value String

The ipCidrRange to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setIpCidrRangeBytes(ByteString value)

public Route.Builder setIpCidrRangeBytes(ByteString value)

The destination IP address range.

string ip_cidr_range = 1;

Parameter
Name Description
value ByteString

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

This builder for chaining.

setLocation(String value)

public Route.Builder setLocation(String value)

Output only. The origin location of the route. Uses the following form: "projects/{project}/locations/{location}" Example: projects/1234/locations/us-central1

string location = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The location to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setLocationBytes(ByteString value)

public Route.Builder setLocationBytes(ByteString value)

Output only. The origin location of the route. Uses the following form: "projects/{project}/locations/{location}" Example: projects/1234/locations/us-central1

string location = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

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

This builder for chaining.

setName(String value)

public Route.Builder setName(String value)

Immutable. The name of the route. Route names must be unique. Route names use the following form: projects/{project_number}/locations/global/hubs/{hub}/routeTables/{route_table_id}/routes/{route_id}

string name = 3 [(.google.api.field_behavior) = IMMUTABLE];

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)

Immutable. The name of the route. Route names must be unique. Route names use the following form: projects/{project_number}/locations/global/hubs/{hub}/routeTables/{route_table_id}/routes/{route_id}

string name = 3 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value ByteString

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

This builder for chaining.

setNextHopInterconnectAttachment(NextHopInterconnectAttachment value)

public Route.Builder setNextHopInterconnectAttachment(NextHopInterconnectAttachment value)

Immutable. The next-hop VLAN attachment for packets on this route.

.google.cloud.networkconnectivity.v1.NextHopInterconnectAttachment next_hop_interconnect_attachment = 16 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value NextHopInterconnectAttachment
Returns
Type Description
Route.Builder

setNextHopInterconnectAttachment(NextHopInterconnectAttachment.Builder builderForValue)

public Route.Builder setNextHopInterconnectAttachment(NextHopInterconnectAttachment.Builder builderForValue)

Immutable. The next-hop VLAN attachment for packets on this route.

.google.cloud.networkconnectivity.v1.NextHopInterconnectAttachment next_hop_interconnect_attachment = 16 [(.google.api.field_behavior) = IMMUTABLE];

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

setNextHopRouterApplianceInstance(NextHopRouterApplianceInstance value)

public Route.Builder setNextHopRouterApplianceInstance(NextHopRouterApplianceInstance value)

Immutable. The next-hop Router appliance instance for packets on this route.

.google.cloud.networkconnectivity.v1.NextHopRouterApplianceInstance next_hop_router_appliance_instance = 15 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value NextHopRouterApplianceInstance
Returns
Type Description
Route.Builder

setNextHopRouterApplianceInstance(NextHopRouterApplianceInstance.Builder builderForValue)

public Route.Builder setNextHopRouterApplianceInstance(NextHopRouterApplianceInstance.Builder builderForValue)

Immutable. The next-hop Router appliance instance for packets on this route.

.google.cloud.networkconnectivity.v1.NextHopRouterApplianceInstance next_hop_router_appliance_instance = 15 [(.google.api.field_behavior) = IMMUTABLE];

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

setNextHopVpcNetwork(NextHopVpcNetwork value)

public Route.Builder setNextHopVpcNetwork(NextHopVpcNetwork value)

Immutable. The destination VPC network for packets on this route.

.google.cloud.networkconnectivity.v1.NextHopVpcNetwork next_hop_vpc_network = 2 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value NextHopVpcNetwork
Returns
Type Description
Route.Builder

setNextHopVpcNetwork(NextHopVpcNetwork.Builder builderForValue)

public Route.Builder setNextHopVpcNetwork(NextHopVpcNetwork.Builder builderForValue)

Immutable. The destination VPC network for packets on this route.

.google.cloud.networkconnectivity.v1.NextHopVpcNetwork next_hop_vpc_network = 2 [(.google.api.field_behavior) = IMMUTABLE];

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

setNextHopVpnTunnel(NextHopVPNTunnel value)

public Route.Builder setNextHopVpnTunnel(NextHopVPNTunnel value)

Immutable. The next-hop VPN tunnel for packets on this route.

.google.cloud.networkconnectivity.v1.NextHopVPNTunnel next_hop_vpn_tunnel = 14 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name Description
value NextHopVPNTunnel
Returns
Type Description
Route.Builder

setNextHopVpnTunnel(NextHopVPNTunnel.Builder builderForValue)

public Route.Builder setNextHopVpnTunnel(NextHopVPNTunnel.Builder builderForValue)

Immutable. The next-hop VPN tunnel for packets on this route.

.google.cloud.networkconnectivity.v1.NextHopVPNTunnel next_hop_vpn_tunnel = 14 [(.google.api.field_behavior) = IMMUTABLE];

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

setPriority(long value)

public Route.Builder setPriority(long value)

Output only. The priority of this route. Priority is used to break ties in cases where a destination matches more than one route. In these cases the route with the lowest-numbered priority value wins.

int64 priority = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value long

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

setSpoke(String value)

public Route.Builder setSpoke(String value)

Immutable. The spoke that this route leads to. Example: projects/12345/locations/global/spokes/SPOKE

string spoke = 11 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The spoke to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setSpokeBytes(ByteString value)

public Route.Builder setSpokeBytes(ByteString value)

Immutable. The spoke that this route leads to. Example: projects/12345/locations/global/spokes/SPOKE

string spoke = 11 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

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

This builder for chaining.

setState(State value)

public Route.Builder setState(State value)

Output only. The current lifecycle state of the route.

.google.cloud.networkconnectivity.v1.State state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value State

The state to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setStateValue(int value)

public Route.Builder setStateValue(int value)

Output only. The current lifecycle state of the route.

.google.cloud.networkconnectivity.v1.State state = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setType(RouteType value)

public Route.Builder setType(RouteType value)

Output only. The route's type. Its type is determined by the properties of its IP address range.

.google.cloud.networkconnectivity.v1.RouteType type = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value RouteType

The type to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setTypeValue(int value)

public Route.Builder setTypeValue(int value)

Output only. The route's type. Its type is determined by the properties of its IP address range.

.google.cloud.networkconnectivity.v1.RouteType type = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value int

The enum numeric value on the wire for type to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setUid(String value)

public Route.Builder setUid(String value)

Output only. The Google-generated UUID for the route. This value is unique across all Network Connectivity Center route resources. If a route is deleted and another with the same name is created, the new route is assigned a different uid.

string uid = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value String

The uid to set.
Returns
Type Description
Route.Builder

This builder for chaining.

setUidBytes(ByteString value)

public Route.Builder setUidBytes(ByteString value)

Output only. The Google-generated UUID for the route. This value is unique across all Network Connectivity Center route resources. If a route is deleted and another with the same name is created, the new route is assigned a different uid.

string uid = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value ByteString

The bytes for uid 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

setUpdateTime(Timestamp value)

public Route.Builder setUpdateTime(Timestamp value)

Output only. The time the route was last updated.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Route.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Route.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. The time the route was last updated.

.google.protobuf.Timestamp update_time = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Route.Builder