pub struct CreateClassificationJobFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateClassificationJob
.
Creates and defines the settings for a classification job.
Implementations§
Source§impl CreateClassificationJobFluentBuilder
impl CreateClassificationJobFluentBuilder
Sourcepub fn as_input(&self) -> &CreateClassificationJobInputBuilder
pub fn as_input(&self) -> &CreateClassificationJobInputBuilder
Access the CreateClassificationJob as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateClassificationJobOutput, SdkError<CreateClassificationJobError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateClassificationJobOutput, SdkError<CreateClassificationJobError, HttpResponse>>
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, which can be set when configuring the client.
Sourcepub fn customize(
self,
) -> CustomizableOperation<CreateClassificationJobOutput, CreateClassificationJobError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateClassificationJobOutput, CreateClassificationJobError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn allow_list_ids(self, input: impl Into<String>) -> Self
pub fn allow_list_ids(self, input: impl Into<String>) -> Self
Appends an item to allowListIds
.
To override the contents of this collection use set_allow_list_ids
.
An array of unique identifiers, one for each allow list for the job to use when it analyzes data.
Sourcepub fn set_allow_list_ids(self, input: Option<Vec<String>>) -> Self
pub fn set_allow_list_ids(self, input: Option<Vec<String>>) -> Self
An array of unique identifiers, one for each allow list for the job to use when it analyzes data.
Sourcepub fn get_allow_list_ids(&self) -> &Option<Vec<String>>
pub fn get_allow_list_ids(&self) -> &Option<Vec<String>>
An array of unique identifiers, one for each allow list for the job to use when it analyzes data.
Sourcepub fn client_token(self, input: impl Into<String>) -> Self
pub fn client_token(self, input: impl Into<String>) -> Self
A unique, case-sensitive token that you provide to ensure the idempotency of the request.
Sourcepub fn set_client_token(self, input: Option<String>) -> Self
pub fn set_client_token(self, input: Option<String>) -> Self
A unique, case-sensitive token that you provide to ensure the idempotency of the request.
Sourcepub fn get_client_token(&self) -> &Option<String>
pub fn get_client_token(&self) -> &Option<String>
A unique, case-sensitive token that you provide to ensure the idempotency of the request.
Sourcepub fn custom_data_identifier_ids(self, input: impl Into<String>) -> Self
pub fn custom_data_identifier_ids(self, input: impl Into<String>) -> Self
Appends an item to customDataIdentifierIds
.
To override the contents of this collection use set_custom_data_identifier_ids
.
An array of unique identifiers, one for each custom data identifier for the job to use when it analyzes data. To use only managed data identifiers, don't specify a value for this property and specify a value other than NONE for the managedDataIdentifierSelector property.
Sourcepub fn set_custom_data_identifier_ids(self, input: Option<Vec<String>>) -> Self
pub fn set_custom_data_identifier_ids(self, input: Option<Vec<String>>) -> Self
An array of unique identifiers, one for each custom data identifier for the job to use when it analyzes data. To use only managed data identifiers, don't specify a value for this property and specify a value other than NONE for the managedDataIdentifierSelector property.
Sourcepub fn get_custom_data_identifier_ids(&self) -> &Option<Vec<String>>
pub fn get_custom_data_identifier_ids(&self) -> &Option<Vec<String>>
An array of unique identifiers, one for each custom data identifier for the job to use when it analyzes data. To use only managed data identifiers, don't specify a value for this property and specify a value other than NONE for the managedDataIdentifierSelector property.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A custom description of the job. The description can contain as many as 200 characters.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A custom description of the job. The description can contain as many as 200 characters.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A custom description of the job. The description can contain as many as 200 characters.
Sourcepub fn initial_run(self, input: bool) -> Self
pub fn initial_run(self, input: bool) -> Self
For a recurring job, specifies whether to analyze all existing, eligible objects immediately after the job is created (true). To analyze only those objects that are created or changed after you create the job and before the job's first scheduled run, set this value to false.
If you configure the job to run only once, don't specify a value for this property.
Sourcepub fn set_initial_run(self, input: Option<bool>) -> Self
pub fn set_initial_run(self, input: Option<bool>) -> Self
For a recurring job, specifies whether to analyze all existing, eligible objects immediately after the job is created (true). To analyze only those objects that are created or changed after you create the job and before the job's first scheduled run, set this value to false.
If you configure the job to run only once, don't specify a value for this property.
Sourcepub fn get_initial_run(&self) -> &Option<bool>
pub fn get_initial_run(&self) -> &Option<bool>
For a recurring job, specifies whether to analyze all existing, eligible objects immediately after the job is created (true). To analyze only those objects that are created or changed after you create the job and before the job's first scheduled run, set this value to false.
If you configure the job to run only once, don't specify a value for this property.
Sourcepub fn job_type(self, input: JobType) -> Self
pub fn job_type(self, input: JobType) -> Self
The schedule for running the job. Valid values are:
-
ONE_TIME - Run the job only once. If you specify this value, don't specify a value for the scheduleFrequency property.
-
SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the scheduleFrequency property to specify the recurrence pattern for the job.
Sourcepub fn set_job_type(self, input: Option<JobType>) -> Self
pub fn set_job_type(self, input: Option<JobType>) -> Self
The schedule for running the job. Valid values are:
-
ONE_TIME - Run the job only once. If you specify this value, don't specify a value for the scheduleFrequency property.
-
SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the scheduleFrequency property to specify the recurrence pattern for the job.
Sourcepub fn get_job_type(&self) -> &Option<JobType>
pub fn get_job_type(&self) -> &Option<JobType>
The schedule for running the job. Valid values are:
-
ONE_TIME - Run the job only once. If you specify this value, don't specify a value for the scheduleFrequency property.
-
SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the scheduleFrequency property to specify the recurrence pattern for the job.
Sourcepub fn managed_data_identifier_ids(self, input: impl Into<String>) -> Self
pub fn managed_data_identifier_ids(self, input: impl Into<String>) -> Self
Appends an item to managedDataIdentifierIds
.
To override the contents of this collection use set_managed_data_identifier_ids
.
An array of unique identifiers, one for each managed data identifier for the job to include (use) or exclude (not use) when it analyzes data. Inclusion or exclusion depends on the managed data identifier selection type that you specify for the job (managedDataIdentifierSelector).
To retrieve a list of valid values for this property, use the ListManagedDataIdentifiers operation.
Sourcepub fn set_managed_data_identifier_ids(self, input: Option<Vec<String>>) -> Self
pub fn set_managed_data_identifier_ids(self, input: Option<Vec<String>>) -> Self
An array of unique identifiers, one for each managed data identifier for the job to include (use) or exclude (not use) when it analyzes data. Inclusion or exclusion depends on the managed data identifier selection type that you specify for the job (managedDataIdentifierSelector).
To retrieve a list of valid values for this property, use the ListManagedDataIdentifiers operation.
Sourcepub fn get_managed_data_identifier_ids(&self) -> &Option<Vec<String>>
pub fn get_managed_data_identifier_ids(&self) -> &Option<Vec<String>>
An array of unique identifiers, one for each managed data identifier for the job to include (use) or exclude (not use) when it analyzes data. Inclusion or exclusion depends on the managed data identifier selection type that you specify for the job (managedDataIdentifierSelector).
To retrieve a list of valid values for this property, use the ListManagedDataIdentifiers operation.
Sourcepub fn managed_data_identifier_selector(
self,
input: ManagedDataIdentifierSelector,
) -> Self
pub fn managed_data_identifier_selector( self, input: ManagedDataIdentifierSelector, ) -> Self
The selection type to apply when determining which managed data identifiers the job uses to analyze data. Valid values are:
-
ALL - Use all managed data identifiers. If you specify this value, don't specify any values for the managedDataIdentifierIds property.
-
EXCLUDE - Use all managed data identifiers except the ones specified by the managedDataIdentifierIds property.
-
INCLUDE - Use only the managed data identifiers specified by the managedDataIdentifierIds property.
-
NONE - Don't use any managed data identifiers. If you specify this value, specify at least one value for the customDataIdentifierIds property and don't specify any values for the managedDataIdentifierIds property.
-
RECOMMENDED (default) - Use the recommended set of managed data identifiers. If you specify this value, don't specify any values for the managedDataIdentifierIds property.
If you don't specify a value for this property, the job uses the recommended set of managed data identifiers.
If the job is a recurring job and you specify ALL or EXCLUDE, each job run automatically uses new managed data identifiers that are released. If you don't specify a value for this property or you specify RECOMMENDED for a recurring job, each job run automatically uses all the managed data identifiers that are in the recommended set when the run starts.
To learn about individual managed data identifiers or determine which ones are in the recommended set, see Using managed data identifiers or Recommended managed data identifiers in the Amazon Macie User Guide.
Sourcepub fn set_managed_data_identifier_selector(
self,
input: Option<ManagedDataIdentifierSelector>,
) -> Self
pub fn set_managed_data_identifier_selector( self, input: Option<ManagedDataIdentifierSelector>, ) -> Self
The selection type to apply when determining which managed data identifiers the job uses to analyze data. Valid values are:
-
ALL - Use all managed data identifiers. If you specify this value, don't specify any values for the managedDataIdentifierIds property.
-
EXCLUDE - Use all managed data identifiers except the ones specified by the managedDataIdentifierIds property.
-
INCLUDE - Use only the managed data identifiers specified by the managedDataIdentifierIds property.
-
NONE - Don't use any managed data identifiers. If you specify this value, specify at least one value for the customDataIdentifierIds property and don't specify any values for the managedDataIdentifierIds property.
-
RECOMMENDED (default) - Use the recommended set of managed data identifiers. If you specify this value, don't specify any values for the managedDataIdentifierIds property.
If you don't specify a value for this property, the job uses the recommended set of managed data identifiers.
If the job is a recurring job and you specify ALL or EXCLUDE, each job run automatically uses new managed data identifiers that are released. If you don't specify a value for this property or you specify RECOMMENDED for a recurring job, each job run automatically uses all the managed data identifiers that are in the recommended set when the run starts.
To learn about individual managed data identifiers or determine which ones are in the recommended set, see Using managed data identifiers or Recommended managed data identifiers in the Amazon Macie User Guide.
Sourcepub fn get_managed_data_identifier_selector(
&self,
) -> &Option<ManagedDataIdentifierSelector>
pub fn get_managed_data_identifier_selector( &self, ) -> &Option<ManagedDataIdentifierSelector>
The selection type to apply when determining which managed data identifiers the job uses to analyze data. Valid values are:
-
ALL - Use all managed data identifiers. If you specify this value, don't specify any values for the managedDataIdentifierIds property.
-
EXCLUDE - Use all managed data identifiers except the ones specified by the managedDataIdentifierIds property.
-
INCLUDE - Use only the managed data identifiers specified by the managedDataIdentifierIds property.
-
NONE - Don't use any managed data identifiers. If you specify this value, specify at least one value for the customDataIdentifierIds property and don't specify any values for the managedDataIdentifierIds property.
-
RECOMMENDED (default) - Use the recommended set of managed data identifiers. If you specify this value, don't specify any values for the managedDataIdentifierIds property.
If you don't specify a value for this property, the job uses the recommended set of managed data identifiers.
If the job is a recurring job and you specify ALL or EXCLUDE, each job run automatically uses new managed data identifiers that are released. If you don't specify a value for this property or you specify RECOMMENDED for a recurring job, each job run automatically uses all the managed data identifiers that are in the recommended set when the run starts.
To learn about individual managed data identifiers or determine which ones are in the recommended set, see Using managed data identifiers or Recommended managed data identifiers in the Amazon Macie User Guide.
Sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
A custom name for the job. The name can contain as many as 500 characters.
Sourcepub fn set_name(self, input: Option<String>) -> Self
pub fn set_name(self, input: Option<String>) -> Self
A custom name for the job. The name can contain as many as 500 characters.
Sourcepub fn get_name(&self) -> &Option<String>
pub fn get_name(&self) -> &Option<String>
A custom name for the job. The name can contain as many as 500 characters.
Sourcepub fn s3_job_definition(self, input: S3JobDefinition) -> Self
pub fn s3_job_definition(self, input: S3JobDefinition) -> Self
The S3 buckets that contain the objects to analyze, and the scope of that analysis.
Sourcepub fn set_s3_job_definition(self, input: Option<S3JobDefinition>) -> Self
pub fn set_s3_job_definition(self, input: Option<S3JobDefinition>) -> Self
The S3 buckets that contain the objects to analyze, and the scope of that analysis.
Sourcepub fn get_s3_job_definition(&self) -> &Option<S3JobDefinition>
pub fn get_s3_job_definition(&self) -> &Option<S3JobDefinition>
The S3 buckets that contain the objects to analyze, and the scope of that analysis.
Sourcepub fn sampling_percentage(self, input: i32) -> Self
pub fn sampling_percentage(self, input: i32) -> Self
The sampling depth, as a percentage, for the job to apply when processing objects. This value determines the percentage of eligible objects that the job analyzes. If this value is less than 100, Amazon Macie selects the objects to analyze at random, up to the specified percentage, and analyzes all the data in those objects.
Sourcepub fn set_sampling_percentage(self, input: Option<i32>) -> Self
pub fn set_sampling_percentage(self, input: Option<i32>) -> Self
The sampling depth, as a percentage, for the job to apply when processing objects. This value determines the percentage of eligible objects that the job analyzes. If this value is less than 100, Amazon Macie selects the objects to analyze at random, up to the specified percentage, and analyzes all the data in those objects.
Sourcepub fn get_sampling_percentage(&self) -> &Option<i32>
pub fn get_sampling_percentage(&self) -> &Option<i32>
The sampling depth, as a percentage, for the job to apply when processing objects. This value determines the percentage of eligible objects that the job analyzes. If this value is less than 100, Amazon Macie selects the objects to analyze at random, up to the specified percentage, and analyzes all the data in those objects.
Sourcepub fn schedule_frequency(self, input: JobScheduleFrequency) -> Self
pub fn schedule_frequency(self, input: JobScheduleFrequency) -> Self
The recurrence pattern for running the job. To run the job only once, don't specify a value for this property and set the value for the jobType property to ONE_TIME.
Sourcepub fn set_schedule_frequency(self, input: Option<JobScheduleFrequency>) -> Self
pub fn set_schedule_frequency(self, input: Option<JobScheduleFrequency>) -> Self
The recurrence pattern for running the job. To run the job only once, don't specify a value for this property and set the value for the jobType property to ONE_TIME.
Sourcepub fn get_schedule_frequency(&self) -> &Option<JobScheduleFrequency>
pub fn get_schedule_frequency(&self) -> &Option<JobScheduleFrequency>
The recurrence pattern for running the job. To run the job only once, don't specify a value for this property and set the value for the jobType property to ONE_TIME.
Adds a key-value pair to tags
.
To override the contents of this collection use set_tags
.
A map of key-value pairs that specifies the tags to associate with the job.
A job can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
A map of key-value pairs that specifies the tags to associate with the job.
A job can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
A map of key-value pairs that specifies the tags to associate with the job.
A job can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
Trait Implementations§
Source§impl Clone for CreateClassificationJobFluentBuilder
impl Clone for CreateClassificationJobFluentBuilder
Source§fn clone(&self) -> CreateClassificationJobFluentBuilder
fn clone(&self) -> CreateClassificationJobFluentBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for CreateClassificationJobFluentBuilder
impl !RefUnwindSafe for CreateClassificationJobFluentBuilder
impl Send for CreateClassificationJobFluentBuilder
impl Sync for CreateClassificationJobFluentBuilder
impl Unpin for CreateClassificationJobFluentBuilder
impl !UnwindSafe for CreateClassificationJobFluentBuilder
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>
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>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
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>
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>
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>
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>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
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 rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
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);