aws-sdk-location 1.42.0

AWS SDK for Amazon Location Service
Documentation
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq)]
pub struct GetMapSpritesInput {
    /// <p>The map resource associated with the sprite file.</p>
    pub map_name: ::std::option::Option<::std::string::String>,
    /// <p>The name of the sprite file. Use the following file names for the sprite sheet:</p>
    /// <ul>
    /// <li>
    /// <p><code>sprites.png</code></p></li>
    /// <li>
    /// <p><code>sprites@2x.png</code> for high pixel density displays</p></li>
    /// </ul>
    /// <p>For the JSON document containing image offsets. Use the following file names:</p>
    /// <ul>
    /// <li>
    /// <p><code>sprites.json</code></p></li>
    /// <li>
    /// <p><code>sprites@2x.json</code> for high pixel density displays</p></li>
    /// </ul>
    pub file_name: ::std::option::Option<::std::string::String>,
    /// <p>The optional <a href="https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html">API key</a> to authorize the request.</p>
    pub key: ::std::option::Option<::std::string::String>,
}
impl GetMapSpritesInput {
    /// <p>The map resource associated with the sprite file.</p>
    pub fn map_name(&self) -> ::std::option::Option<&str> {
        self.map_name.as_deref()
    }
    /// <p>The name of the sprite file. Use the following file names for the sprite sheet:</p>
    /// <ul>
    /// <li>
    /// <p><code>sprites.png</code></p></li>
    /// <li>
    /// <p><code>sprites@2x.png</code> for high pixel density displays</p></li>
    /// </ul>
    /// <p>For the JSON document containing image offsets. Use the following file names:</p>
    /// <ul>
    /// <li>
    /// <p><code>sprites.json</code></p></li>
    /// <li>
    /// <p><code>sprites@2x.json</code> for high pixel density displays</p></li>
    /// </ul>
    pub fn file_name(&self) -> ::std::option::Option<&str> {
        self.file_name.as_deref()
    }
    /// <p>The optional <a href="https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html">API key</a> to authorize the request.</p>
    pub fn key(&self) -> ::std::option::Option<&str> {
        self.key.as_deref()
    }
}
impl ::std::fmt::Debug for GetMapSpritesInput {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("GetMapSpritesInput");
        formatter.field("map_name", &self.map_name);
        formatter.field("file_name", &self.file_name);
        formatter.field("key", &"*** Sensitive Data Redacted ***");
        formatter.finish()
    }
}
impl GetMapSpritesInput {
    /// Creates a new builder-style object to manufacture [`GetMapSpritesInput`](crate::operation::get_map_sprites::GetMapSpritesInput).
    pub fn builder() -> crate::operation::get_map_sprites::builders::GetMapSpritesInputBuilder {
        crate::operation::get_map_sprites::builders::GetMapSpritesInputBuilder::default()
    }
}

/// A builder for [`GetMapSpritesInput`](crate::operation::get_map_sprites::GetMapSpritesInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default)]
#[non_exhaustive]
pub struct GetMapSpritesInputBuilder {
    pub(crate) map_name: ::std::option::Option<::std::string::String>,
    pub(crate) file_name: ::std::option::Option<::std::string::String>,
    pub(crate) key: ::std::option::Option<::std::string::String>,
}
impl GetMapSpritesInputBuilder {
    /// <p>The map resource associated with the sprite file.</p>
    /// This field is required.
    pub fn map_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.map_name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The map resource associated with the sprite file.</p>
    pub fn set_map_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.map_name = input;
        self
    }
    /// <p>The map resource associated with the sprite file.</p>
    pub fn get_map_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.map_name
    }
    /// <p>The name of the sprite file. Use the following file names for the sprite sheet:</p>
    /// <ul>
    /// <li>
    /// <p><code>sprites.png</code></p></li>
    /// <li>
    /// <p><code>sprites@2x.png</code> for high pixel density displays</p></li>
    /// </ul>
    /// <p>For the JSON document containing image offsets. Use the following file names:</p>
    /// <ul>
    /// <li>
    /// <p><code>sprites.json</code></p></li>
    /// <li>
    /// <p><code>sprites@2x.json</code> for high pixel density displays</p></li>
    /// </ul>
    /// This field is required.
    pub fn file_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.file_name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The name of the sprite file. Use the following file names for the sprite sheet:</p>
    /// <ul>
    /// <li>
    /// <p><code>sprites.png</code></p></li>
    /// <li>
    /// <p><code>sprites@2x.png</code> for high pixel density displays</p></li>
    /// </ul>
    /// <p>For the JSON document containing image offsets. Use the following file names:</p>
    /// <ul>
    /// <li>
    /// <p><code>sprites.json</code></p></li>
    /// <li>
    /// <p><code>sprites@2x.json</code> for high pixel density displays</p></li>
    /// </ul>
    pub fn set_file_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.file_name = input;
        self
    }
    /// <p>The name of the sprite file. Use the following file names for the sprite sheet:</p>
    /// <ul>
    /// <li>
    /// <p><code>sprites.png</code></p></li>
    /// <li>
    /// <p><code>sprites@2x.png</code> for high pixel density displays</p></li>
    /// </ul>
    /// <p>For the JSON document containing image offsets. Use the following file names:</p>
    /// <ul>
    /// <li>
    /// <p><code>sprites.json</code></p></li>
    /// <li>
    /// <p><code>sprites@2x.json</code> for high pixel density displays</p></li>
    /// </ul>
    pub fn get_file_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.file_name
    }
    /// <p>The optional <a href="https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html">API key</a> to authorize the request.</p>
    pub fn key(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.key = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The optional <a href="https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html">API key</a> to authorize the request.</p>
    pub fn set_key(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.key = input;
        self
    }
    /// <p>The optional <a href="https://docs.aws.amazon.com/location/latest/developerguide/using-apikeys.html">API key</a> to authorize the request.</p>
    pub fn get_key(&self) -> &::std::option::Option<::std::string::String> {
        &self.key
    }
    /// Consumes the builder and constructs a [`GetMapSpritesInput`](crate::operation::get_map_sprites::GetMapSpritesInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::get_map_sprites::GetMapSpritesInput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::get_map_sprites::GetMapSpritesInput {
            map_name: self.map_name,
            file_name: self.file_name,
            key: self.key,
        })
    }
}
impl ::std::fmt::Debug for GetMapSpritesInputBuilder {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("GetMapSpritesInputBuilder");
        formatter.field("map_name", &self.map_name);
        formatter.field("file_name", &self.file_name);
        formatter.field("key", &"*** Sensitive Data Redacted ***");
        formatter.finish()
    }
}