PipeTargetParametersBuilder

Struct PipeTargetParametersBuilder 

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

A builder for PipeTargetParameters.

Implementations§

Source§

impl PipeTargetParametersBuilder

Source

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

Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format.

To remove an input template, specify an empty string.

Source

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

Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format.

To remove an input template, specify an empty string.

Source

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

Valid JSON text passed to the target. In this case, nothing from the event itself is passed to the target. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format.

To remove an input template, specify an empty string.

Source

pub fn lambda_function_parameters( self, input: PipeTargetLambdaFunctionParameters, ) -> Self

The parameters for using a Lambda function as a target.

Source

pub fn set_lambda_function_parameters( self, input: Option<PipeTargetLambdaFunctionParameters>, ) -> Self

The parameters for using a Lambda function as a target.

Source

pub fn get_lambda_function_parameters( &self, ) -> &Option<PipeTargetLambdaFunctionParameters>

The parameters for using a Lambda function as a target.

Source

pub fn step_function_state_machine_parameters( self, input: PipeTargetStateMachineParameters, ) -> Self

The parameters for using a Step Functions state machine as a target.

Source

pub fn set_step_function_state_machine_parameters( self, input: Option<PipeTargetStateMachineParameters>, ) -> Self

The parameters for using a Step Functions state machine as a target.

Source

pub fn get_step_function_state_machine_parameters( &self, ) -> &Option<PipeTargetStateMachineParameters>

The parameters for using a Step Functions state machine as a target.

Source

pub fn kinesis_stream_parameters( self, input: PipeTargetKinesisStreamParameters, ) -> Self

The parameters for using a Kinesis stream as a target.

Source

pub fn set_kinesis_stream_parameters( self, input: Option<PipeTargetKinesisStreamParameters>, ) -> Self

The parameters for using a Kinesis stream as a target.

Source

pub fn get_kinesis_stream_parameters( &self, ) -> &Option<PipeTargetKinesisStreamParameters>

The parameters for using a Kinesis stream as a target.

Source

pub fn ecs_task_parameters(self, input: PipeTargetEcsTaskParameters) -> Self

The parameters for using an Amazon ECS task as a target.

Source

pub fn set_ecs_task_parameters( self, input: Option<PipeTargetEcsTaskParameters>, ) -> Self

The parameters for using an Amazon ECS task as a target.

Source

pub fn get_ecs_task_parameters(&self) -> &Option<PipeTargetEcsTaskParameters>

The parameters for using an Amazon ECS task as a target.

Source

pub fn batch_job_parameters(self, input: PipeTargetBatchJobParameters) -> Self

The parameters for using an Batch job as a target.

Source

pub fn set_batch_job_parameters( self, input: Option<PipeTargetBatchJobParameters>, ) -> Self

The parameters for using an Batch job as a target.

Source

pub fn get_batch_job_parameters(&self) -> &Option<PipeTargetBatchJobParameters>

The parameters for using an Batch job as a target.

Source

pub fn sqs_queue_parameters(self, input: PipeTargetSqsQueueParameters) -> Self

The parameters for using a Amazon SQS stream as a target.

Source

pub fn set_sqs_queue_parameters( self, input: Option<PipeTargetSqsQueueParameters>, ) -> Self

The parameters for using a Amazon SQS stream as a target.

Source

pub fn get_sqs_queue_parameters(&self) -> &Option<PipeTargetSqsQueueParameters>

The parameters for using a Amazon SQS stream as a target.

Source

pub fn http_parameters(self, input: PipeTargetHttpParameters) -> Self

These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.

Source

pub fn set_http_parameters( self, input: Option<PipeTargetHttpParameters>, ) -> Self

These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.

Source

pub fn get_http_parameters(&self) -> &Option<PipeTargetHttpParameters>

These are custom parameter to be used when the target is an API Gateway REST APIs or EventBridge ApiDestinations.

Source

pub fn redshift_data_parameters( self, input: PipeTargetRedshiftDataParameters, ) -> Self

These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API BatchExecuteStatement.

Source

pub fn set_redshift_data_parameters( self, input: Option<PipeTargetRedshiftDataParameters>, ) -> Self

These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API BatchExecuteStatement.

Source

pub fn get_redshift_data_parameters( &self, ) -> &Option<PipeTargetRedshiftDataParameters>

These are custom parameters to be used when the target is a Amazon Redshift cluster to invoke the Amazon Redshift Data API BatchExecuteStatement.

Source

pub fn sage_maker_pipeline_parameters( self, input: PipeTargetSageMakerPipelineParameters, ) -> Self

The parameters for using a SageMaker pipeline as a target.

Source

pub fn set_sage_maker_pipeline_parameters( self, input: Option<PipeTargetSageMakerPipelineParameters>, ) -> Self

The parameters for using a SageMaker pipeline as a target.

Source

pub fn get_sage_maker_pipeline_parameters( &self, ) -> &Option<PipeTargetSageMakerPipelineParameters>

The parameters for using a SageMaker pipeline as a target.

Source

pub fn event_bridge_event_bus_parameters( self, input: PipeTargetEventBridgeEventBusParameters, ) -> Self

The parameters for using an EventBridge event bus as a target.

Source

pub fn set_event_bridge_event_bus_parameters( self, input: Option<PipeTargetEventBridgeEventBusParameters>, ) -> Self

The parameters for using an EventBridge event bus as a target.

Source

pub fn get_event_bridge_event_bus_parameters( &self, ) -> &Option<PipeTargetEventBridgeEventBusParameters>

The parameters for using an EventBridge event bus as a target.

Source

pub fn cloud_watch_logs_parameters( self, input: PipeTargetCloudWatchLogsParameters, ) -> Self

The parameters for using an CloudWatch Logs log stream as a target.

Source

pub fn set_cloud_watch_logs_parameters( self, input: Option<PipeTargetCloudWatchLogsParameters>, ) -> Self

The parameters for using an CloudWatch Logs log stream as a target.

Source

pub fn get_cloud_watch_logs_parameters( &self, ) -> &Option<PipeTargetCloudWatchLogsParameters>

The parameters for using an CloudWatch Logs log stream as a target.

Source

pub fn timestream_parameters( self, input: PipeTargetTimestreamParameters, ) -> Self

The parameters for using a Timestream for LiveAnalytics table as a target.

Source

pub fn set_timestream_parameters( self, input: Option<PipeTargetTimestreamParameters>, ) -> Self

The parameters for using a Timestream for LiveAnalytics table as a target.

Source

pub fn get_timestream_parameters( &self, ) -> &Option<PipeTargetTimestreamParameters>

The parameters for using a Timestream for LiveAnalytics table as a target.

Source

pub fn build(self) -> PipeTargetParameters

Consumes the builder and constructs a PipeTargetParameters.

Trait Implementations§

Source§

impl Clone for PipeTargetParametersBuilder

Source§

fn clone(&self) -> PipeTargetParametersBuilder

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 PipeTargetParametersBuilder

Source§

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

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

impl Default for PipeTargetParametersBuilder

Source§

fn default() -> PipeTargetParametersBuilder

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

impl PartialEq for PipeTargetParametersBuilder

Source§

fn eq(&self, other: &PipeTargetParametersBuilder) -> 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 PipeTargetParametersBuilder

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,