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

Class ForecastGeofenceEventsResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.location.model.LocationResponse

software.amazon.awssdk.services.location.model.ForecastGeofenceEventsResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ForecastGeofenceEventsResponse.Builder,ForecastGeofenceEventsResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ForecastGeofenceEventsResponse.Builder

Method Summary

Modifier and Type	Method	Description
static ForecastGeofenceEventsResponse.Builder	builder()
DistanceUnit	distanceUnit()	The distance unit for the forecasted events.
String	distanceUnitAsString()	The distance unit for the forecasted events.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<ForecastedEvent>	forecastedEvents()	The list of forecasted events.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasForecastedEvents()	For responses, this returns true if the service returned a value for the ForecastedEvents property.
int	hashCode()
String	nextToken()	The pagination token specifying which page of results to return in the response.
List<SdkField<?>>	sdkFields()
static Class<? extends ForecastGeofenceEventsResponse.Builder>	serializableBuilderClass()
SpeedUnit	speedUnit()	The speed unit for the forecasted events.
String	speedUnitAsString()	The speed unit for the forecasted events.
ForecastGeofenceEventsResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.location.model.LocationResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

hasForecastedEvents

public final boolean hasForecastedEvents()

For responses, this returns true if the service returned a value for the ForecastedEvents property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

forecastedEvents

public final List<ForecastedEvent> forecastedEvents()

The list of forecasted events.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasForecastedEvents() method.

Returns:

The list of forecasted events.

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.

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.

distanceUnit

public final DistanceUnit distanceUnit()

The distance unit for the forecasted events.

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 for the forecasted events.

See Also:

DistanceUnit

distanceUnitAsString

public final String distanceUnitAsString()

The distance unit for the forecasted events.

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 for the forecasted events.

See Also:

DistanceUnit

speedUnit

public final SpeedUnit speedUnit()

The speed unit for the forecasted events.

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 forecasted events.

See Also:

SpeedUnit

speedUnitAsString

public final String speedUnitAsString()

The speed unit for the forecasted events.

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 forecasted events.

See Also:

SpeedUnit

toBuilder

public ForecastGeofenceEventsResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ForecastGeofenceEventsResponse.Builder,ForecastGeofenceEventsResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static ForecastGeofenceEventsResponse.Builder builder()

serializableBuilderClass

public static Class<? extends ForecastGeofenceEventsResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo