#[non_exhaustive]pub struct PipelineBuilder { /* private fields */ }
Expand description
A builder for Pipeline
.
Implementations§
Source§impl PipelineBuilder
impl PipelineBuilder
Sourcepub fn pipeline_name(self, input: impl Into<String>) -> Self
pub fn pipeline_name(self, input: impl Into<String>) -> Self
The name of the pipeline.
Sourcepub fn set_pipeline_name(self, input: Option<String>) -> Self
pub fn set_pipeline_name(self, input: Option<String>) -> Self
The name of the pipeline.
Sourcepub fn get_pipeline_name(&self) -> &Option<String>
pub fn get_pipeline_name(&self) -> &Option<String>
The name of the pipeline.
Sourcepub fn pipeline_arn(self, input: impl Into<String>) -> Self
pub fn pipeline_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the pipeline.
Sourcepub fn set_pipeline_arn(self, input: Option<String>) -> Self
pub fn set_pipeline_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the pipeline.
Sourcepub fn get_pipeline_arn(&self) -> &Option<String>
pub fn get_pipeline_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the pipeline.
Sourcepub fn min_units(self, input: i32) -> Self
pub fn min_units(self, input: i32) -> Self
The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
Sourcepub fn set_min_units(self, input: Option<i32>) -> Self
pub fn set_min_units(self, input: Option<i32>) -> Self
The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
Sourcepub fn get_min_units(&self) -> &Option<i32>
pub fn get_min_units(&self) -> &Option<i32>
The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
Sourcepub fn max_units(self, input: i32) -> Self
pub fn max_units(self, input: i32) -> Self
The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
Sourcepub fn set_max_units(self, input: Option<i32>) -> Self
pub fn set_max_units(self, input: Option<i32>) -> Self
The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
Sourcepub fn get_max_units(&self) -> &Option<i32>
pub fn get_max_units(&self) -> &Option<i32>
The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
Sourcepub fn status(self, input: PipelineStatus) -> Self
pub fn status(self, input: PipelineStatus) -> Self
The current status of the pipeline.
Sourcepub fn set_status(self, input: Option<PipelineStatus>) -> Self
pub fn set_status(self, input: Option<PipelineStatus>) -> Self
The current status of the pipeline.
Sourcepub fn get_status(&self) -> &Option<PipelineStatus>
pub fn get_status(&self) -> &Option<PipelineStatus>
The current status of the pipeline.
Sourcepub fn status_reason(self, input: PipelineStatusReason) -> Self
pub fn status_reason(self, input: PipelineStatusReason) -> Self
The reason for the current status of the pipeline.
Sourcepub fn set_status_reason(self, input: Option<PipelineStatusReason>) -> Self
pub fn set_status_reason(self, input: Option<PipelineStatusReason>) -> Self
The reason for the current status of the pipeline.
Sourcepub fn get_status_reason(&self) -> &Option<PipelineStatusReason>
pub fn get_status_reason(&self) -> &Option<PipelineStatusReason>
The reason for the current status of the pipeline.
Sourcepub fn pipeline_configuration_body(self, input: impl Into<String>) -> Self
pub fn pipeline_configuration_body(self, input: impl Into<String>) -> Self
The Data Prepper pipeline configuration in YAML format.
Sourcepub fn set_pipeline_configuration_body(self, input: Option<String>) -> Self
pub fn set_pipeline_configuration_body(self, input: Option<String>) -> Self
The Data Prepper pipeline configuration in YAML format.
Sourcepub fn get_pipeline_configuration_body(&self) -> &Option<String>
pub fn get_pipeline_configuration_body(&self) -> &Option<String>
The Data Prepper pipeline configuration in YAML format.
Sourcepub fn created_at(self, input: DateTime) -> Self
pub fn created_at(self, input: DateTime) -> Self
The date and time when the pipeline was created.
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 pipeline was created.
Sourcepub fn get_created_at(&self) -> &Option<DateTime>
pub fn get_created_at(&self) -> &Option<DateTime>
The date and time when the pipeline was created.
Sourcepub fn last_updated_at(self, input: DateTime) -> Self
pub fn last_updated_at(self, input: DateTime) -> Self
The date and time when the pipeline was last updated.
Sourcepub fn set_last_updated_at(self, input: Option<DateTime>) -> Self
pub fn set_last_updated_at(self, input: Option<DateTime>) -> Self
The date and time when the pipeline was last updated.
Sourcepub fn get_last_updated_at(&self) -> &Option<DateTime>
pub fn get_last_updated_at(&self) -> &Option<DateTime>
The date and time when the pipeline was last updated.
Sourcepub fn ingest_endpoint_urls(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_ingest_endpoint_urls(self, input: Option<Vec<String>>) -> Self
pub fn set_ingest_endpoint_urls(self, input: Option<Vec<String>>) -> Self
The ingestion endpoints for the pipeline, which you can send data to.
Sourcepub fn get_ingest_endpoint_urls(&self) -> &Option<Vec<String>>
pub fn get_ingest_endpoint_urls(&self) -> &Option<Vec<String>>
The ingestion endpoints for the pipeline, which you can send data to.
Sourcepub fn log_publishing_options(self, input: LogPublishingOptions) -> Self
pub fn log_publishing_options(self, input: LogPublishingOptions) -> Self
Key-value pairs that represent log publishing settings.
Sourcepub fn set_log_publishing_options(
self,
input: Option<LogPublishingOptions>,
) -> Self
pub fn set_log_publishing_options( self, input: Option<LogPublishingOptions>, ) -> Self
Key-value pairs that represent log publishing settings.
Sourcepub fn get_log_publishing_options(&self) -> &Option<LogPublishingOptions>
pub fn get_log_publishing_options(&self) -> &Option<LogPublishingOptions>
Key-value pairs that represent log publishing settings.
Sourcepub fn vpc_endpoints(self, input: VpcEndpoint) -> Self
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.
Sourcepub fn set_vpc_endpoints(self, input: Option<Vec<VpcEndpoint>>) -> Self
pub fn set_vpc_endpoints(self, input: Option<Vec<VpcEndpoint>>) -> Self
The VPC interface endpoints that have access to the pipeline.
Sourcepub fn get_vpc_endpoints(&self) -> &Option<Vec<VpcEndpoint>>
pub fn get_vpc_endpoints(&self) -> &Option<Vec<VpcEndpoint>>
The VPC interface endpoints that have access to the pipeline.
Sourcepub fn buffer_options(self, input: BufferOptions) -> Self
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.
Sourcepub fn set_buffer_options(self, input: Option<BufferOptions>) -> Self
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.
Sourcepub fn get_buffer_options(&self) -> &Option<BufferOptions>
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.
Sourcepub fn encryption_at_rest_options(self, input: EncryptionAtRestOptions) -> Self
pub fn encryption_at_rest_options(self, input: EncryptionAtRestOptions) -> Self
Options to control how OpenSearch encrypts buffer data.
Sourcepub fn set_encryption_at_rest_options(
self,
input: Option<EncryptionAtRestOptions>,
) -> Self
pub fn set_encryption_at_rest_options( self, input: Option<EncryptionAtRestOptions>, ) -> Self
Options to control how OpenSearch encrypts buffer data.
Sourcepub fn get_encryption_at_rest_options(&self) -> &Option<EncryptionAtRestOptions>
pub fn get_encryption_at_rest_options(&self) -> &Option<EncryptionAtRestOptions>
Options to control how OpenSearch encrypts buffer data.
Sourcepub fn vpc_endpoint_service(self, input: impl Into<String>) -> Self
pub fn vpc_endpoint_service(self, input: impl Into<String>) -> Self
The VPC endpoint service name for the pipeline.
Sourcepub fn set_vpc_endpoint_service(self, input: Option<String>) -> Self
pub fn set_vpc_endpoint_service(self, input: Option<String>) -> Self
The VPC endpoint service name for the pipeline.
Sourcepub fn get_vpc_endpoint_service(&self) -> &Option<String>
pub fn get_vpc_endpoint_service(&self) -> &Option<String>
The VPC endpoint service name for the pipeline.
Sourcepub fn service_vpc_endpoints(self, input: ServiceVpcEndpoint) -> Self
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.
Sourcepub fn set_service_vpc_endpoints(
self,
input: Option<Vec<ServiceVpcEndpoint>>,
) -> Self
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.
Sourcepub fn get_service_vpc_endpoints(&self) -> &Option<Vec<ServiceVpcEndpoint>>
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.
Sourcepub fn destinations(self, input: PipelineDestination) -> Self
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.
Sourcepub fn set_destinations(self, input: Option<Vec<PipelineDestination>>) -> Self
pub fn set_destinations(self, input: Option<Vec<PipelineDestination>>) -> Self
Destinations to which the pipeline writes data.
Sourcepub fn get_destinations(&self) -> &Option<Vec<PipelineDestination>>
pub fn get_destinations(&self) -> &Option<Vec<PipelineDestination>>
Destinations to which the pipeline writes data.
Appends an item to tags
.
To override the contents of this collection use set_tags
.
A list of tags associated with the given pipeline.
A list of tags associated with the given pipeline.
A list of tags associated with the given pipeline.
Sourcepub fn pipeline_role_arn(self, input: impl Into<String>) -> Self
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.
Sourcepub fn set_pipeline_role_arn(self, input: Option<String>) -> Self
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.
Sourcepub fn get_pipeline_role_arn(&self) -> &Option<String>
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.
Trait Implementations§
Source§impl Clone for PipelineBuilder
impl Clone for PipelineBuilder
Source§fn clone(&self) -> PipelineBuilder
fn clone(&self) -> PipelineBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for PipelineBuilder
impl Debug for PipelineBuilder
Source§impl Default for PipelineBuilder
impl Default for PipelineBuilder
Source§fn default() -> PipelineBuilder
fn default() -> PipelineBuilder
Source§impl PartialEq for PipelineBuilder
impl PartialEq for PipelineBuilder
impl StructuralPartialEq for PipelineBuilder
Auto Trait Implementations§
impl Freeze for PipelineBuilder
impl RefUnwindSafe for PipelineBuilder
impl Send for PipelineBuilder
impl Sync for PipelineBuilder
impl Unpin for PipelineBuilder
impl UnwindSafe for PipelineBuilder
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);