com.amazonaws.services.geo.model

Class CreatePlaceIndexRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.geo.model.CreatePlaceIndexRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class CreatePlaceIndexRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Creates a Place index resource in your AWS account, which supports Places functions with geospatial data sourced from your chosen data provider.

By using Places, you agree that AWS may transmit your API queries to your selected third party provider for processing, which may be outside the AWS region you are currently using.

Because of licensing limitations, you may not use HERE to store results for locations in Japan. For more information, see the AWS Service Terms for Amazon Location Service.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CreatePlaceIndexRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getDataSource() Specifies the data provider of geospatial data.
DataSourceConfiguration	getDataSourceConfiguration() Specifies the data storage option for requesting Places.
java.lang.String	getDescription() The optional description for the Place index resource.
java.lang.String	getIndexName() The name of the Place index resource.
java.lang.String	getPricingPlan() Specifies the pricing plan for your Place index resource.
int	hashCode()
void	setDataSource(java.lang.String dataSource) Specifies the data provider of geospatial data.
void	setDataSourceConfiguration(DataSourceConfiguration dataSourceConfiguration) Specifies the data storage option for requesting Places.
void	setDescription(java.lang.String description) The optional description for the Place index resource.
void	setIndexName(java.lang.String indexName) The name of the Place index resource.
void	setPricingPlan(PricingPlan pricingPlan) Specifies the pricing plan for your Place index resource.
void	setPricingPlan(java.lang.String pricingPlan) Specifies the pricing plan for your Place index resource.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
CreatePlaceIndexRequest	withDataSource(java.lang.String dataSource) Specifies the data provider of geospatial data.
CreatePlaceIndexRequest	withDataSourceConfiguration(DataSourceConfiguration dataSourceConfiguration) Specifies the data storage option for requesting Places.
CreatePlaceIndexRequest	withDescription(java.lang.String description) The optional description for the Place index resource.
CreatePlaceIndexRequest	withIndexName(java.lang.String indexName) The name of the Place index resource.
CreatePlaceIndexRequest	withPricingPlan(PricingPlan pricingPlan) Specifies the pricing plan for your Place index resource.
CreatePlaceIndexRequest	withPricingPlan(java.lang.String pricingPlan) Specifies the pricing plan for your Place index resource.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreatePlaceIndexRequest

public CreatePlaceIndexRequest()

Method Detail

getDataSource

public java.lang.String getDataSource()

Specifies the data provider of geospatial data.

Returns:

Specifies the data provider of geospatial data.

setDataSource

public void setDataSource(java.lang.String dataSource)

Specifies the data provider of geospatial data.

Parameters:

dataSource -

Specifies the data provider of geospatial data.

withDataSource

public CreatePlaceIndexRequest withDataSource(java.lang.String dataSource)

Specifies the data provider of geospatial data.

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

Parameters:

dataSource -

Specifies the data provider of geospatial data.

Returns:

A reference to this updated object so that method calls can be chained together.

getDataSourceConfiguration

public DataSourceConfiguration getDataSourceConfiguration()

Specifies the data storage option for requesting Places.

Returns:

Specifies the data storage option for requesting Places.

setDataSourceConfiguration

public void setDataSourceConfiguration(DataSourceConfiguration dataSourceConfiguration)

Specifies the data storage option for requesting Places.

Parameters:

dataSourceConfiguration -

Specifies the data storage option for requesting Places.

withDataSourceConfiguration

public CreatePlaceIndexRequest withDataSourceConfiguration(DataSourceConfiguration dataSourceConfiguration)

Specifies the data storage option for requesting Places.

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

Parameters:

dataSourceConfiguration -

Specifies the data storage option for requesting Places.

Returns:

A reference to this updated object so that method calls can be chained together.

getDescription

public java.lang.String getDescription()

The optional description for the Place index resource.

Constraints:
Length: 0 - 1000

Returns:

The optional description for the Place index resource.

setDescription

public void setDescription(java.lang.String description)

The optional description for the Place index resource.

Constraints:
Length: 0 - 1000

Parameters:

description -

The optional description for the Place index resource.

withDescription

public CreatePlaceIndexRequest withDescription(java.lang.String description)

The optional description for the Place index resource.

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

Constraints:
Length: 0 - 1000

Parameters:

description -

The optional description for the Place index resource.

Returns:

A reference to this updated object so that method calls can be chained together.

getIndexName

public java.lang.String getIndexName()

The name of the Place index resource.

Requirements:

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

• Must be a unique Place index resource name.

• No spaces allowed. For example, ExamplePlaceIndex.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

Returns:

The name of the Place index resource.

Requirements:

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

• Must be a unique Place index resource name.

• No spaces allowed. For example, ExamplePlaceIndex.

setIndexName

public void setIndexName(java.lang.String indexName)

The name of the Place index resource.

Requirements:

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

• Must be a unique Place index resource name.

• No spaces allowed. For example, ExamplePlaceIndex.

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

Parameters:

indexName -

The name of the Place index resource.

Requirements:

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

• Must be a unique Place index resource name.

• No spaces allowed. For example, ExamplePlaceIndex .

withIndexName

public CreatePlaceIndexRequest withIndexName(java.lang.String indexName)

The name of the Place index resource.

Requirements:

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

• Must be a unique Place index resource name.

• No spaces allowed. For example, ExamplePlaceIndex.

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

Constraints:
Length: 1 - 100
Pattern: ^[-._\w]+$

Parameters:

indexName -

The name of the Place index resource.

Requirements:

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

• Must be a unique Place index resource name.

• No spaces allowed. For example, ExamplePlaceIndex .

Returns:

A reference to this updated object so that method calls can be chained together.

getPricingPlan

public java.lang.String getPricingPlan()

Specifies the pricing plan for your Place index resource. There's three pricing plan options:

• RequestBasedUsage — Selects the "Request-Based Usage" pricing plan.

• MobileAssetTracking — Selects the "Mobile Asset Tracking" pricing plan.

• MobileAssetManagement — Selects the "Mobile Asset Management" pricing plan.

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

Constraints:
Allowed Values: RequestBasedUsage, MobileAssetTracking, MobileAssetManagement

Returns:

Specifies the pricing plan for your Place index resource. There's three pricing plan options:

• RequestBasedUsage — Selects the "Request-Based Usage" pricing plan.

• MobileAssetTracking — Selects the "Mobile Asset Tracking" pricing plan.

• MobileAssetManagement — Selects the "Mobile Asset Management" pricing plan.

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

See Also:

PricingPlan

setPricingPlan

public void setPricingPlan(java.lang.String pricingPlan)

Specifies the pricing plan for your Place index resource. There's three pricing plan options:

• RequestBasedUsage — Selects the "Request-Based Usage" pricing plan.

• MobileAssetTracking — Selects the "Mobile Asset Tracking" pricing plan.

• MobileAssetManagement — Selects the "Mobile Asset Management" pricing plan.

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

Constraints:
Allowed Values: RequestBasedUsage, MobileAssetTracking, MobileAssetManagement

Parameters:

pricingPlan -

Specifies the pricing plan for your Place index resource. There's three pricing plan options:

• RequestBasedUsage — Selects the "Request-Based Usage" pricing plan.

• MobileAssetTracking — Selects the "Mobile Asset Tracking" pricing plan.

• MobileAssetManagement — Selects the "Mobile Asset Management" pricing plan.

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

See Also:

PricingPlan

withPricingPlan

public CreatePlaceIndexRequest withPricingPlan(java.lang.String pricingPlan)

Specifies the pricing plan for your Place index resource. There's three pricing plan options:

• RequestBasedUsage — Selects the "Request-Based Usage" pricing plan.

• MobileAssetTracking — Selects the "Mobile Asset Tracking" pricing plan.

• MobileAssetManagement — Selects the "Mobile Asset Management" pricing plan.

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

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

Constraints:
Allowed Values: RequestBasedUsage, MobileAssetTracking, MobileAssetManagement

Parameters:

pricingPlan -

Specifies the pricing plan for your Place index resource. There's three pricing plan options:

• RequestBasedUsage — Selects the "Request-Based Usage" pricing plan.

• MobileAssetTracking — Selects the "Mobile Asset Tracking" pricing plan.

• MobileAssetManagement — Selects the "Mobile Asset Management" pricing plan.

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

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

PricingPlan

setPricingPlan

public void setPricingPlan(PricingPlan pricingPlan)

Specifies the pricing plan for your Place index resource. There's three pricing plan options:

• RequestBasedUsage — Selects the "Request-Based Usage" pricing plan.

• MobileAssetTracking — Selects the "Mobile Asset Tracking" pricing plan.

• MobileAssetManagement — Selects the "Mobile Asset Management" pricing plan.

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

Constraints:
Allowed Values: RequestBasedUsage, MobileAssetTracking, MobileAssetManagement

Parameters:

pricingPlan -

Specifies the pricing plan for your Place index resource. There's three pricing plan options:

• RequestBasedUsage — Selects the "Request-Based Usage" pricing plan.

• MobileAssetTracking — Selects the "Mobile Asset Tracking" pricing plan.

• MobileAssetManagement — Selects the "Mobile Asset Management" pricing plan.

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

See Also:

PricingPlan

withPricingPlan

public CreatePlaceIndexRequest withPricingPlan(PricingPlan pricingPlan)

Specifies the pricing plan for your Place index resource. There's three pricing plan options:

• RequestBasedUsage — Selects the "Request-Based Usage" pricing plan.

• MobileAssetTracking — Selects the "Mobile Asset Tracking" pricing plan.

• MobileAssetManagement — Selects the "Mobile Asset Management" pricing plan.

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

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

Constraints:
Allowed Values: RequestBasedUsage, MobileAssetTracking, MobileAssetManagement

Parameters:

pricingPlan -

Specifies the pricing plan for your Place index resource. There's three pricing plan options:

• RequestBasedUsage — Selects the "Request-Based Usage" pricing plan.

• MobileAssetTracking — Selects the "Mobile Asset Tracking" pricing plan.

• MobileAssetManagement — Selects the "Mobile Asset Management" pricing plan.

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

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

PricingPlan

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object