software.amazon.awssdk.services.location.model

Class Circle

java.lang.Object

software.amazon.awssdk.services.location.model.Circle

All Implemented Interfaces:

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

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

A circle on the earth, as defined by a center point and a radius.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Circle.Builder

Method Summary

Modifier and Type	Method and Description
static Circle.Builder	builder()
List<Double>	center() A single point geometry, specifying the center of the circle, using WGS 84 coordinates, in the form [longitude, latitude].
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCenter() For responses, this returns true if the service returned a value for the Center property.
int	hashCode()
Double	radius() The radius of the circle in meters.
List<SdkField<?>>	sdkFields()
static Class<? extends Circle.Builder>	serializableBuilderClass()
Circle.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

hasCenter

public final boolean hasCenter()

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

center

public final List<Double> center()

A single point geometry, specifying the center of the circle, using WGS 84 coordinates, in the form [longitude, latitude].

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

Returns:

A single point geometry, specifying the center of the circle, using WGS 84 coordinates, in the form [longitude, latitude].

radius

public final Double radius()

The radius of the circle in meters. Must be greater than zero and no larger than 100,000 (100 kilometers).

Returns:

The radius of the circle in meters. Must be greater than zero and no larger than 100,000 (100 kilometers).

toBuilder

public Circle.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Circle.Builder,Circle>

builder

public static Circle.Builder builder()

serializableBuilderClass

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