pub struct SubmitServiceJobFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to SubmitServiceJob
.
Submits a service job to a specified job queue to run on SageMaker AI. A service job is a unit of work that you submit to Batch for execution on SageMaker AI.
Implementations§
Source§impl SubmitServiceJobFluentBuilder
impl SubmitServiceJobFluentBuilder
Sourcepub fn as_input(&self) -> &SubmitServiceJobInputBuilder
pub fn as_input(&self) -> &SubmitServiceJobInputBuilder
Access the SubmitServiceJob as a reference.
Sourcepub async fn send(
self,
) -> Result<SubmitServiceJobOutput, SdkError<SubmitServiceJobError, HttpResponse>>
pub async fn send( self, ) -> Result<SubmitServiceJobOutput, SdkError<SubmitServiceJobError, 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<SubmitServiceJobOutput, SubmitServiceJobError, Self>
pub fn customize( self, ) -> CustomizableOperation<SubmitServiceJobOutput, SubmitServiceJobError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn job_name(self, input: impl Into<String>) -> Self
pub fn job_name(self, input: impl Into<String>) -> Self
The name of the service job. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
Sourcepub fn set_job_name(self, input: Option<String>) -> Self
pub fn set_job_name(self, input: Option<String>) -> Self
The name of the service job. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
Sourcepub fn get_job_name(&self) -> &Option<String>
pub fn get_job_name(&self) -> &Option<String>
The name of the service job. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
Sourcepub fn job_queue(self, input: impl Into<String>) -> Self
pub fn job_queue(self, input: impl Into<String>) -> Self
The job queue into which the service job is submitted. You can specify either the name or the ARN of the queue. The job queue must have the type SAGEMAKER_TRAINING
.
Sourcepub fn set_job_queue(self, input: Option<String>) -> Self
pub fn set_job_queue(self, input: Option<String>) -> Self
The job queue into which the service job is submitted. You can specify either the name or the ARN of the queue. The job queue must have the type SAGEMAKER_TRAINING
.
Sourcepub fn get_job_queue(&self) -> &Option<String>
pub fn get_job_queue(&self) -> &Option<String>
The job queue into which the service job is submitted. You can specify either the name or the ARN of the queue. The job queue must have the type SAGEMAKER_TRAINING
.
Sourcepub fn retry_strategy(self, input: ServiceJobRetryStrategy) -> Self
pub fn retry_strategy(self, input: ServiceJobRetryStrategy) -> Self
The retry strategy to use for failed service jobs that are submitted with this service job request.
Sourcepub fn set_retry_strategy(self, input: Option<ServiceJobRetryStrategy>) -> Self
pub fn set_retry_strategy(self, input: Option<ServiceJobRetryStrategy>) -> Self
The retry strategy to use for failed service jobs that are submitted with this service job request.
Sourcepub fn get_retry_strategy(&self) -> &Option<ServiceJobRetryStrategy>
pub fn get_retry_strategy(&self) -> &Option<ServiceJobRetryStrategy>
The retry strategy to use for failed service jobs that are submitted with this service job request.
Sourcepub fn scheduling_priority(self, input: i32) -> Self
pub fn scheduling_priority(self, input: i32) -> Self
The scheduling priority of the service job. Valid values are integers between 0 and 9999.
Sourcepub fn set_scheduling_priority(self, input: Option<i32>) -> Self
pub fn set_scheduling_priority(self, input: Option<i32>) -> Self
The scheduling priority of the service job. Valid values are integers between 0 and 9999.
Sourcepub fn get_scheduling_priority(&self) -> &Option<i32>
pub fn get_scheduling_priority(&self) -> &Option<i32>
The scheduling priority of the service job. Valid values are integers between 0 and 9999.
Sourcepub fn service_request_payload(self, input: impl Into<String>) -> Self
pub fn service_request_payload(self, input: impl Into<String>) -> Self
The request, in JSON, for the service that the SubmitServiceJob operation is queueing.
Sourcepub fn set_service_request_payload(self, input: Option<String>) -> Self
pub fn set_service_request_payload(self, input: Option<String>) -> Self
The request, in JSON, for the service that the SubmitServiceJob operation is queueing.
Sourcepub fn get_service_request_payload(&self) -> &Option<String>
pub fn get_service_request_payload(&self) -> &Option<String>
The request, in JSON, for the service that the SubmitServiceJob operation is queueing.
Sourcepub fn service_job_type(self, input: ServiceJobType) -> Self
pub fn service_job_type(self, input: ServiceJobType) -> Self
The type of service job. For SageMaker Training jobs, specify SAGEMAKER_TRAINING
.
Sourcepub fn set_service_job_type(self, input: Option<ServiceJobType>) -> Self
pub fn set_service_job_type(self, input: Option<ServiceJobType>) -> Self
The type of service job. For SageMaker Training jobs, specify SAGEMAKER_TRAINING
.
Sourcepub fn get_service_job_type(&self) -> &Option<ServiceJobType>
pub fn get_service_job_type(&self) -> &Option<ServiceJobType>
The type of service job. For SageMaker Training jobs, specify SAGEMAKER_TRAINING
.
The share identifier for the service job. Don't specify this parameter if the job queue doesn't have a fair- share scheduling policy. If the job queue has a fair-share scheduling policy, then this parameter must be specified.
The share identifier for the service job. Don't specify this parameter if the job queue doesn't have a fair- share scheduling policy. If the job queue has a fair-share scheduling policy, then this parameter must be specified.
The share identifier for the service job. Don't specify this parameter if the job queue doesn't have a fair- share scheduling policy. If the job queue has a fair-share scheduling policy, then this parameter must be specified.
Sourcepub fn timeout_config(self, input: ServiceJobTimeout) -> Self
pub fn timeout_config(self, input: ServiceJobTimeout) -> Self
The timeout configuration for the service job. If none is specified, Batch defers to the default timeout of the underlying service handling the job.
Sourcepub fn set_timeout_config(self, input: Option<ServiceJobTimeout>) -> Self
pub fn set_timeout_config(self, input: Option<ServiceJobTimeout>) -> Self
The timeout configuration for the service job. If none is specified, Batch defers to the default timeout of the underlying service handling the job.
Sourcepub fn get_timeout_config(&self) -> &Option<ServiceJobTimeout>
pub fn get_timeout_config(&self) -> &Option<ServiceJobTimeout>
The timeout configuration for the service job. If none is specified, Batch defers to the default timeout of the underlying service handling the job.
Adds a key-value pair to tags
.
To override the contents of this collection use set_tags
.
The tags that you apply to the service job request. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources.
The tags that you apply to the service job request. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources.
The tags that you apply to the service job request. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources.
Sourcepub fn client_token(self, input: impl Into<String>) -> Self
pub fn client_token(self, input: impl Into<String>) -> Self
A unique identifier for the request. This token is used to ensure idempotency of requests. If this parameter is specified and two submit requests with identical payloads and clientToken
s are received, these requests are considered the same request and the second request is rejected.
Sourcepub fn set_client_token(self, input: Option<String>) -> Self
pub fn set_client_token(self, input: Option<String>) -> Self
A unique identifier for the request. This token is used to ensure idempotency of requests. If this parameter is specified and two submit requests with identical payloads and clientToken
s are received, these requests are considered the same request and the second request is rejected.
Sourcepub fn get_client_token(&self) -> &Option<String>
pub fn get_client_token(&self) -> &Option<String>
A unique identifier for the request. This token is used to ensure idempotency of requests. If this parameter is specified and two submit requests with identical payloads and clientToken
s are received, these requests are considered the same request and the second request is rejected.
Trait Implementations§
Source§impl Clone for SubmitServiceJobFluentBuilder
impl Clone for SubmitServiceJobFluentBuilder
Source§fn clone(&self) -> SubmitServiceJobFluentBuilder
fn clone(&self) -> SubmitServiceJobFluentBuilder
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 SubmitServiceJobFluentBuilder
impl !RefUnwindSafe for SubmitServiceJobFluentBuilder
impl Send for SubmitServiceJobFluentBuilder
impl Sync for SubmitServiceJobFluentBuilder
impl Unpin for SubmitServiceJobFluentBuilder
impl !UnwindSafe for SubmitServiceJobFluentBuilder
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);