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>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface GetStaticMapRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`boundedPositions()`	Takes in two or more pair of coordinates, [Lon, Lat], with each coordinate separated by a comma.
`String`	`boundingBox()`	Takes in two pairs of coordinates, [Lon, Lat], denoting south-westerly and north-easterly edges of the image.
`static GetStaticMapRequest.Builder`	`builder()`
`String`	`center()`	Takes in a pair of coordinates, [Lon, Lat], which becomes the center point of the image.
`String`	`compactOverlay()`	Takes in a string to draw geometries on the image.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`fileName()`	The map scaling parameter to size the image, icons, and labels.
`String`	`geoJsonOverlay()`	Takes in a string to draw geometries on the image.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Integer`	`height()`	Specifies the height of the map image.
`String`	`key()`	Optional: The API key to be used for authorization.
`Integer`	`padding()`	Applies additional space (in pixels) around overlay feature to prevent them from being cut or obscured.
`Long`	`radius()`	Used with center parameter, it specifies the zoom of the image where you can control it on a granular level.
`ScaleBarUnit`	`scaleBarUnit()`	Displays a scale on the bottom right of the map image with the unit specified in the input.
`String`	`scaleBarUnitAsString()`	Displays a scale on the bottom right of the map image with the unit specified in the input.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetStaticMapRequest.Builder>`	`serializableBuilderClass()`
`StaticMapStyle`	`style()`	Style specifies the desired map style for the `Style` APIs.
`String`	`styleAsString()`	Style specifies the desired map style for the `Style` APIs.
`GetStaticMapRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`Integer`	`width()`	Specifies the width of the map image.
`Float`	`zoom()`	Specifies the zoom level of the map image.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - 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
  - 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.
  - 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.
  - 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
  - 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:
    
    ScaleBarUnit
  - 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:
    
    ScaleBarUnit
  - style
```
public final StaticMapStyle style()
```
    Style specifies the desired map style for the Style APIs.
    
    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 for the Style APIs.
    
    See Also:
    
    StaticMapStyle
  - styleAsString
```
public final String styleAsString()
```
    Style specifies the desired map style for the Style APIs.
    
    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 for the Style APIs.
    
    See Also:
    
    StaticMapStyle
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetStaticMapRequest.Builder,GetStaticMapRequest>
    
    Specified by:
    
    toBuilder in class GeoMapsRequest
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class GetStaticMapRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

boundingBox

boundedPositions

center

compactOverlay

geoJsonOverlay

height

key

padding

radius

fileName

scaleBarUnit

scaleBarUnitAsString

style

styleAsString

width

zoom

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField