Package software.amazon.awssdk.services.location.model

Interface ForecastGeofenceEventsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ForecastGeofenceEventsRequest.Builder,ForecastGeofenceEventsRequest>, LocationRequest.Builder, SdkBuilder<ForecastGeofenceEventsRequest.Builder,ForecastGeofenceEventsRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ForecastGeofenceEventsRequest

public static interface ForecastGeofenceEventsRequest.Builder
extends LocationRequest.Builder, SdkPojo, CopyableBuilder<ForecastGeofenceEventsRequest.Builder,ForecastGeofenceEventsRequest>

Method Summary

Modifier and Type	Method	Description
ForecastGeofenceEventsRequest.Builder	collectionName(String collectionName)	The name of the geofence collection.
default ForecastGeofenceEventsRequest.Builder	deviceState(Consumer<ForecastGeofenceEventsDeviceState.Builder> deviceState)	The device's state, including current position and speed.
ForecastGeofenceEventsRequest.Builder	deviceState(ForecastGeofenceEventsDeviceState deviceState)	The device's state, including current position and speed.
ForecastGeofenceEventsRequest.Builder	distanceUnit(String distanceUnit)	The distance unit used for the NearestDistance property returned in a forecasted event.
ForecastGeofenceEventsRequest.Builder	distanceUnit(DistanceUnit distanceUnit)	The distance unit used for the NearestDistance property returned in a forecasted event.
ForecastGeofenceEventsRequest.Builder	maxResults(Integer maxResults)	An optional limit for the number of resources returned in a single call.
ForecastGeofenceEventsRequest.Builder	nextToken(String nextToken)	The pagination token specifying which page of results to return in the response.
ForecastGeofenceEventsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
ForecastGeofenceEventsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
ForecastGeofenceEventsRequest.Builder	speedUnit(String speedUnit)	The speed unit for the device captured by the device state.
ForecastGeofenceEventsRequest.Builder	speedUnit(SpeedUnit speedUnit)	The speed unit for the device captured by the device state.
ForecastGeofenceEventsRequest.Builder	timeHorizonMinutes(Double timeHorizonMinutes)	Specifies the time horizon in minutes for the forecasted events.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.location.model.LocationRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Detail

collectionName

ForecastGeofenceEventsRequest.Builder collectionName(String collectionName)

The name of the geofence collection.

Parameters:

collectionName - The name of the geofence collection.

Returns:

Returns a reference to this object so that method calls can be chained together.

deviceState

ForecastGeofenceEventsRequest.Builder deviceState(ForecastGeofenceEventsDeviceState deviceState)

The device's state, including current position and speed.

Parameters:

deviceState - The device's state, including current position and speed.

Returns:

Returns a reference to this object so that method calls can be chained together.

deviceState

default ForecastGeofenceEventsRequest.Builder deviceState(Consumer<ForecastGeofenceEventsDeviceState.Builder> deviceState)

The device's state, including current position and speed.

This is a convenience method that creates an instance of the ForecastGeofenceEventsDeviceState.Builder avoiding the need to create one manually via ForecastGeofenceEventsDeviceState.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to deviceState(ForecastGeofenceEventsDeviceState).

Parameters:

deviceState - a consumer that will call methods on ForecastGeofenceEventsDeviceState.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

deviceState(ForecastGeofenceEventsDeviceState)

timeHorizonMinutes

ForecastGeofenceEventsRequest.Builder timeHorizonMinutes(Double timeHorizonMinutes)

Specifies the time horizon in minutes for the forecasted events.

Parameters:

timeHorizonMinutes - Specifies the time horizon in minutes for the forecasted events.

Returns:

Returns a reference to this object so that method calls can be chained together.

distanceUnit

ForecastGeofenceEventsRequest.Builder distanceUnit(String distanceUnit)

The distance unit used for the NearestDistance property returned in a forecasted event. The measurement system must match for DistanceUnit and SpeedUnit; if Kilometers is specified for DistanceUnit, then SpeedUnit must be KilometersPerHour.

Default Value: Kilometers

Parameters:

distanceUnit - The distance unit used for the NearestDistance property returned in a forecasted event. The measurement system must match for DistanceUnit and SpeedUnit; if Kilometers is specified for DistanceUnit, then SpeedUnit must be KilometersPerHour.

Default Value: Kilometers

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DistanceUnit, DistanceUnit

distanceUnit

ForecastGeofenceEventsRequest.Builder distanceUnit(DistanceUnit distanceUnit)

The distance unit used for the NearestDistance property returned in a forecasted event. The measurement system must match for DistanceUnit and SpeedUnit; if Kilometers is specified for DistanceUnit, then SpeedUnit must be KilometersPerHour.

Default Value: Kilometers

Parameters:

distanceUnit - The distance unit used for the NearestDistance property returned in a forecasted event. The measurement system must match for DistanceUnit and SpeedUnit; if Kilometers is specified for DistanceUnit, then SpeedUnit must be KilometersPerHour.

Default Value: Kilometers

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

DistanceUnit, DistanceUnit

speedUnit

ForecastGeofenceEventsRequest.Builder speedUnit(String speedUnit)

The speed unit for the device captured by the device state. The measurement system must match for DistanceUnit and SpeedUnit; if Kilometers is specified for DistanceUnit, then SpeedUnit must be KilometersPerHour.

Default Value: KilometersPerHour.

Parameters:

speedUnit - The speed unit for the device captured by the device state. The measurement system must match for DistanceUnit and SpeedUnit; if Kilometers is specified for DistanceUnit, then SpeedUnit must be KilometersPerHour.

Default Value: KilometersPerHour.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SpeedUnit, SpeedUnit

speedUnit

ForecastGeofenceEventsRequest.Builder speedUnit(SpeedUnit speedUnit)

The speed unit for the device captured by the device state. The measurement system must match for DistanceUnit and SpeedUnit; if Kilometers is specified for DistanceUnit, then SpeedUnit must be KilometersPerHour.

Default Value: KilometersPerHour.

Parameters:

speedUnit - The speed unit for the device captured by the device state. The measurement system must match for DistanceUnit and SpeedUnit; if Kilometers is specified for DistanceUnit, then SpeedUnit must be KilometersPerHour.

Default Value: KilometersPerHour.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SpeedUnit, SpeedUnit

nextToken

ForecastGeofenceEventsRequest.Builder nextToken(String nextToken)

The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

Default value: null

Parameters:

nextToken - The pagination token specifying which page of results to return in the response. If no token is provided, the default page is the first page.

Default value: null

Returns:

Returns a reference to this object so that method calls can be chained together.

maxResults

ForecastGeofenceEventsRequest.Builder maxResults(Integer maxResults)

An optional limit for the number of resources returned in a single call.

Default value: 20

Parameters:

maxResults - An optional limit for the number of resources returned in a single call.

Default value: 20

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

ForecastGeofenceEventsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

ForecastGeofenceEventsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder