Interface GetDevicePositionHistoryRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<GetDevicePositionHistoryRequest.Builder,GetDevicePositionHistoryRequest>, LocationRequest.Builder, SdkBuilder<GetDevicePositionHistoryRequest.Builder,GetDevicePositionHistoryRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
GetDevicePositionHistoryRequest
public static interface GetDevicePositionHistoryRequest.Builder extends LocationRequest.Builder, SdkPojo, CopyableBuilder<GetDevicePositionHistoryRequest.Builder,GetDevicePositionHistoryRequest>

  • Method Details

    • trackerName

      GetDevicePositionHistoryRequest.Builder trackerName(String trackerName)

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

      Parameters:
      trackerName - The tracker resource receiving the request for the device position history.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • deviceId

      GetDevicePositionHistoryRequest.Builder deviceId(String deviceId)

      The device whose position history you want to retrieve.

      Parameters:
      deviceId - The device whose position history you want to retrieve.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

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

    • startTimeInclusive

      GetDevicePositionHistoryRequest.Builder startTimeInclusive(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • endTimeExclusive

      GetDevicePositionHistoryRequest.Builder endTimeExclusive(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • maxResults

      GetDevicePositionHistoryRequest.Builder maxResults(Integer maxResults)

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

      Default value: 100

      Parameters:
      maxResults - An optional limit for the number of device positions returned in a single call.

      Default value: 100

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

    • overrideConfiguration

      GetDevicePositionHistoryRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      GetDevicePositionHistoryRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.