#[non_exhaustive]pub struct HarvestJobBuilder { /* private fields */ }
Expand description
A builder for HarvestJob
.
Implementations§
Source§impl HarvestJobBuilder
impl HarvestJobBuilder
Sourcepub fn channel_group_name(self, input: impl Into<String>) -> Self
pub fn channel_group_name(self, input: impl Into<String>) -> Self
The name of the channel group containing the channel associated with this harvest job.
This field is required.Sourcepub fn set_channel_group_name(self, input: Option<String>) -> Self
pub fn set_channel_group_name(self, input: Option<String>) -> Self
The name of the channel group containing the channel associated with this harvest job.
Sourcepub fn get_channel_group_name(&self) -> &Option<String>
pub fn get_channel_group_name(&self) -> &Option<String>
The name of the channel group containing the channel associated with this harvest job.
Sourcepub fn channel_name(self, input: impl Into<String>) -> Self
pub fn channel_name(self, input: impl Into<String>) -> Self
The name of the channel associated with this harvest job.
This field is required.Sourcepub fn set_channel_name(self, input: Option<String>) -> Self
pub fn set_channel_name(self, input: Option<String>) -> Self
The name of the channel associated with this harvest job.
Sourcepub fn get_channel_name(&self) -> &Option<String>
pub fn get_channel_name(&self) -> &Option<String>
The name of the channel associated with this harvest job.
Sourcepub fn origin_endpoint_name(self, input: impl Into<String>) -> Self
pub fn origin_endpoint_name(self, input: impl Into<String>) -> Self
The name of the origin endpoint associated with this harvest job.
This field is required.Sourcepub fn set_origin_endpoint_name(self, input: Option<String>) -> Self
pub fn set_origin_endpoint_name(self, input: Option<String>) -> Self
The name of the origin endpoint associated with this harvest job.
Sourcepub fn get_origin_endpoint_name(&self) -> &Option<String>
pub fn get_origin_endpoint_name(&self) -> &Option<String>
The name of the origin endpoint associated with this harvest job.
Sourcepub fn destination(self, input: Destination) -> Self
pub fn destination(self, input: Destination) -> Self
The S3 destination where the harvested content will be placed.
This field is required.Sourcepub fn set_destination(self, input: Option<Destination>) -> Self
pub fn set_destination(self, input: Option<Destination>) -> Self
The S3 destination where the harvested content will be placed.
Sourcepub fn get_destination(&self) -> &Option<Destination>
pub fn get_destination(&self) -> &Option<Destination>
The S3 destination where the harvested content will be placed.
Sourcepub fn harvest_job_name(self, input: impl Into<String>) -> Self
pub fn harvest_job_name(self, input: impl Into<String>) -> Self
The name of the harvest job.
This field is required.Sourcepub fn set_harvest_job_name(self, input: Option<String>) -> Self
pub fn set_harvest_job_name(self, input: Option<String>) -> Self
The name of the harvest job.
Sourcepub fn get_harvest_job_name(&self) -> &Option<String>
pub fn get_harvest_job_name(&self) -> &Option<String>
The name of the harvest job.
Sourcepub fn harvested_manifests(self, input: HarvestedManifests) -> Self
pub fn harvested_manifests(self, input: HarvestedManifests) -> Self
A list of manifests that are being or have been harvested.
This field is required.Sourcepub fn set_harvested_manifests(self, input: Option<HarvestedManifests>) -> Self
pub fn set_harvested_manifests(self, input: Option<HarvestedManifests>) -> Self
A list of manifests that are being or have been harvested.
Sourcepub fn get_harvested_manifests(&self) -> &Option<HarvestedManifests>
pub fn get_harvested_manifests(&self) -> &Option<HarvestedManifests>
A list of manifests that are being or have been harvested.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
An optional description of the harvest job.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
An optional description of the harvest job.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
An optional description of the harvest job.
Sourcepub fn schedule_configuration(
self,
input: HarvesterScheduleConfiguration,
) -> Self
pub fn schedule_configuration( self, input: HarvesterScheduleConfiguration, ) -> Self
The configuration for when the harvest job is scheduled to run.
This field is required.Sourcepub fn set_schedule_configuration(
self,
input: Option<HarvesterScheduleConfiguration>,
) -> Self
pub fn set_schedule_configuration( self, input: Option<HarvesterScheduleConfiguration>, ) -> Self
The configuration for when the harvest job is scheduled to run.
Sourcepub fn get_schedule_configuration(
&self,
) -> &Option<HarvesterScheduleConfiguration>
pub fn get_schedule_configuration( &self, ) -> &Option<HarvesterScheduleConfiguration>
The configuration for when the harvest job is scheduled to run.
Sourcepub fn arn(self, input: impl Into<String>) -> Self
pub fn arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the harvest job.
This field is required.Sourcepub fn set_arn(self, input: Option<String>) -> Self
pub fn set_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the harvest job.
Sourcepub fn created_at(self, input: DateTime) -> Self
pub fn created_at(self, input: DateTime) -> Self
The date and time when the harvest job was created.
This field is required.Sourcepub fn set_created_at(self, input: Option<DateTime>) -> Self
pub fn set_created_at(self, input: Option<DateTime>) -> Self
The date and time when the harvest job was created.
Sourcepub fn get_created_at(&self) -> &Option<DateTime>
pub fn get_created_at(&self) -> &Option<DateTime>
The date and time when the harvest job was created.
Sourcepub fn modified_at(self, input: DateTime) -> Self
pub fn modified_at(self, input: DateTime) -> Self
The date and time when the harvest job was last modified.
This field is required.Sourcepub fn set_modified_at(self, input: Option<DateTime>) -> Self
pub fn set_modified_at(self, input: Option<DateTime>) -> Self
The date and time when the harvest job was last modified.
Sourcepub fn get_modified_at(&self) -> &Option<DateTime>
pub fn get_modified_at(&self) -> &Option<DateTime>
The date and time when the harvest job was last modified.
Sourcepub fn status(self, input: HarvestJobStatus) -> Self
pub fn status(self, input: HarvestJobStatus) -> Self
The current status of the harvest job (e.g., QUEUED, IN_PROGRESS, CANCELLED, COMPLETED, FAILED).
This field is required.Sourcepub fn set_status(self, input: Option<HarvestJobStatus>) -> Self
pub fn set_status(self, input: Option<HarvestJobStatus>) -> Self
The current status of the harvest job (e.g., QUEUED, IN_PROGRESS, CANCELLED, COMPLETED, FAILED).
Sourcepub fn get_status(&self) -> &Option<HarvestJobStatus>
pub fn get_status(&self) -> &Option<HarvestJobStatus>
The current status of the harvest job (e.g., QUEUED, IN_PROGRESS, CANCELLED, COMPLETED, FAILED).
Sourcepub fn error_message(self, input: impl Into<String>) -> Self
pub fn error_message(self, input: impl Into<String>) -> Self
An error message if the harvest job encountered any issues.
Sourcepub fn set_error_message(self, input: Option<String>) -> Self
pub fn set_error_message(self, input: Option<String>) -> Self
An error message if the harvest job encountered any issues.
Sourcepub fn get_error_message(&self) -> &Option<String>
pub fn get_error_message(&self) -> &Option<String>
An error message if the harvest job encountered any issues.
Sourcepub fn e_tag(self, input: impl Into<String>) -> Self
pub fn e_tag(self, input: impl Into<String>) -> Self
The current version of the harvest job. Used for concurrency control.
Sourcepub fn set_e_tag(self, input: Option<String>) -> Self
pub fn set_e_tag(self, input: Option<String>) -> Self
The current version of the harvest job. Used for concurrency control.
Sourcepub fn get_e_tag(&self) -> &Option<String>
pub fn get_e_tag(&self) -> &Option<String>
The current version of the harvest job. Used for concurrency control.
Sourcepub fn build(self) -> Result<HarvestJob, BuildError>
pub fn build(self) -> Result<HarvestJob, BuildError>
Consumes the builder and constructs a HarvestJob
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for HarvestJobBuilder
impl Clone for HarvestJobBuilder
Source§fn clone(&self) -> HarvestJobBuilder
fn clone(&self) -> HarvestJobBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for HarvestJobBuilder
impl Debug for HarvestJobBuilder
Source§impl Default for HarvestJobBuilder
impl Default for HarvestJobBuilder
Source§fn default() -> HarvestJobBuilder
fn default() -> HarvestJobBuilder
Source§impl PartialEq for HarvestJobBuilder
impl PartialEq for HarvestJobBuilder
impl StructuralPartialEq for HarvestJobBuilder
Auto Trait Implementations§
impl Freeze for HarvestJobBuilder
impl RefUnwindSafe for HarvestJobBuilder
impl Send for HarvestJobBuilder
impl Sync for HarvestJobBuilder
impl Unpin for HarvestJobBuilder
impl UnwindSafe for HarvestJobBuilder
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);