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.
pub use crate::operation::start_job::_start_job_input::StartJobInputBuilder;

pub use crate::operation::start_job::_start_job_output::StartJobOutputBuilder;

impl crate::operation::start_job::builders::StartJobInputBuilder {
    /// Sends a request with this input using the given client.
    pub async fn send_with(
        self,
        client: &crate::Client,
    ) -> ::std::result::Result<
        crate::operation::start_job::StartJobOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::start_job::StartJobError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let mut fluent_builder = client.start_job();
        fluent_builder.inner = self;
        fluent_builder.send().await
    }
}
/// Fluent builder constructing a request to `StartJob`.
///
/// <p><code>StartJob</code> starts a new asynchronous bulk processing job. You specify the input data location in Amazon S3, the action to perform, and the output location where results are written.</p>
/// <p>For more information, see <a href="https://docs.aws.amazon.com/location/latest/developerguide/jobs-concepts.html">Job concepts</a> in the <i>Amazon Location Service Developer Guide</i>.</p>
#[derive(::std::clone::Clone, ::std::fmt::Debug)]
pub struct StartJobFluentBuilder {
    handle: ::std::sync::Arc<crate::client::Handle>,
    inner: crate::operation::start_job::builders::StartJobInputBuilder,
    config_override: ::std::option::Option<crate::config::Builder>,
}
impl crate::client::customize::internal::CustomizableSend<crate::operation::start_job::StartJobOutput, crate::operation::start_job::StartJobError>
    for StartJobFluentBuilder
{
    fn send(
        self,
        config_override: crate::config::Builder,
    ) -> crate::client::customize::internal::BoxFuture<
        crate::client::customize::internal::SendResult<crate::operation::start_job::StartJobOutput, crate::operation::start_job::StartJobError>,
    > {
        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
    }
}
impl StartJobFluentBuilder {
    /// Creates a new `StartJobFluentBuilder`.
    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
        Self {
            handle,
            inner: ::std::default::Default::default(),
            config_override: ::std::option::Option::None,
        }
    }
    /// Access the StartJob as a reference.
    pub fn as_input(&self) -> &crate::operation::start_job::builders::StartJobInputBuilder {
        &self.inner
    }
    /// Sends the request and returns the response.
    ///
    /// If an error occurs, an `SdkError` will be returned with additional details that
    /// can be matched against.
    ///
    /// By default, any retryable failures will be retried twice. Retry behavior
    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
    /// set when configuring the client.
    pub async fn send(
        self,
    ) -> ::std::result::Result<
        crate::operation::start_job::StartJobOutput,
        ::aws_smithy_runtime_api::client::result::SdkError<
            crate::operation::start_job::StartJobError,
            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
        >,
    > {
        let input = self
            .inner
            .build()
            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
        let runtime_plugins = crate::operation::start_job::StartJob::operation_runtime_plugins(
            self.handle.runtime_plugins.clone(),
            &self.handle.conf,
            self.config_override,
        );
        crate::operation::start_job::StartJob::orchestrate(&runtime_plugins, input).await
    }

    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
    pub fn customize(
        self,
    ) -> crate::client::customize::CustomizableOperation<crate::operation::start_job::StartJobOutput, crate::operation::start_job::StartJobError, Self>
    {
        crate::client::customize::CustomizableOperation::new(self)
    }
    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
        self.set_config_override(::std::option::Option::Some(config_override.into()));
        self
    }

    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
        self.config_override = config_override;
        self
    }
    /// <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.inner = self.inner.client_token(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.inner = self.inner.set_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.inner.get_client_token()
    }
    /// <p>The action to perform on the input data.</p>
    pub fn action(mut self, input: crate::types::JobAction) -> Self {
        self.inner = self.inner.action(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.inner = self.inner.set_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.inner.get_action()
    }
    /// <p>Additional parameters that can be requested for each result.</p>
    pub fn action_options(mut self, input: crate::types::JobActionOptions) -> Self {
        self.inner = self.inner.action_options(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.inner = self.inner.set_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.inner.get_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>
    pub fn execution_role_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.inner = self.inner.execution_role_arn(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.inner = self.inner.set_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.inner.get_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>
    pub fn input_options(mut self, input: crate::types::JobInputOptions) -> Self {
        self.inner = self.inner.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 set_input_options(mut self, input: ::std::option::Option<crate::types::JobInputOptions>) -> Self {
        self.inner = self.inner.set_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.inner.get_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.inner = self.inner.name(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.inner = self.inner.set_name(input);
        self
    }
    /// <p>An optional name for the job resource.</p>
    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
        self.inner.get_name()
    }
    /// <p>Configuration for output data location and format.</p>
    pub fn output_options(mut self, input: crate::types::JobOutputOptions) -> Self {
        self.inner = self.inner.output_options(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.inner = self.inner.set_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.inner.get_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 {
        self.inner = self.inner.tags(k.into(), v.into());
        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.inner = self.inner.set_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.inner.get_tags()
    }
}