#[non_exhaustive]pub struct GetSessionActionOutput {
pub session_action_id: String,
pub status: SessionActionStatus,
pub started_at: Option<DateTime>,
pub ended_at: Option<DateTime>,
pub worker_updated_at: Option<DateTime>,
pub progress_percent: Option<f32>,
pub session_id: String,
pub process_exit_code: Option<i32>,
pub progress_message: Option<String>,
pub definition: Option<SessionActionDefinition>,
pub acquired_limits: Option<Vec<AcquiredLimit>>,
pub manifests: Option<Vec<TaskRunManifestPropertiesResponse>>,
/* private fields */
}
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.session_action_id: String
The session action ID.
status: SessionActionStatus
The status of the session action.
started_at: Option<DateTime>
The date and time the resource started running.
ended_at: Option<DateTime>
The date and time the resource ended running.
worker_updated_at: Option<DateTime>
The Linux timestamp of the date and time the session action was last updated.
progress_percent: Option<f32>
The percentage completed for a session action.
session_id: String
The session ID for the session action.
process_exit_code: Option<i32>
The process exit code. The default Deadline Cloud worker agent converts unsigned 32-bit exit codes to signed 32-bit exit codes.
progress_message: Option<String>
The message that communicates the progress of the session action.
definition: Option<SessionActionDefinition>
The session action definition.
acquired_limits: Option<Vec<AcquiredLimit>>
The limits and their amounts acquired during a session action. If no limits were acquired during the session, this field isn't returned.
manifests: Option<Vec<TaskRunManifestPropertiesResponse>>
The list of manifest properties that describe file attachments for the task run.
Implementations§
Source§impl GetSessionActionOutput
impl GetSessionActionOutput
Sourcepub fn session_action_id(&self) -> &str
pub fn session_action_id(&self) -> &str
The session action ID.
Sourcepub fn status(&self) -> &SessionActionStatus
pub fn status(&self) -> &SessionActionStatus
The status of the session action.
Sourcepub fn started_at(&self) -> Option<&DateTime>
pub fn started_at(&self) -> Option<&DateTime>
The date and time the resource started running.
Sourcepub fn worker_updated_at(&self) -> Option<&DateTime>
pub fn worker_updated_at(&self) -> Option<&DateTime>
The Linux timestamp of the date and time the session action was last updated.
Sourcepub fn progress_percent(&self) -> Option<f32>
pub fn progress_percent(&self) -> Option<f32>
The percentage completed for a session action.
Sourcepub fn session_id(&self) -> &str
pub fn session_id(&self) -> &str
The session ID for the session action.
Sourcepub fn process_exit_code(&self) -> Option<i32>
pub fn process_exit_code(&self) -> Option<i32>
The process exit code. The default Deadline Cloud worker agent converts unsigned 32-bit exit codes to signed 32-bit exit codes.
Sourcepub fn progress_message(&self) -> Option<&str>
pub fn progress_message(&self) -> Option<&str>
The message that communicates the progress of the session action.
Sourcepub fn definition(&self) -> Option<&SessionActionDefinition>
pub fn definition(&self) -> Option<&SessionActionDefinition>
The session action definition.
Sourcepub fn acquired_limits(&self) -> &[AcquiredLimit]
pub fn acquired_limits(&self) -> &[AcquiredLimit]
The limits and their amounts acquired during a session action. If no limits were acquired during the session, this field isn't returned.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .acquired_limits.is_none()
.
Sourcepub fn manifests(&self) -> &[TaskRunManifestPropertiesResponse]
pub fn manifests(&self) -> &[TaskRunManifestPropertiesResponse]
The list of manifest properties that describe file attachments for the task run.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .manifests.is_none()
.
Source§impl GetSessionActionOutput
impl GetSessionActionOutput
Sourcepub fn builder() -> GetSessionActionOutputBuilder
pub fn builder() -> GetSessionActionOutputBuilder
Creates a new builder-style object to manufacture GetSessionActionOutput
.
Trait Implementations§
Source§impl Clone for GetSessionActionOutput
impl Clone for GetSessionActionOutput
Source§fn clone(&self) -> GetSessionActionOutput
fn clone(&self) -> GetSessionActionOutput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for GetSessionActionOutput
impl Debug for GetSessionActionOutput
Source§impl PartialEq for GetSessionActionOutput
impl PartialEq for GetSessionActionOutput
Source§impl RequestId for GetSessionActionOutput
impl RequestId for GetSessionActionOutput
Source§fn request_id(&self) -> Option<&str>
fn request_id(&self) -> Option<&str>
None
if the service could not be reached.impl StructuralPartialEq for GetSessionActionOutput
Auto Trait Implementations§
impl Freeze for GetSessionActionOutput
impl RefUnwindSafe for GetSessionActionOutput
impl Send for GetSessionActionOutput
impl Sync for GetSessionActionOutput
impl Unpin for GetSessionActionOutput
impl UnwindSafe for GetSessionActionOutput
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);