com.amazonaws.services.location.model

Class PutGeofenceRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.location.model.PutGeofenceRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PutGeofenceRequest
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
PutGeofenceRequest()

Method Summary

Modifier and Type	Method and Description
PutGeofenceRequest	addGeofencePropertiesEntry(String key, String value) Add a single GeofenceProperties entry
PutGeofenceRequest	clearGeofencePropertiesEntries() Removes all the entries added into GeofenceProperties.
PutGeofenceRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getCollectionName() The geofence collection to store the geofence in.
String	getGeofenceId() An identifier for the geofence.
Map<String,String>	getGeofenceProperties() Associates one of more properties with the geofence.
GeofenceGeometry	getGeometry() Contains the details to specify the position of the geofence.
int	hashCode()
void	setCollectionName(String collectionName) The geofence collection to store the geofence in.
void	setGeofenceId(String geofenceId) An identifier for the geofence.
void	setGeofenceProperties(Map<String,String> geofenceProperties) Associates one of more properties with the geofence.
void	setGeometry(GeofenceGeometry geometry) Contains the details to specify the position of the geofence.
String	toString() Returns a string representation of this object.
PutGeofenceRequest	withCollectionName(String collectionName) The geofence collection to store the geofence in.
PutGeofenceRequest	withGeofenceId(String geofenceId) An identifier for the geofence.
PutGeofenceRequest	withGeofenceProperties(Map<String,String> geofenceProperties) Associates one of more properties with the geofence.
PutGeofenceRequest	withGeometry(GeofenceGeometry geometry) Contains the details to specify the position of the geofence.

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

PutGeofenceRequest

public PutGeofenceRequest()

Method Detail

setCollectionName

public void setCollectionName(String collectionName)

The geofence collection to store the geofence in.

Parameters:

collectionName - The geofence collection to store the geofence in.

getCollectionName

public String getCollectionName()

The geofence collection to store the geofence in.

Returns:

The geofence collection to store the geofence in.

withCollectionName

public PutGeofenceRequest withCollectionName(String collectionName)

The geofence collection to store the geofence in.

Parameters:

collectionName - The geofence collection to store the geofence in.

Returns:

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

setGeofenceId

public void setGeofenceId(String geofenceId)

An identifier for the geofence. For example, ExampleGeofence-1.

Parameters:

geofenceId - An identifier for the geofence. For example, ExampleGeofence-1.

getGeofenceId

public String getGeofenceId()

An identifier for the geofence. For example, ExampleGeofence-1.

Returns:

An identifier for the geofence. For example, ExampleGeofence-1.

withGeofenceId

public PutGeofenceRequest withGeofenceId(String geofenceId)

An identifier for the geofence. For example, ExampleGeofence-1.

Parameters:

geofenceId - An identifier for the geofence. For example, ExampleGeofence-1.

Returns:

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

setGeometry

public void setGeometry(GeofenceGeometry geometry)

Contains the details to specify the position of the geofence. Can be a polygon, a circle or a polygon encoded in Geobuf format. Including multiple selections will return a validation error.

The geofence polygon format supports a maximum of 1,000 vertices. The Geofence Geobuf format supports a maximum of 100,000 vertices.

Parameters:

geometry - Contains the details to specify the position of the geofence. Can be a polygon, a circle or a polygon encoded in Geobuf format. Including multiple selections will return a validation error.

The geofence polygon format supports a maximum of 1,000 vertices. The Geofence Geobuf format supports a maximum of 100,000 vertices.

getGeometry

public GeofenceGeometry getGeometry()

Contains the details to specify the position of the geofence. Can be a polygon, a circle or a polygon encoded in Geobuf format. Including multiple selections will return a validation error.

The geofence polygon format supports a maximum of 1,000 vertices. The Geofence Geobuf format supports a maximum of 100,000 vertices.

Returns:

Contains the details to specify the position of the geofence. Can be a polygon, a circle or a polygon encoded in Geobuf format. Including multiple selections will return a validation error.

The geofence polygon format supports a maximum of 1,000 vertices. The Geofence Geobuf format supports a maximum of 100,000 vertices.

withGeometry

public PutGeofenceRequest withGeometry(GeofenceGeometry geometry)

Contains the details to specify the position of the geofence. Can be a polygon, a circle or a polygon encoded in Geobuf format. Including multiple selections will return a validation error.

The geofence polygon format supports a maximum of 1,000 vertices. The Geofence Geobuf format supports a maximum of 100,000 vertices.

Parameters:

geometry - Contains the details to specify the position of the geofence. Can be a polygon, a circle or a polygon encoded in Geobuf format. Including multiple selections will return a validation error.

The geofence polygon format supports a maximum of 1,000 vertices. The Geofence Geobuf format supports a maximum of 100,000 vertices.

Returns:

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

getGeofenceProperties

public Map<String,String> getGeofenceProperties()

Associates one of more properties with the geofence. A property is a key-value pair stored with the geofence and added to any geofence event triggered with that geofence.

Format: "key" : "value"

Returns:

Associates one of more properties with the geofence. A property is a key-value pair stored with the geofence and added to any geofence event triggered with that geofence.

Format: "key" : "value"

setGeofenceProperties

public void setGeofenceProperties(Map<String,String> geofenceProperties)

Associates one of more properties with the geofence. A property is a key-value pair stored with the geofence and added to any geofence event triggered with that geofence.

Format: "key" : "value"

Parameters:

geofenceProperties - Associates one of more properties with the geofence. A property is a key-value pair stored with the geofence and added to any geofence event triggered with that geofence.

Format: "key" : "value"

withGeofenceProperties

public PutGeofenceRequest withGeofenceProperties(Map<String,String> geofenceProperties)

Associates one of more properties with the geofence. A property is a key-value pair stored with the geofence and added to any geofence event triggered with that geofence.

Format: "key" : "value"

Parameters:

geofenceProperties - Associates one of more properties with the geofence. A property is a key-value pair stored with the geofence and added to any geofence event triggered with that geofence.

Format: "key" : "value"

Returns:

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

addGeofencePropertiesEntry

public PutGeofenceRequest addGeofencePropertiesEntry(String key,
                                                     String value)

Add a single GeofenceProperties entry

See Also:

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

clearGeofencePropertiesEntries

public PutGeofenceRequest clearGeofencePropertiesEntries()

Removes all the entries added into GeofenceProperties.

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 PutGeofenceRequest 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()