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("software.amazon.awssdk:codegen")
public final class CreatePlaceIndexRequest
extends LocationRequest
implements ToCopyableBuilder<CreatePlaceIndexRequest.Builder,CreatePlaceIndexRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreatePlaceIndexRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`static CreatePlaceIndexRequest.Builder`	`builder()`
`String`	`dataSource()`	Specifies the geospatial data provider for the new place index.
`DataSourceConfiguration`	`dataSourceConfiguration()`	Specifies the data storage option 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()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`String`	`indexName()`	The name of the place index resource.
`PricingPlan`	`pricingPlan()`	Deprecated. Deprecated.
`String`	`pricingPlanAsString()`	Deprecated. Deprecated.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreatePlaceIndexRequest.Builder>`	`serializableBuilderClass()`
`Map<String,String>`	`tags()`	Applies one or more tags to the place index resource.
`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
  - indexName
```
public final String indexName()
```
    The name of the place index resource.
    
    Requirements:
    
    Contain only alphanumeric characters (A–Z, a–z, 0–9), hyphens (-), periods (.), 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 (-), periods (.), and underscores (_).
    
    Must be a unique place index resource name.
    
    No spaces allowed. For example, ExamplePlaceIndex.
  - dataSource
```
public final String dataSource()
```
    Specifies the geospatial data provider for the new place index.
    
    This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error.
    
    Valid values include:
    
    Esri – For additional information about Esri's coverage in your region of interest, see Esri details on geocoding coverage.
    
    Grab – Grab provides place index functionality for Southeast Asia. For additional information about GrabMaps' coverage, see GrabMaps countries and areas covered.
    
    Here – For additional information about HERE Technologies' coverage in your region of interest, see HERE details on goecoding coverage.
    
    If you specify HERE Technologies (Here) as the data provider, you may not store results for locations in Japan. For more information, see the Amazon Web Services Service Terms for Amazon Location Service.
    
    For additional information , see Data providers on the Amazon Location Service Developer Guide.
    Returns:
    
    Specifies the geospatial data provider for the new place index.
    
    This field is case-sensitive. Enter the valid values as shown. For example, entering HERE returns an error.
    
    Valid values include:
    
    Esri – For additional information about Esri's coverage in your region of interest, see Esri details on geocoding coverage.
    
    Grab – Grab provides place index functionality for Southeast Asia. For additional information about GrabMaps' coverage, see GrabMaps countries and areas covered.
    
    Here – For additional information about HERE Technologies' coverage in your region of interest, see HERE details on goecoding coverage.
    
    If you specify HERE Technologies (Here) as the data provider, you may not store results for locations in Japan. For more information, see the Amazon Web Services Service Terms for Amazon Location Service.
    
    For additional information , see Data providers on the Amazon Location Service Developer Guide.
  - pricingPlan
```
@Deprecated
public final PricingPlan pricingPlan()
```
    Deprecated.
    Deprecated. If included, the only allowed value is RequestBasedUsage.
    
    No longer used. If included, the only allowed value is RequestBasedUsage.
    
    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:
    
    No longer used. If included, the only allowed value is RequestBasedUsage.
    
    See Also:
    
    PricingPlan
  - pricingPlanAsString
```
@Deprecated
public final String pricingPlanAsString()
```
    Deprecated.
    Deprecated. If included, the only allowed value is RequestBasedUsage.
    
    No longer used. If included, the only allowed value is RequestBasedUsage.
    
    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:
    
    No longer used. If included, the only allowed value is RequestBasedUsage.
    
    See Also:
    
    PricingPlan
  - description
```
public final String description()
```
    The optional description for the place index resource.
    
    Returns:
    
    The optional description for the place index resource.
  - dataSourceConfiguration
```
public final DataSourceConfiguration dataSourceConfiguration()
```
    Specifies the data storage option requesting Places.
    
    Returns:
    
    Specifies the data storage option requesting Places.
  - 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 place index resource. A tag is a key-value pair that helps you manage, identify, search, and filter your resources.
    
    Format: "key" : "value"
    
    Restrictions:
    
    Maximum 50 tags per resource.
    
    Each tag key must be unique and must have exactly one associated 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.
    
    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 place index resource. A tag is a key-value pair that helps you manage, identify, search, and filter your resources.
    
    Format: "key" : "value"
    
    Restrictions:
    
    Maximum 50 tags per resource.
    
    Each tag key must be unique and must have exactly one associated 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.
  - 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

Class CreatePlaceIndexRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

indexName

dataSource

pricingPlan

pricingPlanAsString

description

dataSourceConfiguration

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields