software.amazon.awssdk.services.location.model

Class CreatePlaceIndexRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreatePlaceIndexRequest.Builder,CreatePlaceIndexRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreatePlaceIndexRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreatePlaceIndexRequest.Builder	builder()
String	dataSource() Specifies the data provider of geospatial data.
DataSourceConfiguration	dataSourceConfiguration() Specifies the data storage option for requesting Places.
String	description() The optional description for the Place index resource.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	indexName() The name of the Place index resource.
PricingPlan	pricingPlan() Specifies the pricing plan for your Place index resource.
String	pricingPlanAsString() Specifies the pricing plan for your Place index resource.
List<SdkField<?>>	sdkFields()
static Class<? extends CreatePlaceIndexRequest.Builder>	serializableBuilderClass()
CreatePlaceIndexRequest.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

dataSource

public final String dataSource()

Specifies the data provider of geospatial data.

Returns:

Specifies the data provider of geospatial data.

dataSourceConfiguration

public final DataSourceConfiguration dataSourceConfiguration()

Specifies the data storage option for requesting Places.

Returns:

Specifies the data storage option for requesting Places.

description

public final String description()

The optional description for the Place index resource.

Returns:

The optional description for the Place index resource.

indexName

public final 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:

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.

pricingPlan

public final 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.

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

pricingPlanAsString

public final String pricingPlanAsString()

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.

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

toBuilder

public CreatePlaceIndexRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreatePlaceIndexRequest.Builder,CreatePlaceIndexRequest>

Specified by:

toBuilder in class LocationRequest

builder

public static CreatePlaceIndexRequest.Builder builder()

serializableBuilderClass

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