#[non_exhaustive]pub struct AmazonopensearchserviceDestinationDescription {Show 14 fields
pub role_arn: Option<String>,
pub domain_arn: Option<String>,
pub cluster_endpoint: Option<String>,
pub index_name: Option<String>,
pub type_name: Option<String>,
pub index_rotation_period: Option<AmazonopensearchserviceIndexRotationPeriod>,
pub buffering_hints: Option<AmazonopensearchserviceBufferingHints>,
pub retry_options: Option<AmazonopensearchserviceRetryOptions>,
pub s3_backup_mode: Option<AmazonopensearchserviceS3BackupMode>,
pub s3_destination_description: Option<S3DestinationDescription>,
pub processing_configuration: Option<ProcessingConfiguration>,
pub cloud_watch_logging_options: Option<CloudWatchLoggingOptions>,
pub vpc_configuration_description: Option<VpcConfigurationDescription>,
pub document_id_options: Option<DocumentIdOptions>,
}
Expand description
The destination description in Amazon OpenSearch Service.
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.role_arn: Option<String>
The Amazon Resource Name (ARN) of the Amazon Web Services credentials.
domain_arn: Option<String>
The ARN of the Amazon OpenSearch Service domain.
cluster_endpoint: Option<String>
The endpoint to use when communicating with the cluster. Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon OpenSearch Service.
index_name: Option<String>
The Amazon OpenSearch Service index name.
type_name: Option<String>
The Amazon OpenSearch Service type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there's no value for TypeName.
index_rotation_period: Option<AmazonopensearchserviceIndexRotationPeriod>
The Amazon OpenSearch Service index rotation period
buffering_hints: Option<AmazonopensearchserviceBufferingHints>
The buffering options.
retry_options: Option<AmazonopensearchserviceRetryOptions>
The Amazon OpenSearch Service retry options.
s3_backup_mode: Option<AmazonopensearchserviceS3BackupMode>
The Amazon S3 backup mode.
s3_destination_description: Option<S3DestinationDescription>
Describes a destination in Amazon S3.
processing_configuration: Option<ProcessingConfiguration>
Describes a data processing configuration.
cloud_watch_logging_options: Option<CloudWatchLoggingOptions>
Describes the Amazon CloudWatch logging options for your Firehose stream.
vpc_configuration_description: Option<VpcConfigurationDescription>
The details of the VPC of the Amazon OpenSearch Service destination.
document_id_options: Option<DocumentIdOptions>
Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
Implementations§
Source§impl AmazonopensearchserviceDestinationDescription
impl AmazonopensearchserviceDestinationDescription
Sourcepub fn role_arn(&self) -> Option<&str>
pub fn role_arn(&self) -> Option<&str>
The Amazon Resource Name (ARN) of the Amazon Web Services credentials.
Sourcepub fn domain_arn(&self) -> Option<&str>
pub fn domain_arn(&self) -> Option<&str>
The ARN of the Amazon OpenSearch Service domain.
Sourcepub fn cluster_endpoint(&self) -> Option<&str>
pub fn cluster_endpoint(&self) -> Option<&str>
The endpoint to use when communicating with the cluster. Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon OpenSearch Service.
Sourcepub fn index_name(&self) -> Option<&str>
pub fn index_name(&self) -> Option<&str>
The Amazon OpenSearch Service index name.
Sourcepub fn type_name(&self) -> Option<&str>
pub fn type_name(&self) -> Option<&str>
The Amazon OpenSearch Service type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there's no value for TypeName.
Sourcepub fn index_rotation_period(
&self,
) -> Option<&AmazonopensearchserviceIndexRotationPeriod>
pub fn index_rotation_period( &self, ) -> Option<&AmazonopensearchserviceIndexRotationPeriod>
The Amazon OpenSearch Service index rotation period
Sourcepub fn buffering_hints(&self) -> Option<&AmazonopensearchserviceBufferingHints>
pub fn buffering_hints(&self) -> Option<&AmazonopensearchserviceBufferingHints>
The buffering options.
Sourcepub fn retry_options(&self) -> Option<&AmazonopensearchserviceRetryOptions>
pub fn retry_options(&self) -> Option<&AmazonopensearchserviceRetryOptions>
The Amazon OpenSearch Service retry options.
Sourcepub fn s3_backup_mode(&self) -> Option<&AmazonopensearchserviceS3BackupMode>
pub fn s3_backup_mode(&self) -> Option<&AmazonopensearchserviceS3BackupMode>
The Amazon S3 backup mode.
Sourcepub fn s3_destination_description(&self) -> Option<&S3DestinationDescription>
pub fn s3_destination_description(&self) -> Option<&S3DestinationDescription>
Describes a destination in Amazon S3.
Sourcepub fn processing_configuration(&self) -> Option<&ProcessingConfiguration>
pub fn processing_configuration(&self) -> Option<&ProcessingConfiguration>
Describes a data processing configuration.
Sourcepub fn cloud_watch_logging_options(&self) -> Option<&CloudWatchLoggingOptions>
pub fn cloud_watch_logging_options(&self) -> Option<&CloudWatchLoggingOptions>
Describes the Amazon CloudWatch logging options for your Firehose stream.
Sourcepub fn vpc_configuration_description(
&self,
) -> Option<&VpcConfigurationDescription>
pub fn vpc_configuration_description( &self, ) -> Option<&VpcConfigurationDescription>
The details of the VPC of the Amazon OpenSearch Service destination.
Sourcepub fn document_id_options(&self) -> Option<&DocumentIdOptions>
pub fn document_id_options(&self) -> Option<&DocumentIdOptions>
Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
Source§impl AmazonopensearchserviceDestinationDescription
impl AmazonopensearchserviceDestinationDescription
Sourcepub fn builder() -> AmazonopensearchserviceDestinationDescriptionBuilder
pub fn builder() -> AmazonopensearchserviceDestinationDescriptionBuilder
Creates a new builder-style object to manufacture AmazonopensearchserviceDestinationDescription
.
Trait Implementations§
Source§impl Clone for AmazonopensearchserviceDestinationDescription
impl Clone for AmazonopensearchserviceDestinationDescription
Source§fn clone(&self) -> AmazonopensearchserviceDestinationDescription
fn clone(&self) -> AmazonopensearchserviceDestinationDescription
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl PartialEq for AmazonopensearchserviceDestinationDescription
impl PartialEq for AmazonopensearchserviceDestinationDescription
Source§fn eq(&self, other: &AmazonopensearchserviceDestinationDescription) -> bool
fn eq(&self, other: &AmazonopensearchserviceDestinationDescription) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for AmazonopensearchserviceDestinationDescription
Auto Trait Implementations§
impl Freeze for AmazonopensearchserviceDestinationDescription
impl RefUnwindSafe for AmazonopensearchserviceDestinationDescription
impl Send for AmazonopensearchserviceDestinationDescription
impl Sync for AmazonopensearchserviceDestinationDescription
impl Unpin for AmazonopensearchserviceDestinationDescription
impl UnwindSafe for AmazonopensearchserviceDestinationDescription
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);