com.amazonaws.services.location.model

Class CreateGeofenceCollectionRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.location.model.CreateGeofenceCollectionRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateGeofenceCollectionRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateGeofenceCollectionRequest()

Method Summary

Modifier and Type	Method and Description
CreateGeofenceCollectionRequest	addTagsEntry(String key, String value) Add a single Tags entry
CreateGeofenceCollectionRequest	clearTagsEntries() Removes all the entries added into Tags.
CreateGeofenceCollectionRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getCollectionName() A custom name for the geofence collection.
String	getDescription() An optional description for the geofence collection.
String	getKmsKeyId() A key identifier for an Amazon Web Services KMS customer managed key.
String	getPricingPlan() Deprecated.
String	getPricingPlanDataSource() Deprecated.
Map<String,String>	getTags() Applies one or more tags to the geofence collection.
int	hashCode()
void	setCollectionName(String collectionName) A custom name for the geofence collection.
void	setDescription(String description) An optional description for the geofence collection.
void	setKmsKeyId(String kmsKeyId) A key identifier for an Amazon Web Services KMS customer managed key.
void	setPricingPlan(String pricingPlan) Deprecated.
void	setPricingPlanDataSource(String pricingPlanDataSource) Deprecated.
void	setTags(Map<String,String> tags) Applies one or more tags to the geofence collection.
String	toString() Returns a string representation of this object.
CreateGeofenceCollectionRequest	withCollectionName(String collectionName) A custom name for the geofence collection.
CreateGeofenceCollectionRequest	withDescription(String description) An optional description for the geofence collection.
CreateGeofenceCollectionRequest	withKmsKeyId(String kmsKeyId) A key identifier for an Amazon Web Services KMS customer managed key.
CreateGeofenceCollectionRequest	withPricingPlan(PricingPlan pricingPlan) Deprecated.
CreateGeofenceCollectionRequest	withPricingPlan(String pricingPlan) Deprecated.
CreateGeofenceCollectionRequest	withPricingPlanDataSource(String pricingPlanDataSource) Deprecated.
CreateGeofenceCollectionRequest	withTags(Map<String,String> tags) Applies one or more tags to the geofence collection.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateGeofenceCollectionRequest

public CreateGeofenceCollectionRequest()

Method Detail

setCollectionName

public void setCollectionName(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.

Parameters:

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.

getCollectionName

public String getCollectionName()

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.

withCollectionName

public CreateGeofenceCollectionRequest withCollectionName(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setPricingPlan

@Deprecated
public void setPricingPlan(String pricingPlan)

Deprecated.

No longer used. If included, the only allowed value is RequestBasedUsage.

Parameters:

pricingPlan - No longer used. If included, the only allowed value is RequestBasedUsage.

See Also:

PricingPlan

getPricingPlan

@Deprecated
public String getPricingPlan()

Deprecated.

No longer used. If included, the only allowed value is RequestBasedUsage.

Returns:

No longer used. If included, the only allowed value is RequestBasedUsage.

See Also:

PricingPlan

withPricingPlan

@Deprecated
public CreateGeofenceCollectionRequest withPricingPlan(String pricingPlan)

Deprecated.

No longer used. If included, the only allowed value is RequestBasedUsage.

Parameters:

pricingPlan - No longer used. If included, the only allowed value is RequestBasedUsage.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PricingPlan

withPricingPlan

@Deprecated
public CreateGeofenceCollectionRequest withPricingPlan(PricingPlan pricingPlan)

Deprecated.

No longer used. If included, the only allowed value is RequestBasedUsage.

Parameters:

pricingPlan - No longer used. If included, the only allowed value is RequestBasedUsage.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PricingPlan

setPricingPlanDataSource

@Deprecated
public void setPricingPlanDataSource(String pricingPlanDataSource)

Deprecated.

This parameter is no longer used.

Parameters:

pricingPlanDataSource - This parameter is no longer used.

getPricingPlanDataSource

@Deprecated
public String getPricingPlanDataSource()

Deprecated.

This parameter is no longer used.

Returns:

This parameter is no longer used.

withPricingPlanDataSource

@Deprecated
public CreateGeofenceCollectionRequest withPricingPlanDataSource(String pricingPlanDataSource)

Deprecated.

This parameter is no longer used.

Parameters:

pricingPlanDataSource - This parameter is no longer used.

Returns:

Returns a reference to this object so that method calls can be chained together.

setDescription

public void setDescription(String description)

An optional description for the geofence collection.

Parameters:

description - An optional description for the geofence collection.

getDescription

public String getDescription()

An optional description for the geofence collection.

Returns:

An optional description for the geofence collection.

withDescription

public CreateGeofenceCollectionRequest withDescription(String description)

An optional description for the geofence collection.

Parameters:

description - An optional description for the geofence collection.

Returns:

Returns a reference to this object so that method calls can be chained together.

getTags

public Map<String,String> getTags()

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: + - = . _ : / @.

• Cannot use "aws:" as a prefix for a key.

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: + - = . _ : / @.

• Cannot use "aws:" as a prefix for a key.

setTags

public void setTags(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: + - = . _ : / @.

• Cannot use "aws:" as a prefix for a key.

Parameters:

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: + - = . _ : / @.

• Cannot use "aws:" as a prefix for a key.

withTags

public CreateGeofenceCollectionRequest withTags(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: + - = . _ : / @.

• Cannot use "aws:" as a prefix for a key.

Parameters:

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: + - = . _ : / @.

• Cannot use "aws:" as a prefix for a key.

Returns:

Returns a reference to this object so that method calls can be chained together.

addTagsEntry

public CreateGeofenceCollectionRequest addTagsEntry(String key,
                                                    String value)

Add a single Tags entry

See Also:

withTags(java.util.Map<java.lang.String, java.lang.String>)

clearTagsEntries

public CreateGeofenceCollectionRequest clearTagsEntries()

Removes all the entries added into Tags.

Returns:

Returns a reference to this object so that method calls can be chained together.

setKmsKeyId

public void setKmsKeyId(String kmsKeyId)

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

Parameters:

kmsKeyId - A key identifier for an Amazon Web Services KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.

getKmsKeyId

public String getKmsKeyId()

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

Returns:

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

withKmsKeyId

public CreateGeofenceCollectionRequest withKmsKeyId(String kmsKeyId)

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

Parameters:

kmsKeyId - A key identifier for an Amazon Web Services KMS customer managed key. Enter a key ID, key ARN, alias name, or alias ARN.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateGeofenceCollectionRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()