Interface GetStaticMapRequest.Builder

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

  • Method Details

    • boundingBox

      GetStaticMapRequest.Builder boundingBox(String boundingBox)

      Takes in two pairs of coordinates, [Lon, Lat], denoting south-westerly and north-easterly edges of the image. The underlying area becomes the view of the image.

      Example: -123.17075,49.26959,-123.08125,49.31429

      Parameters:
      boundingBox - Takes in two pairs of coordinates, [Lon, Lat], denoting south-westerly and north-easterly edges of the image. The underlying area becomes the view of the image.

      Example: -123.17075,49.26959,-123.08125,49.31429

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

    • boundedPositions

      GetStaticMapRequest.Builder boundedPositions(String boundedPositions)

      Takes in two or more pair of coordinates, [Lon, Lat], with each coordinate separated by a comma. The API will generate an image to encompass all of the provided coordinates.

      Cannot be used with Zoom and or Radius

      Example: 97.170451,78.039098,99.045536,27.176178

      Parameters:
      boundedPositions - Takes in two or more pair of coordinates, [Lon, Lat], with each coordinate separated by a comma. The API will generate an image to encompass all of the provided coordinates.

      Cannot be used with Zoom and or Radius

      Example: 97.170451,78.039098,99.045536,27.176178

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

    • center

      GetStaticMapRequest.Builder center(String center)

      Takes in a pair of coordinates, [Lon, Lat], which becomes the center point of the image. This parameter requires that either zoom or radius is set.

      Cannot be used with Zoom and or Radius

      Example: 49.295,-123.108

      Parameters:
      center - Takes in a pair of coordinates, [Lon, Lat], which becomes the center point of the image. This parameter requires that either zoom or radius is set.

      Cannot be used with Zoom and or Radius

      Example: 49.295,-123.108

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

    • colorScheme

      GetStaticMapRequest.Builder colorScheme(String colorScheme)

      Sets color tone for map, such as dark and light for specific map styles. It only applies to vector map styles, such as Standard.

      Example: Light

      Default value: Light

      Valid values for ColorScheme are case sensitive.

      Parameters:
      colorScheme - Sets color tone for map, such as dark and light for specific map styles. It only applies to vector map styles, such as Standard.

      Example: Light

      Default value: Light

      Valid values for ColorScheme are case sensitive.

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

    • colorScheme

      GetStaticMapRequest.Builder colorScheme(ColorScheme colorScheme)

      Sets color tone for map, such as dark and light for specific map styles. It only applies to vector map styles, such as Standard.

      Example: Light

      Default value: Light

      Valid values for ColorScheme are case sensitive.

      Parameters:
      colorScheme - Sets color tone for map, such as dark and light for specific map styles. It only applies to vector map styles, such as Standard.

      Example: Light

      Default value: Light

      Valid values for ColorScheme are case sensitive.

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

    • compactOverlay

      GetStaticMapRequest.Builder compactOverlay(String compactOverlay)

      Takes in a string to draw geometries on the image. The input is a comma separated format as follows format: [Lon, Lat]

      Example: line:-122.407653,37.798557,-122.413291,37.802443;color=%23DD0000;width=7;outline-color=#00DD00;outline-width=5yd|point:-122.40572,37.80004;label=Fog Hill Market;size=large;text-color=%23DD0000;color=#EE4B2B

      Currently it supports the following geometry types: point, line and polygon. It does not support multiPoint , multiLine and multiPolgyon.

      Parameters:
      compactOverlay - Takes in a string to draw geometries on the image. The input is a comma separated format as follows format: [Lon, Lat]

      Example: line:-122.407653,37.798557,-122.413291,37.802443;color=%23DD0000;width=7;outline-color=#00DD00;outline-width=5yd|point:-122.40572,37.80004;label=Fog Hill Market;size=large;text-color=%23DD0000;color=#EE4B2B

      Currently it supports the following geometry types: point, line and polygon. It does not support multiPoint , multiLine and multiPolgyon.

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

    • cropLabels

      GetStaticMapRequest.Builder cropLabels(Boolean cropLabels)

      It is a flag that takes in true or false. It prevents the labels that are on the edge of the image from being cut or obscured.

      Parameters:
      cropLabels - It is a flag that takes in true or false. It prevents the labels that are on the edge of the image from being cut or obscured.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • geoJsonOverlay

      GetStaticMapRequest.Builder geoJsonOverlay(String geoJsonOverlay)

      Takes in a string to draw geometries on the image. The input is a valid GeoJSON collection object.

      Example: {"type":"FeatureCollection","features": [{"type":"Feature","geometry":{"type":"MultiPoint","coordinates": [[-90.076345,51.504107],[-0.074451,51.506892]]},"properties": {"color":"#00DD00"}}]}

      Parameters:
      geoJsonOverlay - Takes in a string to draw geometries on the image. The input is a valid GeoJSON collection object.

      Example: {"type":"FeatureCollection","features": [{"type":"Feature","geometry":{"type":"MultiPoint","coordinates": [[-90.076345,51.504107],[-0.074451,51.506892]]},"properties": {"color":"#00DD00"}}]}

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

    • height

      GetStaticMapRequest.Builder height(Integer height)

      Specifies the height of the map image.

      Parameters:
      height - Specifies the height of the map image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • key

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

    • labelSize

      GetStaticMapRequest.Builder labelSize(String labelSize)

      Overrides the label size auto-calculated by FileName. Takes in one of the values - Small or Large.

      Parameters:
      labelSize - Overrides the label size auto-calculated by FileName. Takes in one of the values - Small or Large.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • labelSize

      GetStaticMapRequest.Builder labelSize(LabelSize labelSize)

      Overrides the label size auto-calculated by FileName. Takes in one of the values - Small or Large.

      Parameters:
      labelSize - Overrides the label size auto-calculated by FileName. Takes in one of the values - Small or Large.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • language

      GetStaticMapRequest.Builder language(String language)

      Specifies the language on the map labels using the BCP 47 language tag, limited to ISO 639-1 two-letter language codes. If the specified language data isn't available for the map image, the labels will default to the regional primary language.

      Supported codes:

      • ar

      • as

      • az

      • be

      • bg

      • bn

      • bs

      • ca

      • cs

      • cy

      • da

      • de

      • el

      • en

      • es

      • et

      • eu

      • fi

      • fo

      • fr

      • ga

      • gl

      • gn

      • gu

      • he

      • hi

      • hr

      • hu

      • hy

      • id

      • is

      • it

      • ja

      • ka

      • kk

      • km

      • kn

      • ko

      • ky

      • lt

      • lv

      • mk

      • ml

      • mr

      • ms

      • mt

      • my

      • nl

      • no

      • or

      • pa

      • pl

      • pt

      • ro

      • ru

      • sk

      • sl

      • sq

      • sr

      • sv

      • ta

      • te

      • th

      • tr

      • uk

      • uz

      • vi

      • zh

      Parameters:
      language - Specifies the language on the map labels using the BCP 47 language tag, limited to ISO 639-1 two-letter language codes. If the specified language data isn't available for the map image, the labels will default to the regional primary language.

      Supported codes:

      • ar

      • as

      • az

      • be

      • bg

      • bn

      • bs

      • ca

      • cs

      • cy

      • da

      • de

      • el

      • en

      • es

      • et

      • eu

      • fi

      • fo

      • fr

      • ga

      • gl

      • gn

      • gu

      • he

      • hi

      • hr

      • hu

      • hy

      • id

      • is

      • it

      • ja

      • ka

      • kk

      • km

      • kn

      • ko

      • ky

      • lt

      • lv

      • mk

      • ml

      • mr

      • ms

      • mt

      • my

      • nl

      • no

      • or

      • pa

      • pl

      • pt

      • ro

      • ru

      • sk

      • sl

      • sq

      • sr

      • sv

      • ta

      • te

      • th

      • tr

      • uk

      • uz

      • vi

      • zh

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

    • padding

      GetStaticMapRequest.Builder padding(Integer padding)

      Applies additional space (in pixels) around overlay feature to prevent them from being cut or obscured.

      Value for max and min is determined by:

      Min: 1

      Max: min(height, width)/4

      Example: 100

      Parameters:
      padding - Applies additional space (in pixels) around overlay feature to prevent them from being cut or obscured.

      Value for max and min is determined by:

      Min: 1

      Max: min(height, width)/4

      Example: 100

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

    • politicalView

      GetStaticMapRequest.Builder politicalView(String politicalView)

      Specifies the political view, using ISO 3166-2 or ISO 3166-3 country code format.

      The following political views are currently supported:

      • ARG: Argentina's view on the Southern Patagonian Ice Field and Tierra Del Fuego, including the Falkland Islands, South Georgia, and South Sandwich Islands

      • EGY: Egypt's view on Bir Tawil

      • IND: India's view on Gilgit-Baltistan

      • KEN: Kenya's view on the Ilemi Triangle

      • MAR: Morocco's view on Western Sahara

      • RUS: Russia's view on Crimea

      • SDN: Sudan's view on the Halaib Triangle

      • SRB: Serbia's view on Kosovo, Vukovar, and Sarengrad Islands

      • SUR: Suriname's view on the Courantyne Headwaters and Lawa Headwaters

      • SYR: Syria's view on the Golan Heights

      • TUR: Turkey's view on Cyprus and Northern Cyprus

      • TZA: Tanzania's view on Lake Malawi

      • URY: Uruguay's view on Rincon de Artigas

      • VNM: Vietnam's view on the Paracel Islands and Spratly Islands

      Parameters:
      politicalView - Specifies the political view, using ISO 3166-2 or ISO 3166-3 country code format.

      The following political views are currently supported:

      • ARG: Argentina's view on the Southern Patagonian Ice Field and Tierra Del Fuego, including the Falkland Islands, South Georgia, and South Sandwich Islands

      • EGY: Egypt's view on Bir Tawil

      • IND: India's view on Gilgit-Baltistan

      • KEN: Kenya's view on the Ilemi Triangle

      • MAR: Morocco's view on Western Sahara

      • RUS: Russia's view on Crimea

      • SDN: Sudan's view on the Halaib Triangle

      • SRB: Serbia's view on Kosovo, Vukovar, and Sarengrad Islands

      • SUR: Suriname's view on the Courantyne Headwaters and Lawa Headwaters

      • SYR: Syria's view on the Golan Heights

      • TUR: Turkey's view on Cyprus and Northern Cyprus

      • TZA: Tanzania's view on Lake Malawi

      • URY: Uruguay's view on Rincon de Artigas

      • VNM: Vietnam's view on the Paracel Islands and Spratly Islands

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

    • pointsOfInterests

      GetStaticMapRequest.Builder pointsOfInterests(String pointsOfInterests)

      Determines if the result image will display icons representing points of interest on the map.

      Parameters:
      pointsOfInterests - Determines if the result image will display icons representing points of interest on the map.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • pointsOfInterests

      GetStaticMapRequest.Builder pointsOfInterests(MapFeatureMode pointsOfInterests)

      Determines if the result image will display icons representing points of interest on the map.

      Parameters:
      pointsOfInterests - Determines if the result image will display icons representing points of interest on the map.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • radius

      GetStaticMapRequest.Builder radius(Long radius)

      Used with center parameter, it specifies the zoom of the image where you can control it on a granular level. Takes in any value >= 1.

      Example: 1500

      Cannot be used with Zoom.

      Unit: Meters

      Parameters:
      radius - Used with center parameter, it specifies the zoom of the image where you can control it on a granular level. Takes in any value >= 1.

      Example: 1500

      Cannot be used with Zoom.

      Unit: Meters

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

    • fileName

      GetStaticMapRequest.Builder fileName(String fileName)

      The map scaling parameter to size the image, icons, and labels. It follows the pattern of ^map(@2x)?$.

      Example: map, map@2x

      Parameters:
      fileName - The map scaling parameter to size the image, icons, and labels. It follows the pattern of ^map(@2x)?$.

      Example: map, map@2x

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

    • scaleBarUnit

      GetStaticMapRequest.Builder scaleBarUnit(String scaleBarUnit)

      Displays a scale on the bottom right of the map image with the unit specified in the input.

      Example: KilometersMiles, Miles, Kilometers, MilesKilometers

      Parameters:
      scaleBarUnit - Displays a scale on the bottom right of the map image with the unit specified in the input.

      Example: KilometersMiles, Miles, Kilometers, MilesKilometers

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

    • scaleBarUnit

      GetStaticMapRequest.Builder scaleBarUnit(ScaleBarUnit scaleBarUnit)

      Displays a scale on the bottom right of the map image with the unit specified in the input.

      Example: KilometersMiles, Miles, Kilometers, MilesKilometers

      Parameters:
      scaleBarUnit - Displays a scale on the bottom right of the map image with the unit specified in the input.

      Example: KilometersMiles, Miles, Kilometers, MilesKilometers

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

    • style

      GetStaticMapRequest.Builder style(String style)

      Style specifies the desired map style.

      Parameters:
      style - Style specifies the desired map style.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • style

      GetStaticMapRequest.Builder style(StaticMapStyle style)

      Style specifies the desired map style.

      Parameters:
      style - Style specifies the desired map style.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • width

      GetStaticMapRequest.Builder width(Integer width)

      Specifies the width of the map image.

      Parameters:
      width - Specifies the width of the map image.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • zoom

      GetStaticMapRequest.Builder zoom(Float zoom)

      Specifies the zoom level of the map image.

      Cannot be used with Radius.

      Parameters:
      zoom - Specifies the zoom level of the map image.

      Cannot be used with Radius.

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

    • overrideConfiguration

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

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