PipelineBuilder

Struct PipelineBuilder 

Source
#[non_exhaustive]
pub struct PipelineBuilder { /* private fields */ }
Expand description

A builder for Pipeline.

Implementations§

Source§

impl PipelineBuilder

Source

pub fn pipeline_name(self, input: impl Into<String>) -> Self

The name of the pipeline.

Source

pub fn set_pipeline_name(self, input: Option<String>) -> Self

The name of the pipeline.

Source

pub fn get_pipeline_name(&self) -> &Option<String>

The name of the pipeline.

Source

pub fn pipeline_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the pipeline.

Source

pub fn set_pipeline_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) of the pipeline.

Source

pub fn get_pipeline_arn(&self) -> &Option<String>

The Amazon Resource Name (ARN) of the pipeline.

Source

pub fn min_units(self, input: i32) -> Self

The minimum pipeline capacity, in Ingestion Compute Units (ICUs).

Source

pub fn set_min_units(self, input: Option<i32>) -> Self

The minimum pipeline capacity, in Ingestion Compute Units (ICUs).

Source

pub fn get_min_units(&self) -> &Option<i32>

The minimum pipeline capacity, in Ingestion Compute Units (ICUs).

Source

pub fn max_units(self, input: i32) -> Self

The maximum pipeline capacity, in Ingestion Compute Units (ICUs).

Source

pub fn set_max_units(self, input: Option<i32>) -> Self

The maximum pipeline capacity, in Ingestion Compute Units (ICUs).

Source

pub fn get_max_units(&self) -> &Option<i32>

The maximum pipeline capacity, in Ingestion Compute Units (ICUs).

Source

pub fn status(self, input: PipelineStatus) -> Self

The current status of the pipeline.

Source

pub fn set_status(self, input: Option<PipelineStatus>) -> Self

The current status of the pipeline.

Source

pub fn get_status(&self) -> &Option<PipelineStatus>

The current status of the pipeline.

Source

pub fn status_reason(self, input: PipelineStatusReason) -> Self

The reason for the current status of the pipeline.

Source

pub fn set_status_reason(self, input: Option<PipelineStatusReason>) -> Self

The reason for the current status of the pipeline.

Source

pub fn get_status_reason(&self) -> &Option<PipelineStatusReason>

The reason for the current status of the pipeline.

Source

pub fn pipeline_configuration_body(self, input: impl Into<String>) -> Self

The Data Prepper pipeline configuration in YAML format.

Source

pub fn set_pipeline_configuration_body(self, input: Option<String>) -> Self

The Data Prepper pipeline configuration in YAML format.

Source

pub fn get_pipeline_configuration_body(&self) -> &Option<String>

The Data Prepper pipeline configuration in YAML format.

Source

pub fn created_at(self, input: DateTime) -> Self

The date and time when the pipeline was created.

Source

pub fn set_created_at(self, input: Option<DateTime>) -> Self

The date and time when the pipeline was created.

Source

pub fn get_created_at(&self) -> &Option<DateTime>

The date and time when the pipeline was created.

Source

pub fn last_updated_at(self, input: DateTime) -> Self

The date and time when the pipeline was last updated.

Source

pub fn set_last_updated_at(self, input: Option<DateTime>) -> Self

The date and time when the pipeline was last updated.

Source

pub fn get_last_updated_at(&self) -> &Option<DateTime>

The date and time when the pipeline was last updated.

Source

pub fn ingest_endpoint_urls(self, input: impl Into<String>) -> Self

Appends an item to ingest_endpoint_urls.

To override the contents of this collection use set_ingest_endpoint_urls.

The ingestion endpoints for the pipeline, which you can send data to.

Source

pub fn set_ingest_endpoint_urls(self, input: Option<Vec<String>>) -> Self

The ingestion endpoints for the pipeline, which you can send data to.

Source

pub fn get_ingest_endpoint_urls(&self) -> &Option<Vec<String>>

The ingestion endpoints for the pipeline, which you can send data to.

Source

pub fn log_publishing_options(self, input: LogPublishingOptions) -> Self

Key-value pairs that represent log publishing settings.

Source

pub fn set_log_publishing_options( self, input: Option<LogPublishingOptions>, ) -> Self

Key-value pairs that represent log publishing settings.

Source

pub fn get_log_publishing_options(&self) -> &Option<LogPublishingOptions>

Key-value pairs that represent log publishing settings.

Source

pub fn vpc_endpoints(self, input: VpcEndpoint) -> Self

Appends an item to vpc_endpoints.

To override the contents of this collection use set_vpc_endpoints.

The VPC interface endpoints that have access to the pipeline.

Source

pub fn set_vpc_endpoints(self, input: Option<Vec<VpcEndpoint>>) -> Self

The VPC interface endpoints that have access to the pipeline.

Source

pub fn get_vpc_endpoints(&self) -> &Option<Vec<VpcEndpoint>>

The VPC interface endpoints that have access to the pipeline.

Source

pub fn buffer_options(self, input: BufferOptions) -> Self

Options that specify the configuration of a persistent buffer. To configure how OpenSearch Ingestion encrypts this data, set the EncryptionAtRestOptions. For more information, see Persistent buffering.

Source

pub fn set_buffer_options(self, input: Option<BufferOptions>) -> Self

Options that specify the configuration of a persistent buffer. To configure how OpenSearch Ingestion encrypts this data, set the EncryptionAtRestOptions. For more information, see Persistent buffering.

Source

pub fn get_buffer_options(&self) -> &Option<BufferOptions>

Options that specify the configuration of a persistent buffer. To configure how OpenSearch Ingestion encrypts this data, set the EncryptionAtRestOptions. For more information, see Persistent buffering.

Source

pub fn encryption_at_rest_options(self, input: EncryptionAtRestOptions) -> Self

Options to control how OpenSearch encrypts buffer data.

Source

pub fn set_encryption_at_rest_options( self, input: Option<EncryptionAtRestOptions>, ) -> Self

Options to control how OpenSearch encrypts buffer data.

Source

pub fn get_encryption_at_rest_options(&self) -> &Option<EncryptionAtRestOptions>

Options to control how OpenSearch encrypts buffer data.

Source

pub fn vpc_endpoint_service(self, input: impl Into<String>) -> Self

The VPC endpoint service name for the pipeline.

Source

pub fn set_vpc_endpoint_service(self, input: Option<String>) -> Self

The VPC endpoint service name for the pipeline.

Source

pub fn get_vpc_endpoint_service(&self) -> &Option<String>

The VPC endpoint service name for the pipeline.

Source

pub fn service_vpc_endpoints(self, input: ServiceVpcEndpoint) -> Self

Appends an item to service_vpc_endpoints.

To override the contents of this collection use set_service_vpc_endpoints.

A list of VPC endpoints that OpenSearch Ingestion has created to other Amazon Web Services services.

Source

pub fn set_service_vpc_endpoints( self, input: Option<Vec<ServiceVpcEndpoint>>, ) -> Self

A list of VPC endpoints that OpenSearch Ingestion has created to other Amazon Web Services services.

Source

pub fn get_service_vpc_endpoints(&self) -> &Option<Vec<ServiceVpcEndpoint>>

A list of VPC endpoints that OpenSearch Ingestion has created to other Amazon Web Services services.

Source

pub fn destinations(self, input: PipelineDestination) -> Self

Appends an item to destinations.

To override the contents of this collection use set_destinations.

Destinations to which the pipeline writes data.

Source

pub fn set_destinations(self, input: Option<Vec<PipelineDestination>>) -> Self

Destinations to which the pipeline writes data.

Source

pub fn get_destinations(&self) -> &Option<Vec<PipelineDestination>>

Destinations to which the pipeline writes data.

Source

pub fn tags(self, input: Tag) -> Self

Appends an item to tags.

To override the contents of this collection use set_tags.

A list of tags associated with the given pipeline.

Source

pub fn set_tags(self, input: Option<Vec<Tag>>) -> Self

A list of tags associated with the given pipeline.

Source

pub fn get_tags(&self) -> &Option<Vec<Tag>>

A list of tags associated with the given pipeline.

Source

pub fn pipeline_role_arn(self, input: impl Into<String>) -> Self

The Amazon Resource Name (ARN) of the IAM role that the pipeline uses to access AWS resources.

Source

pub fn set_pipeline_role_arn(self, input: Option<String>) -> Self

The Amazon Resource Name (ARN) of the IAM role that the pipeline uses to access AWS resources.

Source

pub fn get_pipeline_role_arn(&self) -> &Option<String>

The Amazon Resource Name (ARN) of the IAM role that the pipeline uses to access AWS resources.

Source

pub fn build(self) -> Pipeline

Consumes the builder and constructs a Pipeline.

Trait Implementations§

Source§

impl Clone for PipelineBuilder

Source§

fn clone(&self) -> PipelineBuilder

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for PipelineBuilder

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for PipelineBuilder

Source§

fn default() -> PipelineBuilder

Returns the “default value” for a type. Read more
Source§

impl PartialEq for PipelineBuilder

Source§

fn eq(&self, other: &PipelineBuilder) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for PipelineBuilder

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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 more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> Paint for T
where T: ?Sized,

Source§

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 primary(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Primary].

§Example
println!("{}", value.primary());
Source§

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Fixed].

§Example
println!("{}", value.fixed(color));
Source§

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Rgb].

§Example
println!("{}", value.rgb(r, g, b));
Source§

fn black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Black].

§Example
println!("{}", value.black());
Source§

fn red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Red].

§Example
println!("{}", value.red());
Source§

fn green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Green].

§Example
println!("{}", value.green());
Source§

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Yellow].

§Example
println!("{}", value.yellow());
Source§

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Blue].

§Example
println!("{}", value.blue());
Source§

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Magenta].

§Example
println!("{}", value.magenta());
Source§

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Cyan].

§Example
println!("{}", value.cyan());
Source§

fn white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: White].

§Example
println!("{}", value.white());
Source§

fn bright_black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlack].

§Example
println!("{}", value.bright_black());
Source§

fn bright_red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightRed].

§Example
println!("{}", value.bright_red());
Source§

fn bright_green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightGreen].

§Example
println!("{}", value.bright_green());
Source§

fn bright_yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightYellow].

§Example
println!("{}", value.bright_yellow());
Source§

fn bright_blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlue].

§Example
println!("{}", value.bright_blue());
Source§

fn bright_magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.bright_magenta());
Source§

fn bright_cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightCyan].

§Example
println!("{}", value.bright_cyan());
Source§

fn bright_white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightWhite].

§Example
println!("{}", value.bright_white());
Source§

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>

Returns self with the bg() set to [Color :: Primary].

§Example
println!("{}", value.on_primary());
Source§

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Fixed].

§Example
println!("{}", value.on_fixed(color));
Source§

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Rgb].

§Example
println!("{}", value.on_rgb(r, g, b));
Source§

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Black].

§Example
println!("{}", value.on_black());
Source§

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Red].

§Example
println!("{}", value.on_red());
Source§

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Green].

§Example
println!("{}", value.on_green());
Source§

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Yellow].

§Example
println!("{}", value.on_yellow());
Source§

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Blue].

§Example
println!("{}", value.on_blue());
Source§

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Magenta].

§Example
println!("{}", value.on_magenta());
Source§

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Cyan].

§Example
println!("{}", value.on_cyan());
Source§

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: White].

§Example
println!("{}", value.on_white());
Source§

fn on_bright_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlack].

§Example
println!("{}", value.on_bright_black());
Source§

fn on_bright_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightRed].

§Example
println!("{}", value.on_bright_red());
Source§

fn on_bright_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightGreen].

§Example
println!("{}", value.on_bright_green());
Source§

fn on_bright_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightYellow].

§Example
println!("{}", value.on_bright_yellow());
Source§

fn on_bright_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlue].

§Example
println!("{}", value.on_bright_blue());
Source§

fn on_bright_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.on_bright_magenta());
Source§

fn on_bright_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightCyan].

§Example
println!("{}", value.on_bright_cyan());
Source§

fn on_bright_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightWhite].

§Example
println!("{}", value.on_bright_white());
Source§

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 bold(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Bold].

§Example
println!("{}", value.bold());
Source§

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Dim].

§Example
println!("{}", value.dim());
Source§

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Italic].

§Example
println!("{}", value.italic());
Source§

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Underline].

§Example
println!("{}", value.underline());

Returns self with the attr() set to [Attribute :: Blink].

§Example
println!("{}", value.blink());

Returns self with the attr() set to [Attribute :: RapidBlink].

§Example
println!("{}", value.rapid_blink());
Source§

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Invert].

§Example
println!("{}", value.invert());
Source§

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Conceal].

§Example
println!("{}", value.conceal());
Source§

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Strike].

§Example
println!("{}", value.strike());
Source§

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 mask(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Mask].

§Example
println!("{}", value.mask());
Source§

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Wrap].

§Example
println!("{}", value.wrap());
Source§

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Linger].

§Example
println!("{}", value.linger());
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.

Returns self with the quirk() set to [Quirk :: Clear].

§Example
println!("{}", value.clear());
Source§

fn resetting(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Resetting].

§Example
println!("{}", value.resetting());
Source§

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Bright].

§Example
println!("{}", value.bright());
Source§

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: OnBright].

§Example
println!("{}", value.on_bright());
Source§

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);
Source§

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new Painted with a default Style. Read more
Source§

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,