#[non_exhaustive]pub struct JobBuilder { /* private fields */ }
Expand description
A builder for Job
.
Implementations§
Source§impl JobBuilder
impl JobBuilder
Sourcepub fn account_id(self, input: impl Into<String>) -> Self
pub fn account_id(self, input: impl Into<String>) -> Self
The ID of the Amazon Web Services account that owns the job.
Sourcepub fn set_account_id(self, input: Option<String>) -> Self
pub fn set_account_id(self, input: Option<String>) -> Self
The ID of the Amazon Web Services account that owns the job.
Sourcepub fn get_account_id(&self) -> &Option<String>
pub fn get_account_id(&self) -> &Option<String>
The ID of the Amazon Web Services account that owns the job.
Sourcepub fn created_by(self, input: impl Into<String>) -> Self
pub fn created_by(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the user who created the job.
Sourcepub fn set_created_by(self, input: Option<String>) -> Self
pub fn set_created_by(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the user who created the job.
Sourcepub fn get_created_by(&self) -> &Option<String>
pub fn get_created_by(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the user who created the job.
Sourcepub fn create_date(self, input: DateTime) -> Self
pub fn create_date(self, input: DateTime) -> Self
The date and time that the job was created.
Sourcepub fn set_create_date(self, input: Option<DateTime>) -> Self
pub fn set_create_date(self, input: Option<DateTime>) -> Self
The date and time that the job was created.
Sourcepub fn get_create_date(&self) -> &Option<DateTime>
pub fn get_create_date(&self) -> &Option<DateTime>
The date and time that the job was created.
Sourcepub fn dataset_name(self, input: impl Into<String>) -> Self
pub fn dataset_name(self, input: impl Into<String>) -> Self
A dataset that the job is to process.
Sourcepub fn set_dataset_name(self, input: Option<String>) -> Self
pub fn set_dataset_name(self, input: Option<String>) -> Self
A dataset that the job is to process.
Sourcepub fn get_dataset_name(&self) -> &Option<String>
pub fn get_dataset_name(&self) -> &Option<String>
A dataset that the job is to process.
Sourcepub fn encryption_key_arn(self, input: impl Into<String>) -> Self
pub fn encryption_key_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of an encryption key that is used to protect the job output. For more information, see Encrypting data written by DataBrew jobs
Sourcepub fn set_encryption_key_arn(self, input: Option<String>) -> Self
pub fn set_encryption_key_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of an encryption key that is used to protect the job output. For more information, see Encrypting data written by DataBrew jobs
Sourcepub fn get_encryption_key_arn(&self) -> &Option<String>
pub fn get_encryption_key_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of an encryption key that is used to protect the job output. For more information, see Encrypting data written by DataBrew jobs
Sourcepub fn encryption_mode(self, input: EncryptionMode) -> Self
pub fn encryption_mode(self, input: EncryptionMode) -> Self
The encryption mode for the job, which can be one of the following:
-
SSE-KMS
- Server-side encryption with keys managed by KMS. -
SSE-S3
- Server-side encryption with keys managed by Amazon S3.
Sourcepub fn set_encryption_mode(self, input: Option<EncryptionMode>) -> Self
pub fn set_encryption_mode(self, input: Option<EncryptionMode>) -> Self
The encryption mode for the job, which can be one of the following:
-
SSE-KMS
- Server-side encryption with keys managed by KMS. -
SSE-S3
- Server-side encryption with keys managed by Amazon S3.
Sourcepub fn get_encryption_mode(&self) -> &Option<EncryptionMode>
pub fn get_encryption_mode(&self) -> &Option<EncryptionMode>
The encryption mode for the job, which can be one of the following:
-
SSE-KMS
- Server-side encryption with keys managed by KMS. -
SSE-S3
- Server-side encryption with keys managed by Amazon S3.
Sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
The unique name of the job.
This field is required.Sourcepub fn type(self, input: JobType) -> Self
pub fn type(self, input: JobType) -> Self
The job type of the job, which must be one of the following:
-
PROFILE
- A job to analyze a dataset, to determine its size, data types, data distribution, and more. -
RECIPE
- A job to apply one or more transformations to a dataset.
Sourcepub fn set_type(self, input: Option<JobType>) -> Self
pub fn set_type(self, input: Option<JobType>) -> Self
The job type of the job, which must be one of the following:
-
PROFILE
- A job to analyze a dataset, to determine its size, data types, data distribution, and more. -
RECIPE
- A job to apply one or more transformations to a dataset.
Sourcepub fn get_type(&self) -> &Option<JobType>
pub fn get_type(&self) -> &Option<JobType>
The job type of the job, which must be one of the following:
-
PROFILE
- A job to analyze a dataset, to determine its size, data types, data distribution, and more. -
RECIPE
- A job to apply one or more transformations to a dataset.
Sourcepub fn last_modified_by(self, input: impl Into<String>) -> Self
pub fn last_modified_by(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the user who last modified the job.
Sourcepub fn set_last_modified_by(self, input: Option<String>) -> Self
pub fn set_last_modified_by(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the user who last modified the job.
Sourcepub fn get_last_modified_by(&self) -> &Option<String>
pub fn get_last_modified_by(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the user who last modified the job.
Sourcepub fn last_modified_date(self, input: DateTime) -> Self
pub fn last_modified_date(self, input: DateTime) -> Self
The modification date and time of the job.
Sourcepub fn set_last_modified_date(self, input: Option<DateTime>) -> Self
pub fn set_last_modified_date(self, input: Option<DateTime>) -> Self
The modification date and time of the job.
Sourcepub fn get_last_modified_date(&self) -> &Option<DateTime>
pub fn get_last_modified_date(&self) -> &Option<DateTime>
The modification date and time of the job.
Sourcepub fn log_subscription(self, input: LogSubscription) -> Self
pub fn log_subscription(self, input: LogSubscription) -> Self
The current status of Amazon CloudWatch logging for the job.
Sourcepub fn set_log_subscription(self, input: Option<LogSubscription>) -> Self
pub fn set_log_subscription(self, input: Option<LogSubscription>) -> Self
The current status of Amazon CloudWatch logging for the job.
Sourcepub fn get_log_subscription(&self) -> &Option<LogSubscription>
pub fn get_log_subscription(&self) -> &Option<LogSubscription>
The current status of Amazon CloudWatch logging for the job.
Sourcepub fn max_capacity(self, input: i32) -> Self
pub fn max_capacity(self, input: i32) -> Self
The maximum number of nodes that can be consumed when the job processes data.
Sourcepub fn set_max_capacity(self, input: Option<i32>) -> Self
pub fn set_max_capacity(self, input: Option<i32>) -> Self
The maximum number of nodes that can be consumed when the job processes data.
Sourcepub fn get_max_capacity(&self) -> &Option<i32>
pub fn get_max_capacity(&self) -> &Option<i32>
The maximum number of nodes that can be consumed when the job processes data.
Sourcepub fn max_retries(self, input: i32) -> Self
pub fn max_retries(self, input: i32) -> Self
The maximum number of times to retry the job after a job run fails.
Sourcepub fn set_max_retries(self, input: Option<i32>) -> Self
pub fn set_max_retries(self, input: Option<i32>) -> Self
The maximum number of times to retry the job after a job run fails.
Sourcepub fn get_max_retries(&self) -> &Option<i32>
pub fn get_max_retries(&self) -> &Option<i32>
The maximum number of times to retry the job after a job run fails.
Sourcepub fn outputs(self, input: Output) -> Self
pub fn outputs(self, input: Output) -> Self
Appends an item to outputs
.
To override the contents of this collection use set_outputs
.
One or more artifacts that represent output from running the job.
Sourcepub fn set_outputs(self, input: Option<Vec<Output>>) -> Self
pub fn set_outputs(self, input: Option<Vec<Output>>) -> Self
One or more artifacts that represent output from running the job.
Sourcepub fn get_outputs(&self) -> &Option<Vec<Output>>
pub fn get_outputs(&self) -> &Option<Vec<Output>>
One or more artifacts that represent output from running the job.
Sourcepub fn data_catalog_outputs(self, input: DataCatalogOutput) -> Self
pub fn data_catalog_outputs(self, input: DataCatalogOutput) -> Self
Appends an item to data_catalog_outputs
.
To override the contents of this collection use set_data_catalog_outputs
.
One or more artifacts that represent the Glue Data Catalog output from running the job.
Sourcepub fn set_data_catalog_outputs(
self,
input: Option<Vec<DataCatalogOutput>>,
) -> Self
pub fn set_data_catalog_outputs( self, input: Option<Vec<DataCatalogOutput>>, ) -> Self
One or more artifacts that represent the Glue Data Catalog output from running the job.
Sourcepub fn get_data_catalog_outputs(&self) -> &Option<Vec<DataCatalogOutput>>
pub fn get_data_catalog_outputs(&self) -> &Option<Vec<DataCatalogOutput>>
One or more artifacts that represent the Glue Data Catalog output from running the job.
Sourcepub fn database_outputs(self, input: DatabaseOutput) -> Self
pub fn database_outputs(self, input: DatabaseOutput) -> Self
Appends an item to database_outputs
.
To override the contents of this collection use set_database_outputs
.
Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
Sourcepub fn set_database_outputs(self, input: Option<Vec<DatabaseOutput>>) -> Self
pub fn set_database_outputs(self, input: Option<Vec<DatabaseOutput>>) -> Self
Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
Sourcepub fn get_database_outputs(&self) -> &Option<Vec<DatabaseOutput>>
pub fn get_database_outputs(&self) -> &Option<Vec<DatabaseOutput>>
Represents a list of JDBC database output objects which defines the output destination for a DataBrew recipe job to write into.
Sourcepub fn project_name(self, input: impl Into<String>) -> Self
pub fn project_name(self, input: impl Into<String>) -> Self
The name of the project that the job is associated with.
Sourcepub fn set_project_name(self, input: Option<String>) -> Self
pub fn set_project_name(self, input: Option<String>) -> Self
The name of the project that the job is associated with.
Sourcepub fn get_project_name(&self) -> &Option<String>
pub fn get_project_name(&self) -> &Option<String>
The name of the project that the job is associated with.
Sourcepub fn recipe_reference(self, input: RecipeReference) -> Self
pub fn recipe_reference(self, input: RecipeReference) -> Self
A set of steps that the job runs.
Sourcepub fn set_recipe_reference(self, input: Option<RecipeReference>) -> Self
pub fn set_recipe_reference(self, input: Option<RecipeReference>) -> Self
A set of steps that the job runs.
Sourcepub fn get_recipe_reference(&self) -> &Option<RecipeReference>
pub fn get_recipe_reference(&self) -> &Option<RecipeReference>
A set of steps that the job runs.
Sourcepub fn resource_arn(self, input: impl Into<String>) -> Self
pub fn resource_arn(self, input: impl Into<String>) -> Self
The unique Amazon Resource Name (ARN) for the job.
Sourcepub fn set_resource_arn(self, input: Option<String>) -> Self
pub fn set_resource_arn(self, input: Option<String>) -> Self
The unique Amazon Resource Name (ARN) for the job.
Sourcepub fn get_resource_arn(&self) -> &Option<String>
pub fn get_resource_arn(&self) -> &Option<String>
The unique Amazon Resource Name (ARN) for the job.
Sourcepub fn role_arn(self, input: impl Into<String>) -> Self
pub fn role_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the role to be assumed for this job.
Sourcepub fn set_role_arn(self, input: Option<String>) -> Self
pub fn set_role_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the role to be assumed for this job.
Sourcepub fn get_role_arn(&self) -> &Option<String>
pub fn get_role_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the role to be assumed for this job.
Sourcepub fn timeout(self, input: i32) -> Self
pub fn timeout(self, input: i32) -> Self
The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT
.
Sourcepub fn set_timeout(self, input: Option<i32>) -> Self
pub fn set_timeout(self, input: Option<i32>) -> Self
The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT
.
Sourcepub fn get_timeout(&self) -> &Option<i32>
pub fn get_timeout(&self) -> &Option<i32>
The job's timeout in minutes. A job that attempts to run longer than this timeout period ends with a status of TIMEOUT
.
Adds a key-value pair to tags
.
To override the contents of this collection use set_tags
.
Metadata tags that have been applied to the job.
Metadata tags that have been applied to the job.
Metadata tags that have been applied to the job.
Sourcepub fn job_sample(self, input: JobSample) -> Self
pub fn job_sample(self, input: JobSample) -> Self
A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run. If a JobSample
value isn't provided, the default value is used. The default value is CUSTOM_ROWS for the mode parameter and 20,000 for the size parameter.
Sourcepub fn set_job_sample(self, input: Option<JobSample>) -> Self
pub fn set_job_sample(self, input: Option<JobSample>) -> Self
A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run. If a JobSample
value isn't provided, the default value is used. The default value is CUSTOM_ROWS for the mode parameter and 20,000 for the size parameter.
Sourcepub fn get_job_sample(&self) -> &Option<JobSample>
pub fn get_job_sample(&self) -> &Option<JobSample>
A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run. If a JobSample
value isn't provided, the default value is used. The default value is CUSTOM_ROWS for the mode parameter and 20,000 for the size parameter.
Sourcepub fn validation_configurations(self, input: ValidationConfiguration) -> Self
pub fn validation_configurations(self, input: ValidationConfiguration) -> Self
Appends an item to validation_configurations
.
To override the contents of this collection use set_validation_configurations
.
List of validation configurations that are applied to the profile job.
Sourcepub fn set_validation_configurations(
self,
input: Option<Vec<ValidationConfiguration>>,
) -> Self
pub fn set_validation_configurations( self, input: Option<Vec<ValidationConfiguration>>, ) -> Self
List of validation configurations that are applied to the profile job.
Sourcepub fn get_validation_configurations(
&self,
) -> &Option<Vec<ValidationConfiguration>>
pub fn get_validation_configurations( &self, ) -> &Option<Vec<ValidationConfiguration>>
List of validation configurations that are applied to the profile job.
Trait Implementations§
Source§impl Clone for JobBuilder
impl Clone for JobBuilder
Source§fn clone(&self) -> JobBuilder
fn clone(&self) -> JobBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for JobBuilder
impl Debug for JobBuilder
Source§impl Default for JobBuilder
impl Default for JobBuilder
Source§fn default() -> JobBuilder
fn default() -> JobBuilder
Source§impl PartialEq for JobBuilder
impl PartialEq for JobBuilder
impl StructuralPartialEq for JobBuilder
Auto Trait Implementations§
impl Freeze for JobBuilder
impl RefUnwindSafe for JobBuilder
impl Send for JobBuilder
impl Sync for JobBuilder
impl Unpin for JobBuilder
impl UnwindSafe for JobBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);