#[non_exhaustive]pub struct PipeTargetParametersBuilder { /* private fields */ }
Expand description
A builder for PipeTargetParameters
.
Implementations§
Source§impl PipeTargetParametersBuilder
impl PipeTargetParametersBuilder
Sourcepub fn input_template(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_input_template(self, input: Option<String>) -> Self
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.
Sourcepub fn get_input_template(&self) -> &Option<String>
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.
Sourcepub fn lambda_function_parameters(
self,
input: PipeTargetLambdaFunctionParameters,
) -> Self
pub fn lambda_function_parameters( self, input: PipeTargetLambdaFunctionParameters, ) -> Self
The parameters for using a Lambda function as a target.
Sourcepub fn set_lambda_function_parameters(
self,
input: Option<PipeTargetLambdaFunctionParameters>,
) -> Self
pub fn set_lambda_function_parameters( self, input: Option<PipeTargetLambdaFunctionParameters>, ) -> Self
The parameters for using a Lambda function as a target.
Sourcepub fn get_lambda_function_parameters(
&self,
) -> &Option<PipeTargetLambdaFunctionParameters>
pub fn get_lambda_function_parameters( &self, ) -> &Option<PipeTargetLambdaFunctionParameters>
The parameters for using a Lambda function as a target.
Sourcepub fn step_function_state_machine_parameters(
self,
input: PipeTargetStateMachineParameters,
) -> Self
pub fn step_function_state_machine_parameters( self, input: PipeTargetStateMachineParameters, ) -> Self
The parameters for using a Step Functions state machine as a target.
Sourcepub fn set_step_function_state_machine_parameters(
self,
input: Option<PipeTargetStateMachineParameters>,
) -> Self
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.
Sourcepub fn get_step_function_state_machine_parameters(
&self,
) -> &Option<PipeTargetStateMachineParameters>
pub fn get_step_function_state_machine_parameters( &self, ) -> &Option<PipeTargetStateMachineParameters>
The parameters for using a Step Functions state machine as a target.
Sourcepub fn kinesis_stream_parameters(
self,
input: PipeTargetKinesisStreamParameters,
) -> Self
pub fn kinesis_stream_parameters( self, input: PipeTargetKinesisStreamParameters, ) -> Self
The parameters for using a Kinesis stream as a target.
Sourcepub fn set_kinesis_stream_parameters(
self,
input: Option<PipeTargetKinesisStreamParameters>,
) -> Self
pub fn set_kinesis_stream_parameters( self, input: Option<PipeTargetKinesisStreamParameters>, ) -> Self
The parameters for using a Kinesis stream as a target.
Sourcepub fn get_kinesis_stream_parameters(
&self,
) -> &Option<PipeTargetKinesisStreamParameters>
pub fn get_kinesis_stream_parameters( &self, ) -> &Option<PipeTargetKinesisStreamParameters>
The parameters for using a Kinesis stream as a target.
Sourcepub fn ecs_task_parameters(self, input: PipeTargetEcsTaskParameters) -> Self
pub fn ecs_task_parameters(self, input: PipeTargetEcsTaskParameters) -> Self
The parameters for using an Amazon ECS task as a target.
Sourcepub fn set_ecs_task_parameters(
self,
input: Option<PipeTargetEcsTaskParameters>,
) -> Self
pub fn set_ecs_task_parameters( self, input: Option<PipeTargetEcsTaskParameters>, ) -> Self
The parameters for using an Amazon ECS task as a target.
Sourcepub fn get_ecs_task_parameters(&self) -> &Option<PipeTargetEcsTaskParameters>
pub fn get_ecs_task_parameters(&self) -> &Option<PipeTargetEcsTaskParameters>
The parameters for using an Amazon ECS task as a target.
Sourcepub fn batch_job_parameters(self, input: PipeTargetBatchJobParameters) -> Self
pub fn batch_job_parameters(self, input: PipeTargetBatchJobParameters) -> Self
The parameters for using an Batch job as a target.
Sourcepub fn set_batch_job_parameters(
self,
input: Option<PipeTargetBatchJobParameters>,
) -> Self
pub fn set_batch_job_parameters( self, input: Option<PipeTargetBatchJobParameters>, ) -> Self
The parameters for using an Batch job as a target.
Sourcepub fn get_batch_job_parameters(&self) -> &Option<PipeTargetBatchJobParameters>
pub fn get_batch_job_parameters(&self) -> &Option<PipeTargetBatchJobParameters>
The parameters for using an Batch job as a target.
Sourcepub fn sqs_queue_parameters(self, input: PipeTargetSqsQueueParameters) -> Self
pub fn sqs_queue_parameters(self, input: PipeTargetSqsQueueParameters) -> Self
The parameters for using a Amazon SQS stream as a target.
Sourcepub fn set_sqs_queue_parameters(
self,
input: Option<PipeTargetSqsQueueParameters>,
) -> Self
pub fn set_sqs_queue_parameters( self, input: Option<PipeTargetSqsQueueParameters>, ) -> Self
The parameters for using a Amazon SQS stream as a target.
Sourcepub fn get_sqs_queue_parameters(&self) -> &Option<PipeTargetSqsQueueParameters>
pub fn get_sqs_queue_parameters(&self) -> &Option<PipeTargetSqsQueueParameters>
The parameters for using a Amazon SQS stream as a target.
Sourcepub fn http_parameters(self, input: PipeTargetHttpParameters) -> Self
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.
Sourcepub fn set_http_parameters(
self,
input: Option<PipeTargetHttpParameters>,
) -> Self
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.
Sourcepub fn get_http_parameters(&self) -> &Option<PipeTargetHttpParameters>
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.
Sourcepub fn redshift_data_parameters(
self,
input: PipeTargetRedshiftDataParameters,
) -> Self
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.
Sourcepub fn set_redshift_data_parameters(
self,
input: Option<PipeTargetRedshiftDataParameters>,
) -> Self
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.
Sourcepub fn get_redshift_data_parameters(
&self,
) -> &Option<PipeTargetRedshiftDataParameters>
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.
Sourcepub fn sage_maker_pipeline_parameters(
self,
input: PipeTargetSageMakerPipelineParameters,
) -> Self
pub fn sage_maker_pipeline_parameters( self, input: PipeTargetSageMakerPipelineParameters, ) -> Self
The parameters for using a SageMaker pipeline as a target.
Sourcepub fn set_sage_maker_pipeline_parameters(
self,
input: Option<PipeTargetSageMakerPipelineParameters>,
) -> Self
pub fn set_sage_maker_pipeline_parameters( self, input: Option<PipeTargetSageMakerPipelineParameters>, ) -> Self
The parameters for using a SageMaker pipeline as a target.
Sourcepub fn get_sage_maker_pipeline_parameters(
&self,
) -> &Option<PipeTargetSageMakerPipelineParameters>
pub fn get_sage_maker_pipeline_parameters( &self, ) -> &Option<PipeTargetSageMakerPipelineParameters>
The parameters for using a SageMaker pipeline as a target.
Sourcepub fn event_bridge_event_bus_parameters(
self,
input: PipeTargetEventBridgeEventBusParameters,
) -> Self
pub fn event_bridge_event_bus_parameters( self, input: PipeTargetEventBridgeEventBusParameters, ) -> Self
The parameters for using an EventBridge event bus as a target.
Sourcepub fn set_event_bridge_event_bus_parameters(
self,
input: Option<PipeTargetEventBridgeEventBusParameters>,
) -> Self
pub fn set_event_bridge_event_bus_parameters( self, input: Option<PipeTargetEventBridgeEventBusParameters>, ) -> Self
The parameters for using an EventBridge event bus as a target.
Sourcepub fn get_event_bridge_event_bus_parameters(
&self,
) -> &Option<PipeTargetEventBridgeEventBusParameters>
pub fn get_event_bridge_event_bus_parameters( &self, ) -> &Option<PipeTargetEventBridgeEventBusParameters>
The parameters for using an EventBridge event bus as a target.
Sourcepub fn cloud_watch_logs_parameters(
self,
input: PipeTargetCloudWatchLogsParameters,
) -> Self
pub fn cloud_watch_logs_parameters( self, input: PipeTargetCloudWatchLogsParameters, ) -> Self
The parameters for using an CloudWatch Logs log stream as a target.
Sourcepub fn set_cloud_watch_logs_parameters(
self,
input: Option<PipeTargetCloudWatchLogsParameters>,
) -> Self
pub fn set_cloud_watch_logs_parameters( self, input: Option<PipeTargetCloudWatchLogsParameters>, ) -> Self
The parameters for using an CloudWatch Logs log stream as a target.
Sourcepub fn get_cloud_watch_logs_parameters(
&self,
) -> &Option<PipeTargetCloudWatchLogsParameters>
pub fn get_cloud_watch_logs_parameters( &self, ) -> &Option<PipeTargetCloudWatchLogsParameters>
The parameters for using an CloudWatch Logs log stream as a target.
Sourcepub fn timestream_parameters(
self,
input: PipeTargetTimestreamParameters,
) -> Self
pub fn timestream_parameters( self, input: PipeTargetTimestreamParameters, ) -> Self
The parameters for using a Timestream for LiveAnalytics table as a target.
Sourcepub fn set_timestream_parameters(
self,
input: Option<PipeTargetTimestreamParameters>,
) -> Self
pub fn set_timestream_parameters( self, input: Option<PipeTargetTimestreamParameters>, ) -> Self
The parameters for using a Timestream for LiveAnalytics table as a target.
Sourcepub fn get_timestream_parameters(
&self,
) -> &Option<PipeTargetTimestreamParameters>
pub fn get_timestream_parameters( &self, ) -> &Option<PipeTargetTimestreamParameters>
The parameters for using a Timestream for LiveAnalytics table as a target.
Sourcepub fn build(self) -> PipeTargetParameters
pub fn build(self) -> PipeTargetParameters
Consumes the builder and constructs a PipeTargetParameters
.
Trait Implementations§
Source§impl Clone for PipeTargetParametersBuilder
impl Clone for PipeTargetParametersBuilder
Source§fn clone(&self) -> PipeTargetParametersBuilder
fn clone(&self) -> PipeTargetParametersBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for PipeTargetParametersBuilder
impl Debug for PipeTargetParametersBuilder
Source§impl Default for PipeTargetParametersBuilder
impl Default for PipeTargetParametersBuilder
Source§fn default() -> PipeTargetParametersBuilder
fn default() -> PipeTargetParametersBuilder
impl StructuralPartialEq for PipeTargetParametersBuilder
Auto Trait Implementations§
impl Freeze for PipeTargetParametersBuilder
impl RefUnwindSafe for PipeTargetParametersBuilder
impl Send for PipeTargetParametersBuilder
impl Sync for PipeTargetParametersBuilder
impl Unpin for PipeTargetParametersBuilder
impl UnwindSafe for PipeTargetParametersBuilder
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);