Class RouteModifiers (1.43.0)

public final class RouteModifiers extends GeneratedMessageV3 implements RouteModifiersOrBuilder

Encapsulates a set of optional conditions to satisfy when calculating vehicle routes. This is similar to RouteModifiers in the Google Maps Platform API; see: https://developers.google.com/maps/documentation/routes/reference/rest/v2/RouteModifiers.

Protobuf type google.cloud.optimization.v1.RouteModifiers

Static Fields

AVOID_FERRIES_FIELD_NUMBER

public static final int AVOID_FERRIES_FIELD_NUMBER
Field Value
Type Description
int

AVOID_HIGHWAYS_FIELD_NUMBER

public static final int AVOID_HIGHWAYS_FIELD_NUMBER
Field Value
Type Description
int

AVOID_INDOOR_FIELD_NUMBER

public static final int AVOID_INDOOR_FIELD_NUMBER
Field Value
Type Description
int

AVOID_TOLLS_FIELD_NUMBER

public static final int AVOID_TOLLS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RouteModifiers getDefaultInstance()
Returns
Type Description
RouteModifiers

getDescriptor()

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

newBuilder()

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

newBuilder(RouteModifiers prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAvoidFerries()

public boolean getAvoidFerries()

Specifies whether to avoid ferries where reasonable. Preference will be given to routes not containing travel by ferries. Applies only to motorized travel modes.

bool avoid_ferries = 4;

Returns
Type Description
boolean

The avoidFerries.

getAvoidHighways()

public boolean getAvoidHighways()

Specifies whether to avoid highways where reasonable. Preference will be given to routes not containing highways. Applies only to motorized travel modes.

bool avoid_highways = 3;

Returns
Type Description
boolean

The avoidHighways.

getAvoidIndoor()

public boolean getAvoidIndoor()

Optional. Specifies whether to avoid navigating indoors where reasonable. Preference will be given to routes not containing indoor navigation. Applies only to the WALKING travel mode.

bool avoid_indoor = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The avoidIndoor.

getAvoidTolls()

public boolean getAvoidTolls()

Specifies whether to avoid toll roads where reasonable. Preference will be given to routes not containing toll roads. Applies only to motorized travel modes.

bool avoid_tolls = 2;

Returns
Type Description
boolean

The avoidTolls.

getDefaultInstanceForType()

public RouteModifiers getDefaultInstanceForType()
Returns
Type Description
RouteModifiers

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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 RouteModifiers.Builder newBuilderForType()
Returns
Type Description
RouteModifiers.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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