Route (proto-google-maps-routing-v2 1.48.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.maps.routing.v2.Route

All Implemented Interfaces:

RouteOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
```
public final class Route
extends com.google.protobuf.GeneratedMessageV3
implements RouteOrBuilder
```
```
 Contains a route, which consists of a series of connected road segments
 that join beginning, ending, and intermediate waypoints.
 
```
Protobuf type google.maps.routing.v2.Route
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Route.Builder` Contains a route, which consists of a series of connected road segments that join beginning, ending, and intermediate waypoints.
`static class`	`Route.RouteLocalizedValues` Text representations of certain properties.
`static interface`	`Route.RouteLocalizedValuesOrBuilder`

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DESCRIPTION_FIELD_NUMBER`
`static int`	`DISTANCE_METERS_FIELD_NUMBER`
`static int`	`DURATION_FIELD_NUMBER`
`static int`	`LEGS_FIELD_NUMBER`
`static int`	`LOCALIZED_VALUES_FIELD_NUMBER`
`static int`	`OPTIMIZED_INTERMEDIATE_WAYPOINT_INDEX_FIELD_NUMBER`
`static int`	`POLYLINE_DETAILS_FIELD_NUMBER`
`static int`	`POLYLINE_FIELD_NUMBER`
`static int`	`ROUTE_LABELS_FIELD_NUMBER`
`static int`	`ROUTE_TOKEN_FIELD_NUMBER`
`static int`	`STATIC_DURATION_FIELD_NUMBER`
`static int`	`TRAVEL_ADVISORY_FIELD_NUMBER`
`static int`	`VIEWPORT_FIELD_NUMBER`
`static int`	`WARNINGS_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`static Route`	`getDefaultInstance()`
`Route`	`getDefaultInstanceForType()`
`String`	`getDescription()` A description of the route.
`com.google.protobuf.ByteString`	`getDescriptionBytes()` A description of the route.
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`int`	`getDistanceMeters()` The travel distance of the route, in meters.
`com.google.protobuf.Duration`	`getDuration()` The length of time needed to navigate the route.
`com.google.protobuf.DurationOrBuilder`	`getDurationOrBuilder()` The length of time needed to navigate the route.
`RouteLeg`	`getLegs(int index)` A collection of legs (path segments between waypoints) that make up the route.
`int`	`getLegsCount()` A collection of legs (path segments between waypoints) that make up the route.
`List<RouteLeg>`	`getLegsList()` A collection of legs (path segments between waypoints) that make up the route.
`RouteLegOrBuilder`	`getLegsOrBuilder(int index)` A collection of legs (path segments between waypoints) that make up the route.
`List<? extends RouteLegOrBuilder>`	`getLegsOrBuilderList()` A collection of legs (path segments between waypoints) that make up the route.
`Route.RouteLocalizedValues`	`getLocalizedValues()` Text representations of properties of the `Route`.
`Route.RouteLocalizedValuesOrBuilder`	`getLocalizedValuesOrBuilder()` Text representations of properties of the `Route`.
`int`	`getOptimizedIntermediateWaypointIndex(int index)` If you set [`optimize_waypoint_order`][google.maps.routing.v2.ComputeRoutesRequest.optimize_waypoint_order] to true, this field contains the optimized ordering of intermediate waypoints.
`int`	`getOptimizedIntermediateWaypointIndexCount()` If you set [`optimize_waypoint_order`][google.maps.routing.v2.ComputeRoutesRequest.optimize_waypoint_order] to true, this field contains the optimized ordering of intermediate waypoints.
`List<Integer>`	`getOptimizedIntermediateWaypointIndexList()` If you set [`optimize_waypoint_order`][google.maps.routing.v2.ComputeRoutesRequest.optimize_waypoint_order] to true, this field contains the optimized ordering of intermediate waypoints.
`com.google.protobuf.Parser<Route>`	`getParserForType()`
`Polyline`	`getPolyline()` The overall route polyline.
`PolylineDetails`	`getPolylineDetails()` Contains information about details along the polyline.
`PolylineDetailsOrBuilder`	`getPolylineDetailsOrBuilder()` Contains information about details along the polyline.
`PolylineOrBuilder`	`getPolylineOrBuilder()` The overall route polyline.
`RouteLabel`	`getRouteLabels(int index)` Labels for the `Route` that are useful to identify specific properties of the route to compare against others.
`int`	`getRouteLabelsCount()` Labels for the `Route` that are useful to identify specific properties of the route to compare against others.
`List<RouteLabel>`	`getRouteLabelsList()` Labels for the `Route` that are useful to identify specific properties of the route to compare against others.
`int`	`getRouteLabelsValue(int index)` Labels for the `Route` that are useful to identify specific properties of the route to compare against others.
`List<Integer>`	`getRouteLabelsValueList()` Labels for the `Route` that are useful to identify specific properties of the route to compare against others.
`String`	`getRouteToken()` An opaque token that can be passed to [Navigation SDK](https://developers.google.com/maps/documentation/navigation) to reconstruct the route during navigation, and, in the event of rerouting, honor the original intention when the route was created.
`com.google.protobuf.ByteString`	`getRouteTokenBytes()` An opaque token that can be passed to [Navigation SDK](https://developers.google.com/maps/documentation/navigation) to reconstruct the route during navigation, and, in the event of rerouting, honor the original intention when the route was created.
`int`	`getSerializedSize()`
`com.google.protobuf.Duration`	`getStaticDuration()` The duration of travel through the route without taking traffic conditions into consideration.
`com.google.protobuf.DurationOrBuilder`	`getStaticDurationOrBuilder()` The duration of travel through the route without taking traffic conditions into consideration.
`RouteTravelAdvisory`	`getTravelAdvisory()` Additional information about the route.
`RouteTravelAdvisoryOrBuilder`	`getTravelAdvisoryOrBuilder()` Additional information about the route.
`com.google.geo.type.Viewport`	`getViewport()` The viewport bounding box of the polyline.
`com.google.geo.type.ViewportOrBuilder`	`getViewportOrBuilder()` The viewport bounding box of the polyline.
`String`	`getWarnings(int index)` An array of warnings to show when displaying the route.
`com.google.protobuf.ByteString`	`getWarningsBytes(int index)` An array of warnings to show when displaying the route.
`int`	`getWarningsCount()` An array of warnings to show when displaying the route.
`com.google.protobuf.ProtocolStringList`	`getWarningsList()` An array of warnings to show when displaying the route.
`boolean`	`hasDuration()` The length of time needed to navigate the route.
`int`	`hashCode()`
`boolean`	`hasLocalizedValues()` Text representations of properties of the `Route`.
`boolean`	`hasPolyline()` The overall route polyline.
`boolean`	`hasPolylineDetails()` Contains information about details along the polyline.
`boolean`	`hasStaticDuration()` The duration of travel through the route without taking traffic conditions into consideration.
`boolean`	`hasTravelAdvisory()` Additional information about the route.
`boolean`	`hasViewport()` The viewport bounding box of the polyline.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static Route.Builder`	`newBuilder()`
`static Route.Builder`	`newBuilder(Route prototype)`
`Route.Builder`	`newBuilderForType()`
`protected Route.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static Route`	`parseDelimitedFrom(InputStream input)`
`static Route`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Route`	`parseFrom(byte[] data)`
`static Route`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Route`	`parseFrom(ByteBuffer data)`
`static Route`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Route`	`parseFrom(com.google.protobuf.ByteString data)`
`static Route`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Route`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static Route`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Route`	`parseFrom(InputStream input)`
`static Route`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<Route>`	`parser()`
`Route.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- ROUTE_LABELS_FIELD_NUMBER
```
public static final int ROUTE_LABELS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LEGS_FIELD_NUMBER
```
public static final int LEGS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DISTANCE_METERS_FIELD_NUMBER
```
public static final int DISTANCE_METERS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DURATION_FIELD_NUMBER
```
public static final int DURATION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- STATIC_DURATION_FIELD_NUMBER
```
public static final int STATIC_DURATION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- POLYLINE_FIELD_NUMBER
```
public static final int POLYLINE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DESCRIPTION_FIELD_NUMBER
```
public static final int DESCRIPTION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- WARNINGS_FIELD_NUMBER
```
public static final int WARNINGS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- VIEWPORT_FIELD_NUMBER
```
public static final int VIEWPORT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- TRAVEL_ADVISORY_FIELD_NUMBER
```
public static final int TRAVEL_ADVISORY_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- OPTIMIZED_INTERMEDIATE_WAYPOINT_INDEX_FIELD_NUMBER
```
public static final int OPTIMIZED_INTERMEDIATE_WAYPOINT_INDEX_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LOCALIZED_VALUES_FIELD_NUMBER
```
public static final int LOCALIZED_VALUES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ROUTE_TOKEN_FIELD_NUMBER
```
public static final int ROUTE_TOKEN_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- POLYLINE_DETAILS_FIELD_NUMBER
```
public static final int POLYLINE_DETAILS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getRouteLabelsList
```
public List<RouteLabel> getRouteLabelsList()
```
```
 Labels for the `Route` that are useful to identify specific properties
 of the route to compare against others.
 
```
repeated .google.maps.routing.v2.RouteLabel route_labels = 13;
Specified by:

getRouteLabelsList in interface RouteOrBuilder

Returns:

A list containing the routeLabels.

getRouteLabelsCount
```
public int getRouteLabelsCount()
```
```
 Labels for the `Route` that are useful to identify specific properties
 of the route to compare against others.
 
```
repeated .google.maps.routing.v2.RouteLabel route_labels = 13;
Specified by:

getRouteLabelsCount in interface RouteOrBuilder

Returns:

The count of routeLabels.

getRouteLabels
```
public RouteLabel getRouteLabels(int index)
```
```
 Labels for the `Route` that are useful to identify specific properties
 of the route to compare against others.
 
```
repeated .google.maps.routing.v2.RouteLabel route_labels = 13;
Specified by:

getRouteLabels in interface RouteOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The routeLabels at the given index.

getRouteLabelsValueList
```
public List<Integer> getRouteLabelsValueList()
```
```
 Labels for the `Route` that are useful to identify specific properties
 of the route to compare against others.
 
```
repeated .google.maps.routing.v2.RouteLabel route_labels = 13;
Specified by:

getRouteLabelsValueList in interface RouteOrBuilder

Returns:

A list containing the enum numeric values on the wire for routeLabels.

getRouteLabelsValue
```
public int getRouteLabelsValue(int index)
```
```
 Labels for the `Route` that are useful to identify specific properties
 of the route to compare against others.
 
```
repeated .google.maps.routing.v2.RouteLabel route_labels = 13;
Specified by:

getRouteLabelsValue in interface RouteOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The enum numeric value on the wire of routeLabels at the given index.