Class RouteModifiers.Builder (1.46.0)

public static final class RouteModifiers.Builder extends GeneratedMessageV3.Builder<RouteModifiers.Builder> 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 Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public RouteModifiers build()
Returns
Type Description
RouteModifiers

buildPartial()

public RouteModifiers buildPartial()
Returns
Type Description
RouteModifiers

clear()

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

clearAvoidFerries()

public RouteModifiers.Builder clearAvoidFerries()

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

This builder for chaining.

clearAvoidHighways()

public RouteModifiers.Builder clearAvoidHighways()

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

This builder for chaining.

clearAvoidIndoor()

public RouteModifiers.Builder clearAvoidIndoor()

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

This builder for chaining.

clearAvoidTolls()

public RouteModifiers.Builder clearAvoidTolls()

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

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clone()

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

getDescriptorForType()

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

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(RouteModifiers other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setAvoidFerries(boolean value)

public RouteModifiers.Builder setAvoidFerries(boolean value)

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;

Parameter
Name Description
value boolean

The avoidFerries to set.

Returns
Type Description
RouteModifiers.Builder

This builder for chaining.

setAvoidHighways(boolean value)

public RouteModifiers.Builder setAvoidHighways(boolean value)

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;

Parameter
Name Description
value boolean

The avoidHighways to set.

Returns
Type Description
RouteModifiers.Builder

This builder for chaining.

setAvoidIndoor(boolean value)

public RouteModifiers.Builder setAvoidIndoor(boolean value)

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

Parameter
Name Description
value boolean

The avoidIndoor to set.

Returns
Type Description
RouteModifiers.Builder

This builder for chaining.

setAvoidTolls(boolean value)

public RouteModifiers.Builder setAvoidTolls(boolean value)

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;

Parameter
Name Description
value boolean

The avoidTolls to set.

Returns
Type Description
RouteModifiers.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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