#[non_exhaustive]pub struct AmazonOpenSearchServerlessDestinationConfigurationBuilder { /* private fields */ }
Expand description
A builder for AmazonOpenSearchServerlessDestinationConfiguration
.
Implementations§
Source§impl AmazonOpenSearchServerlessDestinationConfigurationBuilder
impl AmazonOpenSearchServerlessDestinationConfigurationBuilder
Sourcepub fn role_arn(self, input: impl Into<String>) -> Self
pub fn role_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.
This field is required.Sourcepub fn set_role_arn(self, input: Option<String>) -> Self
pub fn set_role_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.
Sourcepub fn get_role_arn(&self) -> &Option<String>
pub fn get_role_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.
Sourcepub fn collection_endpoint(self, input: impl Into<String>) -> Self
pub fn collection_endpoint(self, input: impl Into<String>) -> Self
The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.
Sourcepub fn set_collection_endpoint(self, input: Option<String>) -> Self
pub fn set_collection_endpoint(self, input: Option<String>) -> Self
The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.
Sourcepub fn get_collection_endpoint(&self) -> &Option<String>
pub fn get_collection_endpoint(&self) -> &Option<String>
The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.
Sourcepub fn index_name(self, input: impl Into<String>) -> Self
pub fn index_name(self, input: impl Into<String>) -> Self
The Serverless offering for Amazon OpenSearch Service index name.
This field is required.Sourcepub fn set_index_name(self, input: Option<String>) -> Self
pub fn set_index_name(self, input: Option<String>) -> Self
The Serverless offering for Amazon OpenSearch Service index name.
Sourcepub fn get_index_name(&self) -> &Option<String>
pub fn get_index_name(&self) -> &Option<String>
The Serverless offering for Amazon OpenSearch Service index name.
Sourcepub fn buffering_hints(
self,
input: AmazonOpenSearchServerlessBufferingHints,
) -> Self
pub fn buffering_hints( self, input: AmazonOpenSearchServerlessBufferingHints, ) -> Self
The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.
Sourcepub fn set_buffering_hints(
self,
input: Option<AmazonOpenSearchServerlessBufferingHints>,
) -> Self
pub fn set_buffering_hints( self, input: Option<AmazonOpenSearchServerlessBufferingHints>, ) -> Self
The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.
Sourcepub fn get_buffering_hints(
&self,
) -> &Option<AmazonOpenSearchServerlessBufferingHints>
pub fn get_buffering_hints( &self, ) -> &Option<AmazonOpenSearchServerlessBufferingHints>
The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.
Sourcepub fn retry_options(
self,
input: AmazonOpenSearchServerlessRetryOptions,
) -> Self
pub fn retry_options( self, input: AmazonOpenSearchServerlessRetryOptions, ) -> Self
The retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service. The default value is 300 (5 minutes).
Sourcepub fn set_retry_options(
self,
input: Option<AmazonOpenSearchServerlessRetryOptions>,
) -> Self
pub fn set_retry_options( self, input: Option<AmazonOpenSearchServerlessRetryOptions>, ) -> Self
The retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service. The default value is 300 (5 minutes).
Sourcepub fn get_retry_options(
&self,
) -> &Option<AmazonOpenSearchServerlessRetryOptions>
pub fn get_retry_options( &self, ) -> &Option<AmazonOpenSearchServerlessRetryOptions>
The retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service. The default value is 300 (5 minutes).
Sourcepub fn s3_backup_mode(
self,
input: AmazonOpenSearchServerlessS3BackupMode,
) -> Self
pub fn s3_backup_mode( self, input: AmazonOpenSearchServerlessS3BackupMode, ) -> Self
Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.
Sourcepub fn set_s3_backup_mode(
self,
input: Option<AmazonOpenSearchServerlessS3BackupMode>,
) -> Self
pub fn set_s3_backup_mode( self, input: Option<AmazonOpenSearchServerlessS3BackupMode>, ) -> Self
Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.
Sourcepub fn get_s3_backup_mode(
&self,
) -> &Option<AmazonOpenSearchServerlessS3BackupMode>
pub fn get_s3_backup_mode( &self, ) -> &Option<AmazonOpenSearchServerlessS3BackupMode>
Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.
Sourcepub fn s3_configuration(self, input: S3DestinationConfiguration) -> Self
pub fn s3_configuration(self, input: S3DestinationConfiguration) -> Self
Describes the configuration of a destination in Amazon S3.
This field is required.Sourcepub fn set_s3_configuration(
self,
input: Option<S3DestinationConfiguration>,
) -> Self
pub fn set_s3_configuration( self, input: Option<S3DestinationConfiguration>, ) -> Self
Describes the configuration of a destination in Amazon S3.
Sourcepub fn get_s3_configuration(&self) -> &Option<S3DestinationConfiguration>
pub fn get_s3_configuration(&self) -> &Option<S3DestinationConfiguration>
Describes the configuration of a destination in Amazon S3.
Sourcepub fn processing_configuration(self, input: ProcessingConfiguration) -> Self
pub fn processing_configuration(self, input: ProcessingConfiguration) -> Self
Describes a data processing configuration.
Sourcepub fn set_processing_configuration(
self,
input: Option<ProcessingConfiguration>,
) -> Self
pub fn set_processing_configuration( self, input: Option<ProcessingConfiguration>, ) -> Self
Describes a data processing configuration.
Sourcepub fn get_processing_configuration(&self) -> &Option<ProcessingConfiguration>
pub fn get_processing_configuration(&self) -> &Option<ProcessingConfiguration>
Describes a data processing configuration.
Sourcepub fn cloud_watch_logging_options(
self,
input: CloudWatchLoggingOptions,
) -> Self
pub fn cloud_watch_logging_options( self, input: CloudWatchLoggingOptions, ) -> Self
Describes the Amazon CloudWatch logging options for your Firehose stream.
Sourcepub fn set_cloud_watch_logging_options(
self,
input: Option<CloudWatchLoggingOptions>,
) -> Self
pub fn set_cloud_watch_logging_options( self, input: Option<CloudWatchLoggingOptions>, ) -> Self
Describes the Amazon CloudWatch logging options for your Firehose stream.
Sourcepub fn get_cloud_watch_logging_options(
&self,
) -> &Option<CloudWatchLoggingOptions>
pub fn get_cloud_watch_logging_options( &self, ) -> &Option<CloudWatchLoggingOptions>
Describes the Amazon CloudWatch logging options for your Firehose stream.
Sourcepub fn vpc_configuration(self, input: VpcConfiguration) -> Self
pub fn vpc_configuration(self, input: VpcConfiguration) -> Self
The details of the VPC of the Amazon OpenSearch or Amazon OpenSearch Serverless destination.
Sourcepub fn set_vpc_configuration(self, input: Option<VpcConfiguration>) -> Self
pub fn set_vpc_configuration(self, input: Option<VpcConfiguration>) -> Self
The details of the VPC of the Amazon OpenSearch or Amazon OpenSearch Serverless destination.
Sourcepub fn get_vpc_configuration(&self) -> &Option<VpcConfiguration>
pub fn get_vpc_configuration(&self) -> &Option<VpcConfiguration>
The details of the VPC of the Amazon OpenSearch or Amazon OpenSearch Serverless destination.
Sourcepub fn build(
self,
) -> Result<AmazonOpenSearchServerlessDestinationConfiguration, BuildError>
pub fn build( self, ) -> Result<AmazonOpenSearchServerlessDestinationConfiguration, BuildError>
Consumes the builder and constructs a AmazonOpenSearchServerlessDestinationConfiguration
.
This method will fail if any of the following fields are not set:
Trait Implementations§
Source§impl Clone for AmazonOpenSearchServerlessDestinationConfigurationBuilder
impl Clone for AmazonOpenSearchServerlessDestinationConfigurationBuilder
Source§fn clone(&self) -> AmazonOpenSearchServerlessDestinationConfigurationBuilder
fn clone(&self) -> AmazonOpenSearchServerlessDestinationConfigurationBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for AmazonOpenSearchServerlessDestinationConfigurationBuilder
impl Default for AmazonOpenSearchServerlessDestinationConfigurationBuilder
Source§fn default() -> AmazonOpenSearchServerlessDestinationConfigurationBuilder
fn default() -> AmazonOpenSearchServerlessDestinationConfigurationBuilder
Source§impl PartialEq for AmazonOpenSearchServerlessDestinationConfigurationBuilder
impl PartialEq for AmazonOpenSearchServerlessDestinationConfigurationBuilder
Source§fn eq(
&self,
other: &AmazonOpenSearchServerlessDestinationConfigurationBuilder,
) -> bool
fn eq( &self, other: &AmazonOpenSearchServerlessDestinationConfigurationBuilder, ) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for AmazonOpenSearchServerlessDestinationConfigurationBuilder
Auto Trait Implementations§
impl Freeze for AmazonOpenSearchServerlessDestinationConfigurationBuilder
impl RefUnwindSafe for AmazonOpenSearchServerlessDestinationConfigurationBuilder
impl Send for AmazonOpenSearchServerlessDestinationConfigurationBuilder
impl Sync for AmazonOpenSearchServerlessDestinationConfigurationBuilder
impl Unpin for AmazonOpenSearchServerlessDestinationConfigurationBuilder
impl UnwindSafe for AmazonOpenSearchServerlessDestinationConfigurationBuilder
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);