Package software.amazon.awssdk.services.georoutes.model

Class RouteVehicleNotice

java.lang.Object

software.amazon.awssdk.services.georoutes.model.RouteVehicleNotice

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RouteVehicleNotice.Builder,RouteVehicleNotice>

@Generated("software.amazon.awssdk:codegen")
public final class RouteVehicleNotice
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RouteVehicleNotice.Builder,RouteVehicleNotice>

Notices are additional information returned that indicate issues that occurred during route calculation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RouteVehicleNotice.Builder

Method Summary

Modifier and Type	Method	Description
static RouteVehicleNotice.Builder	builder()
RouteVehicleNoticeCode	code()	Code corresponding to the issue.
String	codeAsString()	Code corresponding to the issue.
List<RouteVehicleNoticeDetail>	details()	Additional details of the notice.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDetails()	For responses, this returns true if the service returned a value for the Details property.
int	hashCode()
RouteNoticeImpact	impact()	Impact corresponding to the issue.
String	impactAsString()	Impact corresponding to the issue.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends RouteVehicleNotice.Builder>	serializableBuilderClass()
RouteVehicleNotice.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

code

public final RouteVehicleNoticeCode code()

Code corresponding to the issue.

If the service returns an enum value that is not available in the current SDK version, code will return RouteVehicleNoticeCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from codeAsString().

Returns:

Code corresponding to the issue.

See Also:

RouteVehicleNoticeCode

codeAsString

public final String codeAsString()

Code corresponding to the issue.

If the service returns an enum value that is not available in the current SDK version, code will return RouteVehicleNoticeCode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from codeAsString().

Returns:

Code corresponding to the issue.

See Also:

RouteVehicleNoticeCode

hasDetails

public final boolean hasDetails()

For responses, this returns true if the service returned a value for the Details 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.

details

public final List<RouteVehicleNoticeDetail> details()

Additional details of the notice.

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 hasDetails() method.

Returns:

Additional details of the notice.

impact

public final RouteNoticeImpact impact()

Impact corresponding to the issue. While Low impact notices can be safely ignored, High impact notices must be evaluated further to determine the impact.

If the service returns an enum value that is not available in the current SDK version, impact will return RouteNoticeImpact.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from impactAsString().

Returns:

Impact corresponding to the issue. While Low impact notices can be safely ignored, High impact notices must be evaluated further to determine the impact.

See Also:

RouteNoticeImpact

impactAsString

public final String impactAsString()

Impact corresponding to the issue. While Low impact notices can be safely ignored, High impact notices must be evaluated further to determine the impact.

If the service returns an enum value that is not available in the current SDK version, impact will return RouteNoticeImpact.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from impactAsString().

Returns:

Impact corresponding to the issue. While Low impact notices can be safely ignored, High impact notices must be evaluated further to determine the impact.

See Also:

RouteNoticeImpact

toBuilder

public RouteVehicleNotice.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RouteVehicleNotice.Builder,RouteVehicleNotice>

builder

public static RouteVehicleNotice.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo