Class DescribePlaceIndexResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.location.model.LocationResponse
software.amazon.awssdk.services.location.model.DescribePlaceIndexResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribePlaceIndexResponse.Builder,DescribePlaceIndexResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribePlaceIndexResponse extends LocationResponse implements ToCopyableBuilder<DescribePlaceIndexResponse.Builder,DescribePlaceIndexResponse>

  • Method Details

    • indexName

      public final String indexName()

      The name of the place index resource being described.

      Returns:
      The name of the place index resource being described.

    • indexArn

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

    • pricingPlan

      @Deprecated public final PricingPlan 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 return PricingPlan.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from pricingPlanAsString().

      Returns:
      No longer used. Always returns RequestBasedUsage.
      See Also:

    • pricingPlanAsString

      @Deprecated public final String 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 return PricingPlan.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from pricingPlanAsString().

      Returns:
      No longer used. Always returns RequestBasedUsage.
      See Also:

    • description

      public final String description()

      The optional description for the place index resource.

      Returns:
      The optional description for the place index resource.

    • createTime

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

    • updateTime

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

    • dataSource

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

      public final DataSourceConfiguration dataSourceConfiguration()

      The specified data storage option for requesting Places.

      Returns:
      The specified data storage option for 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()

      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.

    • toBuilder

      public DescribePlaceIndexResponse.Builder 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 interface ToCopyableBuilder<DescribePlaceIndexResponse.Builder,DescribePlaceIndexResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribePlaceIndexResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribePlaceIndexResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.