pub struct CreateJobFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to CreateJob.
This operation creates an S3 Batch Operations job.
You can use S3 Batch Operations to perform large-scale batch actions on Amazon S3 objects. Batch Operations can run a single action on lists of Amazon S3 objects that you specify. For more information, see S3 Batch Operations in the Amazon S3 User Guide.
- Permissions
-
For information about permissions required to use the Batch Operations, see Granting permissions for S3 Batch Operations in the Amazon S3 User Guide.
Related actions include:
You must URL encode any signed header values that contain spaces. For example, if your header value is my file.txt, containing two spaces after my, you must URL encode this value to my%20%20file.txt.
Implementations§
Source§impl CreateJobFluentBuilder
impl CreateJobFluentBuilder
Sourcepub fn as_input(&self) -> &CreateJobInputBuilder
pub fn as_input(&self) -> &CreateJobInputBuilder
Access the CreateJob as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateJobOutput, SdkError<CreateJobError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateJobOutput, SdkError<CreateJobError, 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<CreateJobOutput, CreateJobError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateJobOutput, CreateJobError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn account_id(self, input: impl Into<String>) -> Self
pub fn account_id(self, input: impl Into<String>) -> Self
The Amazon Web Services account ID that creates the job.
Sourcepub fn set_account_id(self, input: Option<String>) -> Self
pub fn set_account_id(self, input: Option<String>) -> Self
The Amazon Web Services account ID that creates the job.
Sourcepub fn get_account_id(&self) -> &Option<String>
pub fn get_account_id(&self) -> &Option<String>
The Amazon Web Services account ID that creates the job.
Sourcepub fn confirmation_required(self, input: bool) -> Self
pub fn confirmation_required(self, input: bool) -> Self
Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is only required for jobs created through the Amazon S3 console.
Sourcepub fn set_confirmation_required(self, input: Option<bool>) -> Self
pub fn set_confirmation_required(self, input: Option<bool>) -> Self
Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is only required for jobs created through the Amazon S3 console.
Sourcepub fn get_confirmation_required(&self) -> &Option<bool>
pub fn get_confirmation_required(&self) -> &Option<bool>
Indicates whether confirmation is required before Amazon S3 runs the job. Confirmation is only required for jobs created through the Amazon S3 console.
Sourcepub fn operation(self, input: JobOperation) -> Self
pub fn operation(self, input: JobOperation) -> Self
The action that you want this job to perform on every object listed in the manifest. For more information about the available actions, see Operations in the Amazon S3 User Guide.
Sourcepub fn set_operation(self, input: Option<JobOperation>) -> Self
pub fn set_operation(self, input: Option<JobOperation>) -> Self
The action that you want this job to perform on every object listed in the manifest. For more information about the available actions, see Operations in the Amazon S3 User Guide.
Sourcepub fn get_operation(&self) -> &Option<JobOperation>
pub fn get_operation(&self) -> &Option<JobOperation>
The action that you want this job to perform on every object listed in the manifest. For more information about the available actions, see Operations in the Amazon S3 User Guide.
Sourcepub fn report(self, input: JobReport) -> Self
pub fn report(self, input: JobReport) -> Self
Configuration parameters for the optional job-completion report.
Sourcepub fn set_report(self, input: Option<JobReport>) -> Self
pub fn set_report(self, input: Option<JobReport>) -> Self
Configuration parameters for the optional job-completion report.
Sourcepub fn get_report(&self) -> &Option<JobReport>
pub fn get_report(&self) -> &Option<JobReport>
Configuration parameters for the optional job-completion report.
Sourcepub fn client_request_token(self, input: impl Into<String>) -> Self
pub fn client_request_token(self, input: impl Into<String>) -> Self
An idempotency token to ensure that you don't accidentally submit the same request twice. You can use any string up to the maximum length.
Sourcepub fn set_client_request_token(self, input: Option<String>) -> Self
pub fn set_client_request_token(self, input: Option<String>) -> Self
An idempotency token to ensure that you don't accidentally submit the same request twice. You can use any string up to the maximum length.
Sourcepub fn get_client_request_token(&self) -> &Option<String>
pub fn get_client_request_token(&self) -> &Option<String>
An idempotency token to ensure that you don't accidentally submit the same request twice. You can use any string up to the maximum length.
Sourcepub fn manifest(self, input: JobManifest) -> Self
pub fn manifest(self, input: JobManifest) -> Self
Configuration parameters for the manifest.
Sourcepub fn set_manifest(self, input: Option<JobManifest>) -> Self
pub fn set_manifest(self, input: Option<JobManifest>) -> Self
Configuration parameters for the manifest.
Sourcepub fn get_manifest(&self) -> &Option<JobManifest>
pub fn get_manifest(&self) -> &Option<JobManifest>
Configuration parameters for the manifest.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A description for this job. You can use any string within the permitted length. Descriptions don't need to be unique and can be used for multiple jobs.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A description for this job. You can use any string within the permitted length. Descriptions don't need to be unique and can be used for multiple jobs.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A description for this job. You can use any string within the permitted length. Descriptions don't need to be unique and can be used for multiple jobs.
Sourcepub fn priority(self, input: i32) -> Self
pub fn priority(self, input: i32) -> Self
The numerical priority for this job. Higher numbers indicate higher priority.
Sourcepub fn set_priority(self, input: Option<i32>) -> Self
pub fn set_priority(self, input: Option<i32>) -> Self
The numerical priority for this job. Higher numbers indicate higher priority.
Sourcepub fn get_priority(&self) -> &Option<i32>
pub fn get_priority(&self) -> &Option<i32>
The numerical priority for this job. Higher numbers indicate higher priority.
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) for the Identity and Access Management (IAM) role that Batch Operations will use to run this job's action on every object in the manifest.
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) for the Identity and Access Management (IAM) role that Batch Operations will use to run this job's action on every object in the manifest.
Sourcepub fn get_role_arn(&self) -> &Option<String>
pub fn get_role_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) for the Identity and Access Management (IAM) role that Batch Operations will use to run this job's action on every object in the manifest.
Appends an item to Tags.
To override the contents of this collection use set_tags.
A set of tags to associate with the S3 Batch Operations job. This is an optional parameter.
A set of tags to associate with the S3 Batch Operations job. This is an optional parameter.
A set of tags to associate with the S3 Batch Operations job. This is an optional parameter.
Sourcepub fn manifest_generator(self, input: JobManifestGenerator) -> Self
pub fn manifest_generator(self, input: JobManifestGenerator) -> Self
The attribute container for the ManifestGenerator details. Jobs must be created with either a manifest file or a ManifestGenerator, but not both.
Sourcepub fn set_manifest_generator(self, input: Option<JobManifestGenerator>) -> Self
pub fn set_manifest_generator(self, input: Option<JobManifestGenerator>) -> Self
The attribute container for the ManifestGenerator details. Jobs must be created with either a manifest file or a ManifestGenerator, but not both.
Sourcepub fn get_manifest_generator(&self) -> &Option<JobManifestGenerator>
pub fn get_manifest_generator(&self) -> &Option<JobManifestGenerator>
The attribute container for the ManifestGenerator details. Jobs must be created with either a manifest file or a ManifestGenerator, but not both.
Trait Implementations§
Source§impl Clone for CreateJobFluentBuilder
impl Clone for CreateJobFluentBuilder
Source§fn clone(&self) -> CreateJobFluentBuilder
fn clone(&self) -> CreateJobFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for CreateJobFluentBuilder
impl !RefUnwindSafe for CreateJobFluentBuilder
impl Send for CreateJobFluentBuilder
impl Sync for CreateJobFluentBuilder
impl Unpin for CreateJobFluentBuilder
impl !UnwindSafe for CreateJobFluentBuilder
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);