aws-sdk-location 1.103.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, ::std::fmt::Debug)]
pub struct StartJobInput {
    /// <p>A unique identifier for this request to ensure idempotency.</p>
    pub client_token: ::std::option::Option<::std::string::String>,
    /// <p>The action to perform on the input data.</p>
    pub action: ::std::option::Option<crate::types::JobAction>,
    /// <p>Additional parameters that can be requested for each result.</p>
    pub action_options: ::std::option::Option<crate::types::JobActionOptions>,
    /// <p>The Amazon Resource Name (ARN) of the IAM role that Amazon Location Service assumes during job processing. Amazon Location Service uses this role to access the input and output locations specified for the job.</p><note>
    /// <p>The IAM role must be created in the same Amazon Web Services account where you plan to run your job.</p>
    /// </note>
    /// <p>For more information about configuring IAM roles for Amazon Location jobs, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/configure-iam-role-policy-credentials.html">Configure IAM permissions</a> in the <i>Amazon Location Service Developer Guide</i>.</p>
    pub execution_role_arn: ::std::option::Option<::std::string::String>,
    /// <p>Configuration for input data location and format.</p><note>
    /// <p>Input files have a limitation of 10gb per file, and 1gb per Parquet row-group within the file.</p>
    /// </note>
    pub input_options: ::std::option::Option<crate::types::JobInputOptions>,
    /// <p>An optional name for the job resource.</p>
    pub name: ::std::option::Option<::std::string::String>,
    /// <p>Configuration for output data location and format.</p>
    pub output_options: ::std::option::Option<crate::types::JobOutputOptions>,
    /// <p>Tags and corresponding values to be associated with the job.</p>
    pub tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
}
impl StartJobInput {
    /// <p>A unique identifier for this request to ensure idempotency.</p>
    pub fn client_token(&self) -> ::std::option::Option<&str> {
        self.client_token.as_deref()
    }
    /// <p>The action to perform on the input data.</p>
    pub fn action(&self) -> ::std::option::Option<&crate::types::JobAction> {
        self.action.as_ref()
    }
    /// <p>Additional parameters that can be requested for each result.</p>
    pub fn action_options(&self) -> ::std::option::Option<&crate::types::JobActionOptions> {
        self.action_options.as_ref()
    }
    /// <p>The Amazon Resource Name (ARN) of the IAM role that Amazon Location Service assumes during job processing. Amazon Location Service uses this role to access the input and output locations specified for the job.</p><note>
    /// <p>The IAM role must be created in the same Amazon Web Services account where you plan to run your job.</p>
    /// </note>
    /// <p>For more information about configuring IAM roles for Amazon Location jobs, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/configure-iam-role-policy-credentials.html">Configure IAM permissions</a> in the <i>Amazon Location Service Developer Guide</i>.</p>
    pub fn execution_role_arn(&self) -> ::std::option::Option<&str> {
        self.execution_role_arn.as_deref()
    }
    /// <p>Configuration for input data location and format.</p><note>
    /// <p>Input files have a limitation of 10gb per file, and 1gb per Parquet row-group within the file.</p>
    /// </note>
    pub fn input_options(&self) -> ::std::option::Option<&crate::types::JobInputOptions> {
        self.input_options.as_ref()
    }
    /// <p>An optional name for the job resource.</p>
    pub fn name(&self) -> ::std::option::Option<&str> {
        self.name.as_deref()
    }
    /// <p>Configuration for output data location and format.</p>
    pub fn output_options(&self) -> ::std::option::Option<&crate::types::JobOutputOptions> {
        self.output_options.as_ref()
    }
    /// <p>Tags and corresponding values to be associated with the job.</p>
    pub fn tags(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, ::std::string::String>> {
        self.tags.as_ref()
    }
}
impl StartJobInput {
    /// Creates a new builder-style object to manufacture [`StartJobInput`](crate::operation::start_job::StartJobInput).
    pub fn builder() -> crate::operation::start_job::builders::StartJobInputBuilder {
        crate::operation::start_job::builders::StartJobInputBuilder::default()
    }
}

/// A builder for [`StartJobInput`](crate::operation::start_job::StartJobInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct StartJobInputBuilder {
    pub(crate) client_token: ::std::option::Option<::std::string::String>,
    pub(crate) action: ::std::option::Option<crate::types::JobAction>,
    pub(crate) action_options: ::std::option::Option<crate::types::JobActionOptions>,
    pub(crate) execution_role_arn: ::std::option::Option<::std::string::String>,
    pub(crate) input_options: ::std::option::Option<crate::types::JobInputOptions>,
    pub(crate) name: ::std::option::Option<::std::string::String>,
    pub(crate) output_options: ::std::option::Option<crate::types::JobOutputOptions>,
    pub(crate) tags: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
}
impl StartJobInputBuilder {
    /// <p>A unique identifier for this request to ensure idempotency.</p>
    pub fn client_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.client_token = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>A unique identifier for this request to ensure idempotency.</p>
    pub fn set_client_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.client_token = input;
        self
    }
    /// <p>A unique identifier for this request to ensure idempotency.</p>
    pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
        &self.client_token
    }
    /// <p>The action to perform on the input data.</p>
    /// This field is required.
    pub fn action(mut self, input: crate::types::JobAction) -> Self {
        self.action = ::std::option::Option::Some(input);
        self
    }
    /// <p>The action to perform on the input data.</p>
    pub fn set_action(mut self, input: ::std::option::Option<crate::types::JobAction>) -> Self {
        self.action = input;
        self
    }
    /// <p>The action to perform on the input data.</p>
    pub fn get_action(&self) -> &::std::option::Option<crate::types::JobAction> {
        &self.action
    }
    /// <p>Additional parameters that can be requested for each result.</p>
    pub fn action_options(mut self, input: crate::types::JobActionOptions) -> Self {
        self.action_options = ::std::option::Option::Some(input);
        self
    }
    /// <p>Additional parameters that can be requested for each result.</p>
    pub fn set_action_options(mut self, input: ::std::option::Option<crate::types::JobActionOptions>) -> Self {
        self.action_options = input;
        self
    }
    /// <p>Additional parameters that can be requested for each result.</p>
    pub fn get_action_options(&self) -> &::std::option::Option<crate::types::JobActionOptions> {
        &self.action_options
    }
    /// <p>The Amazon Resource Name (ARN) of the IAM role that Amazon Location Service assumes during job processing. Amazon Location Service uses this role to access the input and output locations specified for the job.</p><note>
    /// <p>The IAM role must be created in the same Amazon Web Services account where you plan to run your job.</p>
    /// </note>
    /// <p>For more information about configuring IAM roles for Amazon Location jobs, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/configure-iam-role-policy-credentials.html">Configure IAM permissions</a> in the <i>Amazon Location Service Developer Guide</i>.</p>
    /// This field is required.
    pub fn execution_role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.execution_role_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the IAM role that Amazon Location Service assumes during job processing. Amazon Location Service uses this role to access the input and output locations specified for the job.</p><note>
    /// <p>The IAM role must be created in the same Amazon Web Services account where you plan to run your job.</p>
    /// </note>
    /// <p>For more information about configuring IAM roles for Amazon Location jobs, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/configure-iam-role-policy-credentials.html">Configure IAM permissions</a> in the <i>Amazon Location Service Developer Guide</i>.</p>
    pub fn set_execution_role_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.execution_role_arn = input;
        self
    }
    /// <p>The Amazon Resource Name (ARN) of the IAM role that Amazon Location Service assumes during job processing. Amazon Location Service uses this role to access the input and output locations specified for the job.</p><note>
    /// <p>The IAM role must be created in the same Amazon Web Services account where you plan to run your job.</p>
    /// </note>
    /// <p>For more information about configuring IAM roles for Amazon Location jobs, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/configure-iam-role-policy-credentials.html">Configure IAM permissions</a> in the <i>Amazon Location Service Developer Guide</i>.</p>
    pub fn get_execution_role_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.execution_role_arn
    }
    /// <p>Configuration for input data location and format.</p><note>
    /// <p>Input files have a limitation of 10gb per file, and 1gb per Parquet row-group within the file.</p>
    /// </note>
    /// This field is required.
    pub fn input_options(mut self, input: crate::types::JobInputOptions) -> Self {
        self.input_options = ::std::option::Option::Some(input);
        self
    }
    /// <p>Configuration for input data location and format.</p><note>
    /// <p>Input files have a limitation of 10gb per file, and 1gb per Parquet row-group within the file.</p>
    /// </note>
    pub fn set_input_options(mut self, input: ::std::option::Option<crate::types::JobInputOptions>) -> Self {
        self.input_options = input;
        self
    }
    /// <p>Configuration for input data location and format.</p><note>
    /// <p>Input files have a limitation of 10gb per file, and 1gb per Parquet row-group within the file.</p>
    /// </note>
    pub fn get_input_options(&self) -> &::std::option::Option<crate::types::JobInputOptions> {
        &self.input_options
    }
    /// <p>An optional name for the job resource.</p>
    pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>An optional name for the job resource.</p>
    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.name = input;
        self
    }
    /// <p>An optional name for the job resource.</p>
    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.name
    }
    /// <p>Configuration for output data location and format.</p>
    /// This field is required.
    pub fn output_options(mut self, input: crate::types::JobOutputOptions) -> Self {
        self.output_options = ::std::option::Option::Some(input);
        self
    }
    /// <p>Configuration for output data location and format.</p>
    pub fn set_output_options(mut self, input: ::std::option::Option<crate::types::JobOutputOptions>) -> Self {
        self.output_options = input;
        self
    }
    /// <p>Configuration for output data location and format.</p>
    pub fn get_output_options(&self) -> &::std::option::Option<crate::types::JobOutputOptions> {
        &self.output_options
    }
    /// Adds a key-value pair to `tags`.
    ///
    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
    ///
    /// <p>Tags and corresponding values to be associated with the job.</p>
    pub fn tags(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
        let mut hash_map = self.tags.unwrap_or_default();
        hash_map.insert(k.into(), v.into());
        self.tags = ::std::option::Option::Some(hash_map);
        self
    }
    /// <p>Tags and corresponding values to be associated with the job.</p>
    pub fn set_tags(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
        self.tags = input;
        self
    }
    /// <p>Tags and corresponding values to be associated with the job.</p>
    pub fn get_tags(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
        &self.tags
    }
    /// Consumes the builder and constructs a [`StartJobInput`](crate::operation::start_job::StartJobInput).
    pub fn build(self) -> ::std::result::Result<crate::operation::start_job::StartJobInput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::start_job::StartJobInput {
            client_token: self.client_token,
            action: self.action,
            action_options: self.action_options,
            execution_role_arn: self.execution_role_arn,
            input_options: self.input_options,
            name: self.name,
            output_options: self.output_options,
            tags: self.tags,
        })
    }
}