Class CreatePlaceIndexRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreatePlaceIndexRequest.Builder,
CreatePlaceIndexRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
Specifies the geospatial data provider for the new place index.final DataSourceConfiguration
Specifies the data storage option requesting Places.final String
The optional description for the place index resource.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
The name of the place index resource.final PricingPlan
Deprecated.Deprecated.final String
Deprecated.Deprecated.static Class
<? extends CreatePlaceIndexRequest.Builder> tags()
Applies one or more tags to the place index resource.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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.
-
-
-
dataSourceConfiguration
Specifies the data storage option requesting Places.
- Returns:
- Specifies the data storage option requesting Places.
-
description
The optional description for the place index resource.
- Returns:
- The optional description for the place index resource.
-
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
.
-
-
-
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 returnPricingPlan.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompricingPlanAsString()
.- Returns:
- No longer used. If included, the only allowed value is
RequestBasedUsage
. - See Also:
-
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 returnPricingPlan.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompricingPlanAsString()
.- Returns:
- No longer used. If included, the only allowed value is
RequestBasedUsage
. - See Also:
-
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 theisEmpty()
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
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
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreatePlaceIndexRequest.Builder,
CreatePlaceIndexRequest> - Specified by:
toBuilder
in classLocationRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-