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

Class GetDevicePositionHistoryRequest

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.GetDevicePositionHistoryRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetDevicePositionHistoryRequest.Builder,GetDevicePositionHistoryRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetDevicePositionHistoryRequest.Builder

Method Summary

Modifier and Type	Method	Description
static GetDevicePositionHistoryRequest.Builder	builder()
String	deviceId()	The device whose position history you want to retrieve.
Instant	endTimeExclusive()	Specify the end time for the position history in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
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 device positions 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 GetDevicePositionHistoryRequest.Builder>	serializableBuilderClass()
Instant	startTimeInclusive()	Specify the start time for the position history in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ.
GetDevicePositionHistoryRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	trackerName()	The tracker resource receiving the request for the device position history.

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

trackerName

public final String trackerName()

The tracker resource receiving the request for the device position history.

Returns:

The tracker resource receiving the request for the device position history.

deviceId

public final String deviceId()

The device whose position history you want to retrieve.

Returns:

The device whose position history you want to retrieve.

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

startTimeInclusive

public final Instant startTimeInclusive()

Specify the start time for the position history in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. By default, the value will be 24 hours prior to the time that the request is made.

Requirement:

• The time specified for StartTimeInclusive must be before EndTimeExclusive.

Returns:

Specify the start time for the position history in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. By default, the value will be 24 hours prior to the time that the request is made.

Requirement:

• The time specified for StartTimeInclusive must be before EndTimeExclusive.

endTimeExclusive

public final Instant endTimeExclusive()

Specify the end time for the position history in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. By default, the value will be the time that the request is made.

Requirement:

• The time specified for EndTimeExclusive must be after the time for StartTimeInclusive.

Returns:

Specify the end time for the position history in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ. By default, the value will be the time that the request is made.

Requirement:

• The time specified for EndTimeExclusive must be after the time for StartTimeInclusive.

maxResults

public final Integer maxResults()

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

Default value: 100

Returns:

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

Default value: 100

toBuilder

public GetDevicePositionHistoryRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetDevicePositionHistoryRequest.Builder,GetDevicePositionHistoryRequest>

Specified by:

toBuilder in class LocationRequest

builder

public static GetDevicePositionHistoryRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetDevicePositionHistoryRequest.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