Class ReverseGeocodeRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.geoplaces.model.GeoPlacesRequest
software.amazon.awssdk.services.geoplaces.model.ReverseGeocodeRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ReverseGeocodeRequest.Builder,ReverseGeocodeRequest>
@Generated("software.amazon.awssdk:codegen") public final class ReverseGeocodeRequest extends GeoPlacesRequest implements ToCopyableBuilder<ReverseGeocodeRequest.Builder,ReverseGeocodeRequest>

  • Method Details

    • hasQueryPosition

      public final boolean hasQueryPosition()
      For responses, this returns true if the service returned a value for the QueryPosition 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.

    • queryPosition

      public final List<Double> queryPosition()

      The position in World Geodetic System (WGS 84) format: [longitude, latitude] for which you are querying nearby results for. Results closer to the position will be ranked higher then results further away from the position

      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 hasQueryPosition() method.

      Returns:
      The position in World Geodetic System (WGS 84) format: [longitude, latitude] for which you are querying nearby results for. Results closer to the position will be ranked higher then results further away from the position

    • queryRadius

      public final Long queryRadius()

      The maximum distance in meters from the QueryPosition from which a result will be returned. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only up to a maximum value of 100,000.

      Returns:
      The maximum distance in meters from the QueryPosition from which a result will be returned. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only up to a maximum value of 100,000.

    • maxResults

      public final Integer maxResults()

      An optional limit for the number of results returned in a single call.

      Default value: 1

      Returns:
      An optional limit for the number of results returned in a single call.

      Default value: 1

    • filter

      public final ReverseGeocodeFilter filter()

      A structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.

      Returns:
      A structure which contains a set of inclusion/exclusion properties that results must possess in order to be returned as a result.

    • additionalFeatures

      public final List<ReverseGeocodeAdditionalFeature> additionalFeatures()

      A list of optional additional parameters, such as time zone that can be requested for each result. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only the TimeZone value.

      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 hasAdditionalFeatures() method.

      Returns:
      A list of optional additional parameters, such as time zone that can be requested for each result. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only the TimeZone value.

    • hasAdditionalFeatures

      public final boolean hasAdditionalFeatures()
      For responses, this returns true if the service returned a value for the AdditionalFeatures 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.

    • additionalFeaturesAsStrings

      public final List<String> additionalFeaturesAsStrings()

      A list of optional additional parameters, such as time zone that can be requested for each result. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only the TimeZone value.

      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 hasAdditionalFeatures() method.

      Returns:
      A list of optional additional parameters, such as time zone that can be requested for each result. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only the TimeZone value.

    • language

      public final String language()

      A list of BCP 47 compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only the following codes: en, id, km, lo, ms, my, pt, th, tl, vi, zh

      Returns:
      A list of BCP 47 compliant language codes for the results to be rendered in. If there is no data for the result in the requested language, data will be returned in the default language for the entry. For GrabMaps customers, ap-southeast-1 and ap-southeast-5 regions support only the following codes: en, id, km, lo, ms, my, pt, th, tl, vi, zh

    • politicalView

      public final String politicalView()

      The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

      Returns:
      The alpha-2 or alpha-3 character code for the political view of a country. The political view applies to the results of the request to represent unresolved territorial claims through the point of view of the specified country. Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

    • intendedUse

      public final ReverseGeocodeIntendedUse intendedUse()

      Indicates if the query results will be persisted in customer infrastructure. Defaults to SingleUse (not stored).

      When storing ReverseGeocode responses, you must set this field to Storage to comply with the terms of service. These requests will be charged at a higher rate. Please review the user agreement and service pricing structure to determine the correct setting for your use case.

      If the service returns an enum value that is not available in the current SDK version, intendedUse will return ReverseGeocodeIntendedUse.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from intendedUseAsString().

      Returns:
      Indicates if the query results will be persisted in customer infrastructure. Defaults to SingleUse (not stored).

      When storing ReverseGeocode responses, you must set this field to Storage to comply with the terms of service. These requests will be charged at a higher rate. Please review the user agreement and service pricing structure to determine the correct setting for your use case.

      See Also:

    • intendedUseAsString

      public final String intendedUseAsString()

      Indicates if the query results will be persisted in customer infrastructure. Defaults to SingleUse (not stored).

      When storing ReverseGeocode responses, you must set this field to Storage to comply with the terms of service. These requests will be charged at a higher rate. Please review the user agreement and service pricing structure to determine the correct setting for your use case.

      If the service returns an enum value that is not available in the current SDK version, intendedUse will return ReverseGeocodeIntendedUse.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from intendedUseAsString().

      Returns:
      Indicates if the query results will be persisted in customer infrastructure. Defaults to SingleUse (not stored).

      When storing ReverseGeocode responses, you must set this field to Storage to comply with the terms of service. These requests will be charged at a higher rate. Please review the user agreement and service pricing structure to determine the correct setting for your use case.

      See Also:

    • key

      public final String key()

      Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

      Returns:
      Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

    • heading

      public final Double heading()

      The heading in degrees from true north in a navigation context. The heading is measured as the angle clockwise from the North direction.

      Example: North is 0 degrees, East is 90 degrees, South is 180 degrees, and West is 270 degrees.

      Returns:
      The heading in degrees from true north in a navigation context. The heading is measured as the angle clockwise from the North direction.

      Example: North is 0 degrees, East is 90 degrees, South is 180 degrees, and West is 270 degrees.

    • toBuilder

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

    • builder

      public static ReverseGeocodeRequest.Builder builder()

    • serializableBuilderClass

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