software.amazon.awssdk.services.location.model

Class CreateGeofenceCollectionRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.location.model.LocationRequest

software.amazon.awssdk.services.location.model.CreateGeofenceCollectionRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateGeofenceCollectionRequest.Builder,CreateGeofenceCollectionRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateGeofenceCollectionRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateGeofenceCollectionRequest.Builder	builder()
String	collectionName() A custom name for the geofence collection.
String	description() An 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() For responses, this returns true if the service returned a value for the Tags property.
String	kmsKeyId() A key identifier for an AWS KMS customer managed key.
PricingPlan	pricingPlan() Specifies the pricing plan for the geofence collection.
String	pricingPlanAsString() Specifies the pricing plan for the geofence collection.
String	pricingPlanDataSource() Specifies the data provider for the geofence collection.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateGeofenceCollectionRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags() Applies one or more tags to the geofence collection.
CreateGeofenceCollectionRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

collectionName

public final String collectionName()

A custom name for the geofence collection.

Requirements:

• Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).

• Must be a unique geofence collection name.

• No spaces allowed. For example, ExampleGeofenceCollection.

Returns:

A custom name for the geofence collection.

Requirements:

• Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), and underscores (_).

• Must be a unique geofence collection name.

• No spaces allowed. For example, ExampleGeofenceCollection.

description

public final String description()

An optional description for the geofence collection.

Returns:

An optional description for the geofence collection.

kmsKeyId

public final String kmsKeyId()

A key identifier for an AWS KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.

Returns:

A key identifier for an AWS KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.

pricingPlan

public final PricingPlan pricingPlan()

Specifies the pricing plan for the 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:

Specifies the pricing plan for the 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()

Specifies the pricing plan for the 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:

Specifies the pricing plan for the 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()

Specifies the data provider for the geofence collection.

• Required value for the following pricing plans: MobileAssetTracking | MobileAssetManagement

For more information about Data Providers, and Pricing plans, see the Amazon Location Service product page.

Amazon Location Service only uses PricingPlanDataSource to calculate billing for your geofence collection. Your data won't be shared with the data provider, and will remain in your AWS account or Region unless you move it.

Valid Values: Esri | Here

Returns:

Specifies the data provider for the geofence collection.

• Required value for the following pricing plans: MobileAssetTracking | MobileAssetManagement

For more information about Data Providers, and Pricing plans, see the Amazon Location Service product page.

Amazon Location Service only uses PricingPlanDataSource to calculate billing for your geofence collection. Your data won't be shared with the data provider, and will remain in your AWS account or Region unless you move it.

Valid Values: Esri | Here

hasTags

public final boolean hasTags()

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

tags

public final Map<String,String> tags()

Applies one or more tags to the geofence collection. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

Format: "key" : "value"

Restrictions:

• Maximum 50 tags per resource

• Each resource tag must be unique with a maximum of one value.

• Maximum key length: 128 Unicode characters in UTF-8

• Maximum value length: 256 Unicode characters in UTF-8

• Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.

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

Returns:

Applies one or more tags to the geofence collection. A tag is a key-value pair helps manage, identify, search, and filter your resources by labelling them.

Format: "key" : "value"

Restrictions:

• Maximum 50 tags per resource

• Each resource tag must be unique with a maximum of one value.

• Maximum key length: 128 Unicode characters in UTF-8

• Maximum value length: 256 Unicode characters in UTF-8

• Can use alphanumeric characters (A–Z, a–z, 0–9), and the following characters: + - = . _ : / @.

toBuilder

public CreateGeofenceCollectionRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateGeofenceCollectionRequest.Builder,CreateGeofenceCollectionRequest>

Specified by:

toBuilder in class LocationRequest

builder

public static CreateGeofenceCollectionRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo