software.amazon.awssdk.services.location.model

Class DescribeGeofenceCollectionResponse

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.DescribeGeofenceCollectionResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeGeofenceCollectionResponse.Builder,DescribeGeofenceCollectionResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeGeofenceCollectionResponse.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeGeofenceCollectionResponse.Builder	builder()
String	collectionArn() The Amazon Resource Name (ARN) for the geofence collection resource.
String	collectionName() The name of the geofence collection.
Instant	createTime() The timestamp for when the geofence resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ
String	description() The optional description for the geofence collection.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	kmsKeyId() A key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource
PricingPlan	pricingPlan() The pricing plan selected for the specified geofence collection.
String	pricingPlanAsString() The pricing plan selected for the specified geofence collection.
String	pricingPlanDataSource() The specified data provider for the geofence collection.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeGeofenceCollectionResponse.Builder>	serializableBuilderClass()
Map<String,String>	tags() Displays the key, value pairs of tags associated with this resource.
DescribeGeofenceCollectionResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
Instant	updateTime() The timestamp for when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

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

collectionArn

public final String collectionArn()

The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all AWS.

• Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection

Returns:

The Amazon Resource Name (ARN) for the geofence collection resource. Used when you need to specify a resource across all AWS.

• Format example: arn:aws:geo:region:account-id:geofence-collection/ExampleGeofenceCollection

collectionName

public final String collectionName()

The name of the geofence collection.

Returns:

The name of the geofence collection.

createTime

public final Instant createTime()

The timestamp for when the geofence resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

Returns:

The timestamp for when the geofence resource was created in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

description

public final String description()

The optional description for the geofence collection.

Returns:

The optional description for the geofence collection.

kmsKeyId

public final String kmsKeyId()

A key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource

Returns:

A key identifier for an AWS KMS customer managed key assigned to the Amazon Location resource

pricingPlan

public final PricingPlan pricingPlan()

The pricing plan selected for the specified geofence collection.

For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.

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

Returns:

The pricing plan selected for the specified geofence collection.

For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.

See Also:

PricingPlan

pricingPlanAsString

public final String pricingPlanAsString()

The pricing plan selected for the specified geofence collection.

For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.

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

Returns:

The pricing plan selected for the specified geofence collection.

For additional details and restrictions on each pricing plan option, see the Amazon Location Service pricing page.

See Also:

PricingPlan

pricingPlanDataSource

public final String pricingPlanDataSource()

The specified data provider for the geofence collection.

Returns:

The specified data provider for the geofence collection.

hasTags

public final boolean hasTags()

Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

tags

public final Map<String,String> tags()

Displays the key, value pairs of tags associated with this resource.

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

You can use hasTags() to see if a value was sent in this field.

Returns:

Displays the key, value pairs of tags associated with this resource.

updateTime

public final Instant updateTime()

The timestamp for when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

Returns:

The timestamp for when the geofence collection was last updated in ISO 8601 format: YYYY-MM-DDThh:mm:ss.sssZ

toBuilder

public DescribeGeofenceCollectionResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeGeofenceCollectionResponse.Builder,DescribeGeofenceCollectionResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static DescribeGeofenceCollectionResponse.Builder builder()

serializableBuilderClass

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