Class RouteInfo (1.54.0) 

public final class RouteInfo extends GeneratedMessageV3 implements RouteInfoOrBuilder

For display only. Metadata associated with a Compute Engine route.

Protobuf type google.cloud.networkmanagement.v1.RouteInfo

Inheritance

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

Implements

RouteInfoOrBuilder

Static Fields

ADVERTISED_ROUTE_NEXT_HOP_URI_FIELD_NUMBER

public static final int ADVERTISED_ROUTE_NEXT_HOP_URI_FIELD_NUMBER
Field Value
Type Description
int

ADVERTISED_ROUTE_SOURCE_ROUTER_URI_FIELD_NUMBER

public static final int ADVERTISED_ROUTE_SOURCE_ROUTER_URI_FIELD_NUMBER
Field Value
Type Description
int

DEST_IP_RANGE_FIELD_NUMBER

public static final int DEST_IP_RANGE_FIELD_NUMBER
Field Value
Type Description
int

DEST_PORT_RANGES_FIELD_NUMBER

public static final int DEST_PORT_RANGES_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

INSTANCE_TAGS_FIELD_NUMBER

public static final int INSTANCE_TAGS_FIELD_NUMBER
Field Value
Type Description
int

NCC_HUB_URI_FIELD_NUMBER

public static final int NCC_HUB_URI_FIELD_NUMBER
Field Value
Type Description
int

NCC_SPOKE_URI_FIELD_NUMBER

public static final int NCC_SPOKE_URI_FIELD_NUMBER
Field Value
Type Description
int

NETWORK_URI_FIELD_NUMBER

public static final int NETWORK_URI_FIELD_NUMBER
Field Value
Type Description
int

NEXT_HOP_FIELD_NUMBER

public static final int NEXT_HOP_FIELD_NUMBER
Field Value
Type Description
int

NEXT_HOP_TYPE_FIELD_NUMBER

public static final int NEXT_HOP_TYPE_FIELD_NUMBER
Field Value
Type Description
int

PRIORITY_FIELD_NUMBER

public static final int PRIORITY_FIELD_NUMBER
Field Value
Type Description
int

PROTOCOLS_FIELD_NUMBER

public static final int PROTOCOLS_FIELD_NUMBER
Field Value
Type Description
int

REGION_FIELD_NUMBER

public static final int REGION_FIELD_NUMBER
Field Value
Type Description
int

ROUTE_SCOPE_FIELD_NUMBER

public static final int ROUTE_SCOPE_FIELD_NUMBER
Field Value
Type Description
int

ROUTE_TYPE_FIELD_NUMBER

public static final int ROUTE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

SRC_IP_RANGE_FIELD_NUMBER

public static final int SRC_IP_RANGE_FIELD_NUMBER
Field Value
Type Description
int

SRC_PORT_RANGES_FIELD_NUMBER

public static final int SRC_PORT_RANGES_FIELD_NUMBER
Field Value
Type Description
int

URI_FIELD_NUMBER

public static final int URI_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RouteInfo getDefaultInstance()
Returns
Type Description
RouteInfo

getDescriptor()

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

newBuilder()

public static RouteInfo.Builder newBuilder()
Returns
Type Description
RouteInfo.Builder

newBuilder(RouteInfo prototype)

public static RouteInfo.Builder newBuilder(RouteInfo prototype)
Parameter
Name Description
prototype RouteInfo
Returns
Type Description
RouteInfo.Builder

parseDelimitedFrom(InputStream input)

public static RouteInfo parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RouteInfo
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RouteInfo parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RouteInfo
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static RouteInfo parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
RouteInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RouteInfo parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RouteInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RouteInfo parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RouteInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RouteInfo parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RouteInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RouteInfo parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RouteInfo
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RouteInfo parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RouteInfo
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static RouteInfo parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RouteInfo
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RouteInfo parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RouteInfo
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static RouteInfo parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RouteInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RouteInfo parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RouteInfo
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<RouteInfo> parser()
Returns
Type Description
Parser<RouteInfo>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAdvertisedRouteNextHopUri()

public String getAdvertisedRouteNextHopUri()

For advertised routes, the URI of their next hop, i.e. the URI of the hybrid endpoint (VPN tunnel, Interconnect attachment, NCC router appliance) the advertised prefix is advertised through, or URI of the source peered network.

optional string advertised_route_next_hop_uri = 18;

Returns
Type Description
String

The advertisedRouteNextHopUri.

getAdvertisedRouteNextHopUriBytes()

public ByteString getAdvertisedRouteNextHopUriBytes()

For advertised routes, the URI of their next hop, i.e. the URI of the hybrid endpoint (VPN tunnel, Interconnect attachment, NCC router appliance) the advertised prefix is advertised through, or URI of the source peered network.

optional string advertised_route_next_hop_uri = 18;

Returns
Type Description
ByteString

The bytes for advertisedRouteNextHopUri.

getAdvertisedRouteSourceRouterUri()

public String getAdvertisedRouteSourceRouterUri()

For advertised dynamic routes, the URI of the Cloud Router that advertised the corresponding IP prefix.

optional string advertised_route_source_router_uri = 17;

Returns
Type Description
String

The advertisedRouteSourceRouterUri.

getAdvertisedRouteSourceRouterUriBytes()

public ByteString getAdvertisedRouteSourceRouterUriBytes()

For advertised dynamic routes, the URI of the Cloud Router that advertised the corresponding IP prefix.

optional string advertised_route_source_router_uri = 17;

Returns
Type Description
ByteString

The bytes for advertisedRouteSourceRouterUri.

getDefaultInstanceForType()

public RouteInfo getDefaultInstanceForType()
Returns
Type Description
RouteInfo

getDestIpRange()

public String getDestIpRange()

Destination IP range of the route.

string dest_ip_range = 3;

Returns
Type Description
String

The destIpRange.

getDestIpRangeBytes()

public ByteString getDestIpRangeBytes()

Destination IP range of the route.

string dest_ip_range = 3;

Returns
Type Description
ByteString

The bytes for destIpRange.

getDestPortRanges(int index)

public String getDestPortRanges(int index)

Destination port ranges of the route. Policy based routes only.

repeated string dest_port_ranges = 11;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The destPortRanges at the given index.

getDestPortRangesBytes(int index)

public ByteString getDestPortRangesBytes(int index)

Destination port ranges of the route. Policy based routes only.

repeated string dest_port_ranges = 11;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the destPortRanges at the given index.

getDestPortRangesCount()

public int getDestPortRangesCount()

Destination port ranges of the route. Policy based routes only.

repeated string dest_port_ranges = 11;

Returns
Type Description
int

The count of destPortRanges.

getDestPortRangesList()

public ProtocolStringList getDestPortRangesList()

Destination port ranges of the route. Policy based routes only.

repeated string dest_port_ranges = 11;

Returns
Type Description
ProtocolStringList

A list containing the destPortRanges.

getDisplayName()

public String getDisplayName()

Name of a route.

string display_name = 1;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Name of a route.

string display_name = 1;

Returns
Type Description
ByteString

The bytes for displayName.

getInstanceTags(int index)

public String getInstanceTags(int index)

Instance tags of the route.

repeated string instance_tags = 7;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The instanceTags at the given index.

getInstanceTagsBytes(int index)

public ByteString getInstanceTagsBytes(int index)

Instance tags of the route.

repeated string instance_tags = 7;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the instanceTags at the given index.

getInstanceTagsCount()

public int getInstanceTagsCount()

Instance tags of the route.

repeated string instance_tags = 7;

Returns
Type Description
int

The count of instanceTags.

getInstanceTagsList()

public ProtocolStringList getInstanceTagsList()

Instance tags of the route.

repeated string instance_tags = 7;

Returns
Type Description
ProtocolStringList

A list containing the instanceTags.

getNccHubUri()

public String getNccHubUri()

URI of a NCC Hub. NCC_HUB routes only.

optional string ncc_hub_uri = 15;

Returns
Type Description
String

The nccHubUri.

getNccHubUriBytes()

public ByteString getNccHubUriBytes()

URI of a NCC Hub. NCC_HUB routes only.

optional string ncc_hub_uri = 15;

Returns
Type Description
ByteString

The bytes for nccHubUri.

getNccSpokeUri()

public String getNccSpokeUri()

URI of a NCC Spoke. NCC_HUB routes only.

optional string ncc_spoke_uri = 16;

Returns
Type Description
String

The nccSpokeUri.

getNccSpokeUriBytes()

public ByteString getNccSpokeUriBytes()

URI of a NCC Spoke. NCC_HUB routes only.

optional string ncc_spoke_uri = 16;

Returns
Type Description
ByteString

The bytes for nccSpokeUri.

getNetworkUri()

public String getNetworkUri()

URI of a Compute Engine network. NETWORK routes only.

string network_uri = 5;

Returns
Type Description
String

The networkUri.

getNetworkUriBytes()

public ByteString getNetworkUriBytes()

URI of a Compute Engine network. NETWORK routes only.

string network_uri = 5;

Returns
Type Description
ByteString

The bytes for networkUri.

getNextHop()

public String getNextHop()

Next hop of the route.

string next_hop = 4;

Returns
Type Description
String

The nextHop.

getNextHopBytes()

public ByteString getNextHopBytes()

Next hop of the route.

string next_hop = 4;

Returns
Type Description
ByteString

The bytes for nextHop.

getNextHopType()

public RouteInfo.NextHopType getNextHopType()

Type of next hop.

.google.cloud.networkmanagement.v1.RouteInfo.NextHopType next_hop_type = 9;

Returns
Type Description
RouteInfo.NextHopType

The nextHopType.

getNextHopTypeValue()

public int getNextHopTypeValue()

Type of next hop.

.google.cloud.networkmanagement.v1.RouteInfo.NextHopType next_hop_type = 9;

Returns
Type Description
int

The enum numeric value on the wire for nextHopType.

getParserForType()

public Parser<RouteInfo> getParserForType()
Returns
Type Description
Parser<RouteInfo>
Overrides

getPriority()

public int getPriority()

Priority of the route.

int32 priority = 6;

Returns
Type Description
int

The priority.

getProtocols(int index)

public String getProtocols(int index)

Protocols of the route. Policy based routes only.

repeated string protocols = 13;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The protocols at the given index.

getProtocolsBytes(int index)

public ByteString getProtocolsBytes(int index)

Protocols of the route. Policy based routes only.

repeated string protocols = 13;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the protocols at the given index.

getProtocolsCount()

public int getProtocolsCount()

Protocols of the route. Policy based routes only.

repeated string protocols = 13;

Returns
Type Description
int

The count of protocols.

getProtocolsList()

public ProtocolStringList getProtocolsList()

Protocols of the route. Policy based routes only.

repeated string protocols = 13;

Returns
Type Description
ProtocolStringList

A list containing the protocols.

getRegion()

public String getRegion()

Region of the route (if applicable).

string region = 19;

Returns
Type Description
String

The region.

getRegionBytes()

public ByteString getRegionBytes()

Region of the route (if applicable).

string region = 19;

Returns
Type Description
ByteString

The bytes for region.

getRouteScope()

public RouteInfo.RouteScope getRouteScope()

Indicates where route is applicable.

.google.cloud.networkmanagement.v1.RouteInfo.RouteScope route_scope = 14;

Returns
Type Description
RouteInfo.RouteScope

The routeScope.

getRouteScopeValue()

public int getRouteScopeValue()

Indicates where route is applicable.

.google.cloud.networkmanagement.v1.RouteInfo.RouteScope route_scope = 14;

Returns
Type Description
int

The enum numeric value on the wire for routeScope.

getRouteType()

public RouteInfo.RouteType getRouteType()

Type of route.

.google.cloud.networkmanagement.v1.RouteInfo.RouteType route_type = 8;

Returns
Type Description
RouteInfo.RouteType

The routeType.

getRouteTypeValue()

public int getRouteTypeValue()

Type of route.

.google.cloud.networkmanagement.v1.RouteInfo.RouteType route_type = 8;

Returns
Type Description
int

The enum numeric value on the wire for routeType.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSrcIpRange()

public String getSrcIpRange()

Source IP address range of the route. Policy based routes only.

string src_ip_range = 10;

Returns
Type Description
String

The srcIpRange.

getSrcIpRangeBytes()

public ByteString getSrcIpRangeBytes()

Source IP address range of the route. Policy based routes only.

string src_ip_range = 10;

Returns
Type Description
ByteString

The bytes for srcIpRange.

getSrcPortRanges(int index)

public String getSrcPortRanges(int index)

Source port ranges of the route. Policy based routes only.

repeated string src_port_ranges = 12;

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The srcPortRanges at the given index.

getSrcPortRangesBytes(int index)

public ByteString getSrcPortRangesBytes(int index)

Source port ranges of the route. Policy based routes only.

repeated string src_port_ranges = 12;

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the srcPortRanges at the given index.

getSrcPortRangesCount()

public int getSrcPortRangesCount()

Source port ranges of the route. Policy based routes only.

repeated string src_port_ranges = 12;

Returns
Type Description
int

The count of srcPortRanges.

getSrcPortRangesList()

public ProtocolStringList getSrcPortRangesList()

Source port ranges of the route. Policy based routes only.

repeated string src_port_ranges = 12;

Returns
Type Description
ProtocolStringList

A list containing the srcPortRanges.

getUri()

public String getUri()

URI of a route (if applicable).

string uri = 2;

Returns
Type Description
String

The uri.

getUriBytes()

public ByteString getUriBytes()

URI of a route (if applicable).

string uri = 2;

Returns
Type Description
ByteString

The bytes for uri.

hasAdvertisedRouteNextHopUri()

public boolean hasAdvertisedRouteNextHopUri()

For advertised routes, the URI of their next hop, i.e. the URI of the hybrid endpoint (VPN tunnel, Interconnect attachment, NCC router appliance) the advertised prefix is advertised through, or URI of the source peered network.

optional string advertised_route_next_hop_uri = 18;

Returns
Type Description
boolean

Whether the advertisedRouteNextHopUri field is set.

hasAdvertisedRouteSourceRouterUri()

public boolean hasAdvertisedRouteSourceRouterUri()

For advertised dynamic routes, the URI of the Cloud Router that advertised the corresponding IP prefix.

optional string advertised_route_source_router_uri = 17;

Returns
Type Description
boolean

Whether the advertisedRouteSourceRouterUri field is set.

hasNccHubUri()

public boolean hasNccHubUri()

URI of a NCC Hub. NCC_HUB routes only.

optional string ncc_hub_uri = 15;

Returns
Type Description
boolean

Whether the nccHubUri field is set.

hasNccSpokeUri()

public boolean hasNccSpokeUri()

URI of a NCC Spoke. NCC_HUB routes only.

optional string ncc_spoke_uri = 16;

Returns
Type Description
boolean

Whether the nccSpokeUri field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public RouteInfo.Builder newBuilderForType()
Returns
Type Description
RouteInfo.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RouteInfo.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RouteInfo.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public RouteInfo.Builder toBuilder()
Returns
Type Description
RouteInfo.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException