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>

  • Method Details

    • collectionName

      public final String collectionName()

      The name of the geofence collection.

      Returns:
      The name of the geofence collection.

    • deviceState

      public final ForecastGeofenceEventsDeviceState deviceState()

      Represents the device's state, including its current position and speed. When speed is omitted, this API performs a containment check. The containment check operation returns IDLE events for geofences where the device is currently inside of, but no other events.

      Returns:
      Represents the device's state, including its current position and speed. When speed is omitted, this API performs a containment check. The containment check operation returns IDLE events for geofences where the device is currently inside of, but no other events.

    • timeHorizonMinutes

      public final Double timeHorizonMinutes()

      The forward-looking time window for forecasting, specified in minutes. The API only returns events that are predicted to occur within this time horizon. When no value is specified, this API performs a containment check. The containment check operation returns IDLE events for geofences where the device is currently inside of, but no other events.

      Returns:
      The forward-looking time window for forecasting, specified in minutes. The API only returns events that are predicted to occur within this time horizon. When no value is specified, this API performs a containment check. The containment check operation returns IDLE events for geofences where the device is currently inside of, but no other 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:

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

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

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

    • 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()
      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<ForecastGeofenceEventsRequest.Builder,ForecastGeofenceEventsRequest>
      Specified by:
      toBuilder in class LocationRequest
      Returns:
      a builder for type T

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.