Class DescribePlaceIndexResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribePlaceIndexResponse.Builder,
DescribePlaceIndexResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Instant
The timestamp for when the place index resource was created in ISO 8601 format:YYYY-MM-DDThh:mm:ss.sssZ
.final String
The data provider of geospatial data.final DataSourceConfiguration
The specified data storage option for 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 extendsSdkResponse
.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
indexArn()
The Amazon Resource Name (ARN) for the place index resource.final String
The name of the place index resource being described.final PricingPlan
Deprecated.Deprecated.final String
Deprecated.Deprecated.static Class
<? extends DescribePlaceIndexResponse.Builder> tags()
Tags associated with 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.final Instant
The timestamp for when the place index resource was last updated in ISO 8601 format:YYYY-MM-DDThh:mm:ss.sssZ
.Methods inherited from class software.amazon.awssdk.services.location.model.LocationResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
createTime
The timestamp for when the place index resource was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
.- Returns:
- The timestamp for when the place index resource was created in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
.
-
dataSource
The data provider of geospatial data. Values can be one of the following:
-
Esri
-
Grab
-
Here
For more information about data providers, see Amazon Location Service data providers.
- Returns:
- The data provider of geospatial data. Values can be one of the following:
-
Esri
-
Grab
-
Here
For more information about data providers, see Amazon Location Service data providers.
-
-
-
dataSourceConfiguration
The specified data storage option for requesting Places.
- Returns:
- The specified data storage option for requesting Places.
-
description
The optional description for the place index resource.
- Returns:
- The optional description for the place index resource.
-
indexArn
The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across Amazon Web Services.
-
Format example:
arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex
- Returns:
- The Amazon Resource Name (ARN) for the place index resource. Used to specify a resource across Amazon Web
Services.
-
Format example:
arn:aws:geo:region:account-id:place-index/ExamplePlaceIndex
-
-
-
indexName
The name of the place index resource being described.
- Returns:
- The name of the place index resource being described.
-
pricingPlan
Deprecated.Deprecated. Always returns RequestBasedUsage.No longer used. Always returns
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. Always returns
RequestBasedUsage
. - See Also:
-
pricingPlanAsString
Deprecated.Deprecated. Always returns RequestBasedUsage.No longer used. Always returns
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. Always returns
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
Tags associated with place index resource.
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:
- Tags associated with place index resource.
-
updateTime
The timestamp for when the place index resource was last updated in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
.- Returns:
- The timestamp for when the place index resource was last updated in ISO 8601 format:
YYYY-MM-DDThh:mm:ss.sssZ
.
-
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<DescribePlaceIndexResponse.Builder,
DescribePlaceIndexResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
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:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. 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, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- 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
-