Struct GetStaticMapInputBuilder

#[non_exhaustive]
pub struct GetStaticMapInputBuilder { /* private fields */ }

A builder for GetStaticMapInput.

Implementations

impl GetStaticMapInputBuilder

pub fn bounding_box(self, input: impl Into<String>) -> Self

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

pub fn set_bounding_box(self, input: Option<String>) -> Self

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

pub fn get_bounding_box(&self) -> &Option<String>

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

pub fn bounded_positions(self, input: impl Into<String>) -> Self

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

pub fn set_bounded_positions(self, input: Option<String>) -> Self

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

pub fn get_bounded_positions(&self) -> &Option<String>

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

pub fn center(self, input: impl Into<String>) -> Self

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

pub fn set_center(self, input: Option<String>) -> Self

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

pub fn get_center(&self) -> &Option<String>

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

pub fn compact_overlay(self, input: impl Into<String>) -> Self

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.

pub fn set_compact_overlay(self, input: Option<String>) -> Self

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.

pub fn get_compact_overlay(&self) -> &Option<String>

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.

pub fn geo_json_overlay(self, input: impl Into<String>) -> Self

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"}}\]}

pub fn set_geo_json_overlay(self, input: Option<String>) -> Self

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"}}\]}

pub fn get_geo_json_overlay(&self) -> &Option<String>

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"}}\]}

pub fn height(self, input: i32) -> Self

Specifies the height of the map image.

This field is required.

pub fn set_height(self, input: Option<i32>) -> Self

Specifies the height of the map image.

pub fn get_height(&self) -> &Option<i32>

Specifies the height of the map image.

pub fn key(self, input: impl Into<String>) -> Self

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

pub fn set_key(self, input: Option<String>) -> Self

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

pub fn get_key(&self) -> &Option<String>

Optional: The API key to be used for authorization. Either an API key or valid SigV4 signature must be provided when making a request.

pub fn padding(self, input: i32) -> Self

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

pub fn set_padding(self, input: Option<i32>) -> Self

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

pub fn get_padding(&self) -> &Option<i32>

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

pub fn radius(self, input: i64) -> Self

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

pub fn set_radius(self, input: Option<i64>) -> Self

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

pub fn get_radius(&self) -> &Option<i64>

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

pub fn file_name(self, input: impl Into<String>) -> Self

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

Example: map, map@2x

This field is required.

pub fn set_file_name(self, input: Option<String>) -> Self

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

Example: map, map@2x

pub fn get_file_name(&self) -> &Option<String>

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

Example: map, map@2x

pub fn scale_bar_unit(self, input: ScaleBarUnit) -> Self

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

Example: KilometersMiles, Miles, Kilometers, MilesKilometers

pub fn set_scale_bar_unit(self, input: Option<ScaleBarUnit>) -> Self

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

Example: KilometersMiles, Miles, Kilometers, MilesKilometers

pub fn get_scale_bar_unit(&self) -> &Option<ScaleBarUnit>

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

Example: KilometersMiles, Miles, Kilometers, MilesKilometers

pub fn style(self, input: StaticMapStyle) -> Self

Style specifies the desired map style for the Style APIs.

pub fn set_style(self, input: Option<StaticMapStyle>) -> Self

Style specifies the desired map style for the Style APIs.

pub fn get_style(&self) -> &Option<StaticMapStyle>

Style specifies the desired map style for the Style APIs.

pub fn width(self, input: i32) -> Self

Specifies the width of the map image.

This field is required.

pub fn set_width(self, input: Option<i32>) -> Self

Specifies the width of the map image.

pub fn get_width(&self) -> &Option<i32>

Specifies the width of the map image.

pub fn zoom(self, input: f32) -> Self

Specifies the zoom level of the map image.

Cannot be used with Radius.

pub fn set_zoom(self, input: Option<f32>) -> Self

Specifies the zoom level of the map image.

Cannot be used with Radius.

pub fn get_zoom(&self) -> &Option<f32>

Specifies the zoom level of the map image.

Cannot be used with Radius.

pub fn build(self) -> Result<GetStaticMapInput, BuildError>

Consumes the builder and constructs a GetStaticMapInput.

impl GetStaticMapInputBuilder

pub async fn send_with( self, client: &Client, ) -> Result<GetStaticMapOutput, SdkError<GetStaticMapError, HttpResponse>>

Sends a request with this input using the given client.

Trait Implementations

impl Clone for GetStaticMapInputBuilder

fn clone(&self) -> GetStaticMapInputBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GetStaticMapInputBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GetStaticMapInputBuilder

fn default() -> GetStaticMapInputBuilder

Returns the “default value” for a type.

impl PartialEq for GetStaticMapInputBuilder

fn eq(&self, other: &GetStaticMapInputBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for GetStaticMapInputBuilder