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>

  • Method Details

    • deviceId

      public final String deviceId()

      The device whose position history you want to retrieve.

      Returns:
      The device whose position history you want to retrieve.

    • 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

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

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

    • toBuilder

      public GetDevicePositionHistoryRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetDevicePositionHistoryRequest.Builder,GetDevicePositionHistoryRequest>
      Specified by:
      toBuilder in class LocationRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.