Package software.amazon.awssdk.services.geoplaces.model

Interface GetPlaceRequest.Builder

    • Method Detail

      • 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.

        Parameters:
        additionalFeatures - A list of optional additional parameters such as time zone that can be requested for each result.
        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.

        Parameters:
        additionalFeatures - A list of optional additional parameters such as time zone that can be requested for each result.
        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.

        Parameters:
        additionalFeatures - A list of optional additional parameters such as time zone that can be requested for each result.
        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.

        Parameters:
        additionalFeatures - A list of optional additional parameters such as time zone that can be requested for each result.
        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.

        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.
        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.

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

      • intendedUse

        GetPlaceRequest.Builder intendedUse​(String intendedUse)

        Indicates if the results will be stored. Defaults to SingleUse, if left empty.

        Parameters:
        intendedUse - Indicates if the results will be stored. Defaults to SingleUse, if left empty.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        GetPlaceIntendedUse, GetPlaceIntendedUse

      • intendedUse

        GetPlaceRequest.Builder intendedUse​(GetPlaceIntendedUse intendedUse)

        Indicates if the results will be stored. Defaults to SingleUse, if left empty.

        Parameters:
        intendedUse - Indicates if the results will be stored. Defaults to SingleUse, if left empty.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        GetPlaceIntendedUse, GetPlaceIntendedUse

      • 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.