Class GetStaticMapRequest

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

  • Method Details

    • boundingBox

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

      Returns:
      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

    • boundedPositions

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

      Returns:
      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

    • center

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

      Returns:
      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

    • colorScheme

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

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

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

      See Also:

    • colorSchemeAsString

      public final String colorSchemeAsString()

      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.

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

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

      See Also:

    • compactOverlay

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

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

    • cropLabels

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

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

    • geoJsonOverlay

      public final 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"}}]}

      Returns:
      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"}}]}

    • height

      public final Integer height()

      Specifies the height of the map image.

      Returns:
      Specifies the height of the map image.

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

    • labelSize

      public final LabelSize labelSize()

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

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

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

    • labelSizeAsString

      public final String labelSizeAsString()

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

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

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

    • language

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

      Returns:
      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

    • padding

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

      Returns:
      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

    • politicalView

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

      Returns:
      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

    • pointsOfInterests

      public final MapFeatureMode pointsOfInterests()

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

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

      Returns:
      Determines if the result image will display icons representing points of interest on the map.
      See Also:

    • pointsOfInterestsAsString

      public final String pointsOfInterestsAsString()

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

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

      Returns:
      Determines if the result image will display icons representing points of interest on the map.
      See Also:

    • radius

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

      Returns:
      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

    • fileName

      public final String fileName()

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

      Example: map, map@2x

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

      Example: map, map@2x

    • scaleBarUnit

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

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

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

      Example: KilometersMiles, Miles, Kilometers, MilesKilometers

      See Also:

    • scaleBarUnitAsString

      public final String scaleBarUnitAsString()

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

      Example: KilometersMiles, Miles, Kilometers, MilesKilometers

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

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

      Example: KilometersMiles, Miles, Kilometers, MilesKilometers

      See Also:

    • style

      public final StaticMapStyle style()

      Style specifies the desired map style.

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

      Returns:
      Style specifies the desired map style.
      See Also:

    • styleAsString

      public final String styleAsString()

      Style specifies the desired map style.

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

      Returns:
      Style specifies the desired map style.
      See Also:

    • width

      public final Integer width()

      Specifies the width of the map image.

      Returns:
      Specifies the width of the map image.

    • zoom

      public final Float zoom()

      Specifies the zoom level of the map image.

      Cannot be used with Radius.

      Returns:
      Specifies the zoom level of the map image.

      Cannot be used with Radius.

    • toBuilder

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

    • builder

      public static GetStaticMapRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetStaticMapRequest.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.