Interface GetPlaceRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<GetPlaceRequest.Builder,GetPlaceRequest>, GeoPlacesRequest.Builder, SdkBuilder<GetPlaceRequest.Builder,GetPlaceRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
GetPlaceRequest
@Mutable @NotThreadSafe public static interface GetPlaceRequest.Builder extends GeoPlacesRequest.Builder, SdkPojo, CopyableBuilder<GetPlaceRequest.Builder,GetPlaceRequest>

  • Method Details

    • placeId

      GetPlaceRequest.Builder placeId(String placeId)

      The PlaceId of the place you wish to receive the information for.

      Parameters:
      placeId - The PlaceId of the place you wish to receive the information for.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • additionalFeaturesWithStrings

      GetPlaceRequest.Builder additionalFeaturesWithStrings(Collection<String> 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • additionalFeaturesWithStrings

      GetPlaceRequest.Builder additionalFeaturesWithStrings(String... 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • additionalFeatures

      GetPlaceRequest.Builder additionalFeatures(Collection<GetPlaceAdditionalFeature> 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • additionalFeatures

      GetPlaceRequest.Builder additionalFeatures(GetPlaceAdditionalFeature... 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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • language

      GetPlaceRequest.Builder language(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • politicalView

      GetPlaceRequest.Builder politicalView(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • intendedUse

      GetPlaceRequest.Builder intendedUse(String intendedUse)

      Indicates if the query results will be persisted in customer infrastructure. Defaults to SingleUse (not stored). Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

      When storing GetPlace 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.

      Parameters:
      intendedUse - Indicates if the query results will be persisted in customer infrastructure. Defaults to SingleUse (not stored). Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

      When storing GetPlace 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • intendedUse

      GetPlaceRequest.Builder intendedUse(GetPlaceIntendedUse intendedUse)

      Indicates if the query results will be persisted in customer infrastructure. Defaults to SingleUse (not stored). Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

      When storing GetPlace 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.

      Parameters:
      intendedUse - Indicates if the query results will be persisted in customer infrastructure. Defaults to SingleUse (not stored). Not supported in ap-southeast-1 and ap-southeast-5 regions for GrabMaps customers.

      When storing GetPlace 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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • key

      GetPlaceRequest.Builder key(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      GetPlaceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      GetPlaceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.