#[non_exhaustive]pub struct Pipeline {Show 19 fields
pub pipeline_name: Option<String>,
pub pipeline_arn: Option<String>,
pub min_units: i32,
pub max_units: i32,
pub status: Option<PipelineStatus>,
pub status_reason: Option<PipelineStatusReason>,
pub pipeline_configuration_body: Option<String>,
pub created_at: Option<DateTime>,
pub last_updated_at: Option<DateTime>,
pub ingest_endpoint_urls: Option<Vec<String>>,
pub log_publishing_options: Option<LogPublishingOptions>,
pub vpc_endpoints: Option<Vec<VpcEndpoint>>,
pub buffer_options: Option<BufferOptions>,
pub encryption_at_rest_options: Option<EncryptionAtRestOptions>,
pub vpc_endpoint_service: Option<String>,
pub service_vpc_endpoints: Option<Vec<ServiceVpcEndpoint>>,
pub destinations: Option<Vec<PipelineDestination>>,
pub tags: Option<Vec<Tag>>,
pub pipeline_role_arn: Option<String>,
}Expand description
Information about an existing OpenSearch Ingestion pipeline.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.pipeline_name: Option<String>The name of the pipeline.
pipeline_arn: Option<String>The Amazon Resource Name (ARN) of the pipeline.
min_units: i32The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
max_units: i32The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
status: Option<PipelineStatus>The current status of the pipeline.
status_reason: Option<PipelineStatusReason>The reason for the current status of the pipeline.
pipeline_configuration_body: Option<String>The Data Prepper pipeline configuration in YAML format.
created_at: Option<DateTime>The date and time when the pipeline was created.
last_updated_at: Option<DateTime>The date and time when the pipeline was last updated.
ingest_endpoint_urls: Option<Vec<String>>The ingestion endpoints for the pipeline, which you can send data to.
log_publishing_options: Option<LogPublishingOptions>Key-value pairs that represent log publishing settings.
vpc_endpoints: Option<Vec<VpcEndpoint>>The VPC interface endpoints that have access to the pipeline.
buffer_options: 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.
encryption_at_rest_options: Option<EncryptionAtRestOptions>Options to control how OpenSearch encrypts buffer data.
vpc_endpoint_service: Option<String>The VPC endpoint service name for the pipeline.
service_vpc_endpoints: Option<Vec<ServiceVpcEndpoint>>A list of VPC endpoints that OpenSearch Ingestion has created to other Amazon Web Services services.
destinations: Option<Vec<PipelineDestination>>Destinations to which the pipeline writes data.
A list of tags associated with the given pipeline.
pipeline_role_arn: Option<String>The Amazon Resource Name (ARN) of the IAM role that the pipeline uses to access AWS resources.
Implementations§
Source§impl Pipeline
impl Pipeline
Sourcepub fn pipeline_name(&self) -> Option<&str>
pub fn pipeline_name(&self) -> Option<&str>
The name of the pipeline.
Sourcepub fn pipeline_arn(&self) -> Option<&str>
pub fn pipeline_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the pipeline.
Sourcepub fn min_units(&self) -> i32
pub fn min_units(&self) -> i32
The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
Sourcepub fn max_units(&self) -> i32
pub fn max_units(&self) -> i32
The maximum pipeline capacity, in Ingestion Compute Units (ICUs).
Sourcepub fn status(&self) -> Option<&PipelineStatus>
pub fn status(&self) -> Option<&PipelineStatus>
The current status of the pipeline.
Sourcepub fn status_reason(&self) -> Option<&PipelineStatusReason>
pub fn status_reason(&self) -> Option<&PipelineStatusReason>
The reason for the current status of the pipeline.
Sourcepub fn pipeline_configuration_body(&self) -> Option<&str>
pub fn pipeline_configuration_body(&self) -> Option<&str>
The Data Prepper pipeline configuration in YAML format.
Sourcepub fn created_at(&self) -> Option<&DateTime>
pub fn created_at(&self) -> Option<&DateTime>
The date and time when the pipeline was created.
Sourcepub fn last_updated_at(&self) -> Option<&DateTime>
pub fn last_updated_at(&self) -> Option<&DateTime>
The date and time when the pipeline was last updated.
Sourcepub fn ingest_endpoint_urls(&self) -> &[String]
pub fn ingest_endpoint_urls(&self) -> &[String]
The ingestion endpoints for the pipeline, which you can send data to.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .ingest_endpoint_urls.is_none().
Sourcepub fn log_publishing_options(&self) -> Option<&LogPublishingOptions>
pub fn log_publishing_options(&self) -> Option<&LogPublishingOptions>
Key-value pairs that represent log publishing settings.
Sourcepub fn vpc_endpoints(&self) -> &[VpcEndpoint]
pub fn vpc_endpoints(&self) -> &[VpcEndpoint]
The VPC interface endpoints that have access to the pipeline.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .vpc_endpoints.is_none().
Sourcepub fn buffer_options(&self) -> Option<&BufferOptions>
pub fn 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) -> Option<&EncryptionAtRestOptions>
pub fn encryption_at_rest_options(&self) -> Option<&EncryptionAtRestOptions>
Options to control how OpenSearch encrypts buffer data.
Sourcepub fn vpc_endpoint_service(&self) -> Option<&str>
pub fn vpc_endpoint_service(&self) -> Option<&str>
The VPC endpoint service name for the pipeline.
Sourcepub fn service_vpc_endpoints(&self) -> &[ServiceVpcEndpoint]
pub fn service_vpc_endpoints(&self) -> &[ServiceVpcEndpoint]
A list of VPC endpoints that OpenSearch Ingestion has created to other Amazon Web Services services.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .service_vpc_endpoints.is_none().
Sourcepub fn destinations(&self) -> &[PipelineDestination]
pub fn destinations(&self) -> &[PipelineDestination]
Destinations to which the pipeline writes data.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .destinations.is_none().
A list of tags associated with the given pipeline.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .tags.is_none().
Sourcepub fn pipeline_role_arn(&self) -> Option<&str>
pub fn pipeline_role_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the IAM role that the pipeline uses to access AWS resources.
Trait Implementations§
impl StructuralPartialEq for Pipeline
Auto Trait Implementations§
impl Freeze for Pipeline
impl RefUnwindSafe for Pipeline
impl Send for Pipeline
impl Sync for Pipeline
impl Unpin for Pipeline
impl UnwindSafe for Pipeline
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);