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

Class Corridor

java.lang.Object

software.amazon.awssdk.services.georoutes.model.Corridor

All Implemented Interfaces:

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

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

Geometry defined as a corridor - a LineString with a radius that defines the width of the corridor.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Corridor.Builder

Method Summary

Modifier and Type	Method	Description
static Corridor.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasLineString()	For responses, this returns true if the service returned a value for the LineString property.
List<List<Double>>	lineString()	An ordered list of positions used to plot a route on a map.
Integer	radius()	Radius that defines the width of the corridor.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Corridor.Builder>	serializableBuilderClass()
Corridor.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

hasLineString

public final boolean hasLineString()

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

lineString

public final List<List<Double>> lineString()

An ordered list of positions used to plot a route on a map.

LineString and Polyline are mutually exclusive properties.

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

Returns:

An ordered list of positions used to plot a route on a map.

LineString and Polyline are mutually exclusive properties.

radius

public final Integer radius()

Radius that defines the width of the corridor.

Returns:

Radius that defines the width of the corridor.

toBuilder

public Corridor.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Corridor.Builder,Corridor>

builder

public static Corridor.Builder builder()

serializableBuilderClass

public static Class<? extends Corridor.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