Interface ForecastGeofenceEventsRequest.Builder

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

  • Method Details

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

    • 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

      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:

    • 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

      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:

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

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