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

Class ForecastGeofenceEventsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.location.model.LocationRequest

software.amazon.awssdk.services.location.model.ForecastGeofenceEventsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ForecastGeofenceEventsRequest.Builder,ForecastGeofenceEventsRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ForecastGeofenceEventsRequest
extends LocationRequest
implements ToCopyableBuilder<ForecastGeofenceEventsRequest.Builder,ForecastGeofenceEventsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ForecastGeofenceEventsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ForecastGeofenceEventsRequest.Builder	builder()
String	collectionName()	The name of the geofence collection.
ForecastGeofenceEventsDeviceState	deviceState()	The device's state, including current position and speed.
DistanceUnit	distanceUnit()	The distance unit used for the NearestDistance property returned in a forecasted event.
String	distanceUnitAsString()	The distance unit used for the NearestDistance property returned in a forecasted event.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	maxResults()	An optional limit for the number of resources returned in a single call.
String	nextToken()	The pagination token specifying which page of results to return in the response.
List<SdkField<?>>	sdkFields()
static Class<? extends ForecastGeofenceEventsRequest.Builder>	serializableBuilderClass()
SpeedUnit	speedUnit()	The speed unit for the device captured by the device state.
String	speedUnitAsString()	The speed unit for the device captured by the device state.
Double	timeHorizonMinutes()	Specifies the time horizon in minutes for the forecasted events.
ForecastGeofenceEventsRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

collectionName

public final String collectionName()

The name of the geofence collection.

Returns:

The name of the geofence collection.

deviceState

public final ForecastGeofenceEventsDeviceState deviceState()

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

Returns:

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

timeHorizonMinutes

public final Double timeHorizonMinutes()

Specifies the time horizon in minutes for the forecasted events.

Returns:

Specifies the time horizon in minutes for the forecasted events.

distanceUnit

public final 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

If the service returns an enum value that is not available in the current SDK version, distanceUnit will return DistanceUnit.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from distanceUnitAsString().

Returns:

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

See Also:

DistanceUnit

distanceUnitAsString

public final String distanceUnitAsString()

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

If the service returns an enum value that is not available in the current SDK version, distanceUnit will return DistanceUnit.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from distanceUnitAsString().

Returns:

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

See Also:

DistanceUnit

speedUnit

public final 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.

If the service returns an enum value that is not available in the current SDK version, speedUnit will return SpeedUnit.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from speedUnitAsString().

Returns:

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.

See Also:

SpeedUnit

speedUnitAsString

public final String speedUnitAsString()

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.

If the service returns an enum value that is not available in the current SDK version, speedUnit will return SpeedUnit.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from speedUnitAsString().

Returns:

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.

See Also:

SpeedUnit

nextToken

public final 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

Returns:

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

maxResults

public final Integer maxResults()

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

Default value: 20

Returns:

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

Default value: 20

toBuilder

public ForecastGeofenceEventsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ForecastGeofenceEventsRequest.Builder,ForecastGeofenceEventsRequest>

Specified by:

toBuilder in class LocationRequest

builder

public static ForecastGeofenceEventsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ForecastGeofenceEventsRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo