aws-sdk-datazone 1.136.0

AWS SDK for Amazon DataZone
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 StartNotebookRunInput {
    /// <p>The identifier of the Amazon DataZone domain in which the notebook run is started.</p>
    pub domain_identifier: ::std::option::Option<::std::string::String>,
    /// <p>The identifier of the project that owns the notebook run.</p>
    pub owning_project_identifier: ::std::option::Option<::std::string::String>,
    /// <p>The identifier of the notebook to run.</p>
    pub notebook_identifier: ::std::option::Option<::std::string::String>,
    /// <p>The identifier of the schedule associated with the notebook run.</p>
    pub schedule_identifier: ::std::option::Option<::std::string::String>,
    /// <p>The compute configuration for the notebook run, including instance type and environment version.</p>
    pub compute_configuration: ::std::option::Option<crate::types::ComputeConfig>,
    /// <p>The network configuration for the notebook run, including network access type and optional VPC settings.</p>
    pub network_configuration: ::std::option::Option<crate::types::NetworkConfig>,
    /// <p>The timeout configuration for the notebook run. The default timeout is 720 minutes (12 hours) and the maximum is 1440 minutes (24 hours).</p>
    pub timeout_configuration: ::std::option::Option<crate::types::TimeoutConfig>,
    /// <p>The source that triggered the notebook run.</p>
    pub trigger_source: ::std::option::Option<crate::types::TriggerSource>,
    /// <p>The metadata for the notebook run, specified as key-value pairs. You can specify up to 50 entries, with keys up to 128 characters and values up to 1024 characters.</p>
    pub metadata: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
    /// <p>The sensitive parameters for the notebook run, specified as key-value pairs. You can specify up to 50 entries, with keys up to 128 characters and values up to 1024 characters.</p>
    pub parameters: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
    /// <p>A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.</p>
    pub client_token: ::std::option::Option<::std::string::String>,
}
impl StartNotebookRunInput {
    /// <p>The identifier of the Amazon DataZone domain in which the notebook run is started.</p>
    pub fn domain_identifier(&self) -> ::std::option::Option<&str> {
        self.domain_identifier.as_deref()
    }
    /// <p>The identifier of the project that owns the notebook run.</p>
    pub fn owning_project_identifier(&self) -> ::std::option::Option<&str> {
        self.owning_project_identifier.as_deref()
    }
    /// <p>The identifier of the notebook to run.</p>
    pub fn notebook_identifier(&self) -> ::std::option::Option<&str> {
        self.notebook_identifier.as_deref()
    }
    /// <p>The identifier of the schedule associated with the notebook run.</p>
    pub fn schedule_identifier(&self) -> ::std::option::Option<&str> {
        self.schedule_identifier.as_deref()
    }
    /// <p>The compute configuration for the notebook run, including instance type and environment version.</p>
    pub fn compute_configuration(&self) -> ::std::option::Option<&crate::types::ComputeConfig> {
        self.compute_configuration.as_ref()
    }
    /// <p>The network configuration for the notebook run, including network access type and optional VPC settings.</p>
    pub fn network_configuration(&self) -> ::std::option::Option<&crate::types::NetworkConfig> {
        self.network_configuration.as_ref()
    }
    /// <p>The timeout configuration for the notebook run. The default timeout is 720 minutes (12 hours) and the maximum is 1440 minutes (24 hours).</p>
    pub fn timeout_configuration(&self) -> ::std::option::Option<&crate::types::TimeoutConfig> {
        self.timeout_configuration.as_ref()
    }
    /// <p>The source that triggered the notebook run.</p>
    pub fn trigger_source(&self) -> ::std::option::Option<&crate::types::TriggerSource> {
        self.trigger_source.as_ref()
    }
    /// <p>The metadata for the notebook run, specified as key-value pairs. You can specify up to 50 entries, with keys up to 128 characters and values up to 1024 characters.</p>
    pub fn metadata(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, ::std::string::String>> {
        self.metadata.as_ref()
    }
    /// <p>The sensitive parameters for the notebook run, specified as key-value pairs. You can specify up to 50 entries, with keys up to 128 characters and values up to 1024 characters.</p>
    pub fn parameters(&self) -> ::std::option::Option<&::std::collections::HashMap<::std::string::String, ::std::string::String>> {
        self.parameters.as_ref()
    }
    /// <p>A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.</p>
    pub fn client_token(&self) -> ::std::option::Option<&str> {
        self.client_token.as_deref()
    }
}
impl ::std::fmt::Debug for StartNotebookRunInput {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("StartNotebookRunInput");
        formatter.field("domain_identifier", &self.domain_identifier);
        formatter.field("owning_project_identifier", &self.owning_project_identifier);
        formatter.field("notebook_identifier", &self.notebook_identifier);
        formatter.field("schedule_identifier", &self.schedule_identifier);
        formatter.field("compute_configuration", &self.compute_configuration);
        formatter.field("network_configuration", &self.network_configuration);
        formatter.field("timeout_configuration", &self.timeout_configuration);
        formatter.field("trigger_source", &self.trigger_source);
        formatter.field("metadata", &"*** Sensitive Data Redacted ***");
        formatter.field("parameters", &"*** Sensitive Data Redacted ***");
        formatter.field("client_token", &self.client_token);
        formatter.finish()
    }
}
impl StartNotebookRunInput {
    /// Creates a new builder-style object to manufacture [`StartNotebookRunInput`](crate::operation::start_notebook_run::StartNotebookRunInput).
    pub fn builder() -> crate::operation::start_notebook_run::builders::StartNotebookRunInputBuilder {
        crate::operation::start_notebook_run::builders::StartNotebookRunInputBuilder::default()
    }
}

/// A builder for [`StartNotebookRunInput`](crate::operation::start_notebook_run::StartNotebookRunInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default)]
#[non_exhaustive]
pub struct StartNotebookRunInputBuilder {
    pub(crate) domain_identifier: ::std::option::Option<::std::string::String>,
    pub(crate) owning_project_identifier: ::std::option::Option<::std::string::String>,
    pub(crate) notebook_identifier: ::std::option::Option<::std::string::String>,
    pub(crate) schedule_identifier: ::std::option::Option<::std::string::String>,
    pub(crate) compute_configuration: ::std::option::Option<crate::types::ComputeConfig>,
    pub(crate) network_configuration: ::std::option::Option<crate::types::NetworkConfig>,
    pub(crate) timeout_configuration: ::std::option::Option<crate::types::TimeoutConfig>,
    pub(crate) trigger_source: ::std::option::Option<crate::types::TriggerSource>,
    pub(crate) metadata: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
    pub(crate) parameters: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>,
    pub(crate) client_token: ::std::option::Option<::std::string::String>,
}
impl StartNotebookRunInputBuilder {
    /// <p>The identifier of the Amazon DataZone domain in which the notebook run is started.</p>
    /// This field is required.
    pub fn domain_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.domain_identifier = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The identifier of the Amazon DataZone domain in which the notebook run is started.</p>
    pub fn set_domain_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.domain_identifier = input;
        self
    }
    /// <p>The identifier of the Amazon DataZone domain in which the notebook run is started.</p>
    pub fn get_domain_identifier(&self) -> &::std::option::Option<::std::string::String> {
        &self.domain_identifier
    }
    /// <p>The identifier of the project that owns the notebook run.</p>
    /// This field is required.
    pub fn owning_project_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.owning_project_identifier = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The identifier of the project that owns the notebook run.</p>
    pub fn set_owning_project_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.owning_project_identifier = input;
        self
    }
    /// <p>The identifier of the project that owns the notebook run.</p>
    pub fn get_owning_project_identifier(&self) -> &::std::option::Option<::std::string::String> {
        &self.owning_project_identifier
    }
    /// <p>The identifier of the notebook to run.</p>
    /// This field is required.
    pub fn notebook_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.notebook_identifier = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The identifier of the notebook to run.</p>
    pub fn set_notebook_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.notebook_identifier = input;
        self
    }
    /// <p>The identifier of the notebook to run.</p>
    pub fn get_notebook_identifier(&self) -> &::std::option::Option<::std::string::String> {
        &self.notebook_identifier
    }
    /// <p>The identifier of the schedule associated with the notebook run.</p>
    pub fn schedule_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.schedule_identifier = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The identifier of the schedule associated with the notebook run.</p>
    pub fn set_schedule_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.schedule_identifier = input;
        self
    }
    /// <p>The identifier of the schedule associated with the notebook run.</p>
    pub fn get_schedule_identifier(&self) -> &::std::option::Option<::std::string::String> {
        &self.schedule_identifier
    }
    /// <p>The compute configuration for the notebook run, including instance type and environment version.</p>
    pub fn compute_configuration(mut self, input: crate::types::ComputeConfig) -> Self {
        self.compute_configuration = ::std::option::Option::Some(input);
        self
    }
    /// <p>The compute configuration for the notebook run, including instance type and environment version.</p>
    pub fn set_compute_configuration(mut self, input: ::std::option::Option<crate::types::ComputeConfig>) -> Self {
        self.compute_configuration = input;
        self
    }
    /// <p>The compute configuration for the notebook run, including instance type and environment version.</p>
    pub fn get_compute_configuration(&self) -> &::std::option::Option<crate::types::ComputeConfig> {
        &self.compute_configuration
    }
    /// <p>The network configuration for the notebook run, including network access type and optional VPC settings.</p>
    pub fn network_configuration(mut self, input: crate::types::NetworkConfig) -> Self {
        self.network_configuration = ::std::option::Option::Some(input);
        self
    }
    /// <p>The network configuration for the notebook run, including network access type and optional VPC settings.</p>
    pub fn set_network_configuration(mut self, input: ::std::option::Option<crate::types::NetworkConfig>) -> Self {
        self.network_configuration = input;
        self
    }
    /// <p>The network configuration for the notebook run, including network access type and optional VPC settings.</p>
    pub fn get_network_configuration(&self) -> &::std::option::Option<crate::types::NetworkConfig> {
        &self.network_configuration
    }
    /// <p>The timeout configuration for the notebook run. The default timeout is 720 minutes (12 hours) and the maximum is 1440 minutes (24 hours).</p>
    pub fn timeout_configuration(mut self, input: crate::types::TimeoutConfig) -> Self {
        self.timeout_configuration = ::std::option::Option::Some(input);
        self
    }
    /// <p>The timeout configuration for the notebook run. The default timeout is 720 minutes (12 hours) and the maximum is 1440 minutes (24 hours).</p>
    pub fn set_timeout_configuration(mut self, input: ::std::option::Option<crate::types::TimeoutConfig>) -> Self {
        self.timeout_configuration = input;
        self
    }
    /// <p>The timeout configuration for the notebook run. The default timeout is 720 minutes (12 hours) and the maximum is 1440 minutes (24 hours).</p>
    pub fn get_timeout_configuration(&self) -> &::std::option::Option<crate::types::TimeoutConfig> {
        &self.timeout_configuration
    }
    /// <p>The source that triggered the notebook run.</p>
    pub fn trigger_source(mut self, input: crate::types::TriggerSource) -> Self {
        self.trigger_source = ::std::option::Option::Some(input);
        self
    }
    /// <p>The source that triggered the notebook run.</p>
    pub fn set_trigger_source(mut self, input: ::std::option::Option<crate::types::TriggerSource>) -> Self {
        self.trigger_source = input;
        self
    }
    /// <p>The source that triggered the notebook run.</p>
    pub fn get_trigger_source(&self) -> &::std::option::Option<crate::types::TriggerSource> {
        &self.trigger_source
    }
    /// Adds a key-value pair to `metadata`.
    ///
    /// To override the contents of this collection use [`set_metadata`](Self::set_metadata).
    ///
    /// <p>The metadata for the notebook run, specified as key-value pairs. You can specify up to 50 entries, with keys up to 128 characters and values up to 1024 characters.</p>
    pub fn metadata(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
        let mut hash_map = self.metadata.unwrap_or_default();
        hash_map.insert(k.into(), v.into());
        self.metadata = ::std::option::Option::Some(hash_map);
        self
    }
    /// <p>The metadata for the notebook run, specified as key-value pairs. You can specify up to 50 entries, with keys up to 128 characters and values up to 1024 characters.</p>
    pub fn set_metadata(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
        self.metadata = input;
        self
    }
    /// <p>The metadata for the notebook run, specified as key-value pairs. You can specify up to 50 entries, with keys up to 128 characters and values up to 1024 characters.</p>
    pub fn get_metadata(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
        &self.metadata
    }
    /// Adds a key-value pair to `parameters`.
    ///
    /// To override the contents of this collection use [`set_parameters`](Self::set_parameters).
    ///
    /// <p>The sensitive parameters for the notebook run, specified as key-value pairs. You can specify up to 50 entries, with keys up to 128 characters and values up to 1024 characters.</p>
    pub fn parameters(mut self, k: impl ::std::convert::Into<::std::string::String>, v: impl ::std::convert::Into<::std::string::String>) -> Self {
        let mut hash_map = self.parameters.unwrap_or_default();
        hash_map.insert(k.into(), v.into());
        self.parameters = ::std::option::Option::Some(hash_map);
        self
    }
    /// <p>The sensitive parameters for the notebook run, specified as key-value pairs. You can specify up to 50 entries, with keys up to 128 characters and values up to 1024 characters.</p>
    pub fn set_parameters(mut self, input: ::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>>) -> Self {
        self.parameters = input;
        self
    }
    /// <p>The sensitive parameters for the notebook run, specified as key-value pairs. You can specify up to 50 entries, with keys up to 128 characters and values up to 1024 characters.</p>
    pub fn get_parameters(&self) -> &::std::option::Option<::std::collections::HashMap<::std::string::String, ::std::string::String>> {
        &self.parameters
    }
    /// <p>A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.</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, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.</p>
    pub fn set_client_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.client_token = input;
        self
    }
    /// <p>A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.</p>
    pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
        &self.client_token
    }
    /// Consumes the builder and constructs a [`StartNotebookRunInput`](crate::operation::start_notebook_run::StartNotebookRunInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::start_notebook_run::StartNotebookRunInput, ::aws_smithy_types::error::operation::BuildError> {
        ::std::result::Result::Ok(crate::operation::start_notebook_run::StartNotebookRunInput {
            domain_identifier: self.domain_identifier,
            owning_project_identifier: self.owning_project_identifier,
            notebook_identifier: self.notebook_identifier,
            schedule_identifier: self.schedule_identifier,
            compute_configuration: self.compute_configuration,
            network_configuration: self.network_configuration,
            timeout_configuration: self.timeout_configuration,
            trigger_source: self.trigger_source,
            metadata: self.metadata,
            parameters: self.parameters,
            client_token: self.client_token,
        })
    }
}
impl ::std::fmt::Debug for StartNotebookRunInputBuilder {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("StartNotebookRunInputBuilder");
        formatter.field("domain_identifier", &self.domain_identifier);
        formatter.field("owning_project_identifier", &self.owning_project_identifier);
        formatter.field("notebook_identifier", &self.notebook_identifier);
        formatter.field("schedule_identifier", &self.schedule_identifier);
        formatter.field("compute_configuration", &self.compute_configuration);
        formatter.field("network_configuration", &self.network_configuration);
        formatter.field("timeout_configuration", &self.timeout_configuration);
        formatter.field("trigger_source", &self.trigger_source);
        formatter.field("metadata", &"*** Sensitive Data Redacted ***");
        formatter.field("parameters", &"*** Sensitive Data Redacted ***");
        formatter.field("client_token", &self.client_token);
        formatter.finish()
    }
}