#[non_exhaustive]pub struct SplunkDestinationUpdate {
pub hec_endpoint: Option<String>,
pub hec_endpoint_type: Option<HecEndpointType>,
pub hec_token: Option<String>,
pub hec_acknowledgment_timeout_in_seconds: Option<i32>,
pub retry_options: Option<SplunkRetryOptions>,
pub s3_backup_mode: Option<SplunkS3BackupMode>,
pub s3_update: Option<S3DestinationUpdate>,
pub processing_configuration: Option<ProcessingConfiguration>,
pub cloud_watch_logging_options: Option<CloudWatchLoggingOptions>,
pub buffering_hints: Option<SplunkBufferingHints>,
pub secrets_manager_configuration: Option<SecretsManagerConfiguration>,
}
Expand description
Describes an update for a destination in Splunk.
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.hec_endpoint: Option<String>
The HTTP Event Collector (HEC) endpoint to which Firehose sends your data.
hec_endpoint_type: Option<HecEndpointType>
This type can be either "Raw" or "Event."
hec_token: Option<String>
A GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.
hec_acknowledgment_timeout_in_seconds: Option<i32>
The amount of time that Firehose waits to receive an acknowledgment from Splunk after it sends data. At the end of the timeout period, Firehose either tries to send the data again or considers it an error, based on your retry settings.
retry_options: Option<SplunkRetryOptions>
The retry behavior in case Firehose is unable to deliver data to Splunk or if it doesn't receive an acknowledgment of receipt from Splunk.
s3_backup_mode: Option<SplunkS3BackupMode>
Specifies how you want Firehose to back up documents to Amazon S3. When set to FailedDocumentsOnly
, Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllEvents
, Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. The default value is FailedEventsOnly
.
You can update this backup mode from FailedEventsOnly
to AllEvents
. You can't update it from AllEvents
to FailedEventsOnly
.
s3_update: Option<S3DestinationUpdate>
Your update to the configuration of the backup Amazon S3 location.
processing_configuration: Option<ProcessingConfiguration>
The data processing configuration.
cloud_watch_logging_options: Option<CloudWatchLoggingOptions>
The Amazon CloudWatch logging options for your Firehose stream.
buffering_hints: Option<SplunkBufferingHints>
The buffering options. If no value is specified, the default values for Splunk are used.
secrets_manager_configuration: Option<SecretsManagerConfiguration>
The configuration that defines how you access secrets for Splunk.
Implementations§
Source§impl SplunkDestinationUpdate
impl SplunkDestinationUpdate
Sourcepub fn hec_endpoint(&self) -> Option<&str>
pub fn hec_endpoint(&self) -> Option<&str>
The HTTP Event Collector (HEC) endpoint to which Firehose sends your data.
Sourcepub fn hec_endpoint_type(&self) -> Option<&HecEndpointType>
pub fn hec_endpoint_type(&self) -> Option<&HecEndpointType>
This type can be either "Raw" or "Event."
Sourcepub fn hec_token(&self) -> Option<&str>
pub fn hec_token(&self) -> Option<&str>
A GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.
Sourcepub fn hec_acknowledgment_timeout_in_seconds(&self) -> Option<i32>
pub fn hec_acknowledgment_timeout_in_seconds(&self) -> Option<i32>
The amount of time that Firehose waits to receive an acknowledgment from Splunk after it sends data. At the end of the timeout period, Firehose either tries to send the data again or considers it an error, based on your retry settings.
Sourcepub fn retry_options(&self) -> Option<&SplunkRetryOptions>
pub fn retry_options(&self) -> Option<&SplunkRetryOptions>
The retry behavior in case Firehose is unable to deliver data to Splunk or if it doesn't receive an acknowledgment of receipt from Splunk.
Sourcepub fn s3_backup_mode(&self) -> Option<&SplunkS3BackupMode>
pub fn s3_backup_mode(&self) -> Option<&SplunkS3BackupMode>
Specifies how you want Firehose to back up documents to Amazon S3. When set to FailedDocumentsOnly
, Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllEvents
, Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. The default value is FailedEventsOnly
.
You can update this backup mode from FailedEventsOnly
to AllEvents
. You can't update it from AllEvents
to FailedEventsOnly
.
Sourcepub fn s3_update(&self) -> Option<&S3DestinationUpdate>
pub fn s3_update(&self) -> Option<&S3DestinationUpdate>
Your update to the configuration of the backup Amazon S3 location.
Sourcepub fn processing_configuration(&self) -> Option<&ProcessingConfiguration>
pub fn processing_configuration(&self) -> Option<&ProcessingConfiguration>
The data processing configuration.
Sourcepub fn cloud_watch_logging_options(&self) -> Option<&CloudWatchLoggingOptions>
pub fn cloud_watch_logging_options(&self) -> Option<&CloudWatchLoggingOptions>
The Amazon CloudWatch logging options for your Firehose stream.
Sourcepub fn buffering_hints(&self) -> Option<&SplunkBufferingHints>
pub fn buffering_hints(&self) -> Option<&SplunkBufferingHints>
The buffering options. If no value is specified, the default values for Splunk are used.
Sourcepub fn secrets_manager_configuration(
&self,
) -> Option<&SecretsManagerConfiguration>
pub fn secrets_manager_configuration( &self, ) -> Option<&SecretsManagerConfiguration>
The configuration that defines how you access secrets for Splunk.
Source§impl SplunkDestinationUpdate
impl SplunkDestinationUpdate
Sourcepub fn builder() -> SplunkDestinationUpdateBuilder
pub fn builder() -> SplunkDestinationUpdateBuilder
Creates a new builder-style object to manufacture SplunkDestinationUpdate
.
Trait Implementations§
Source§impl Clone for SplunkDestinationUpdate
impl Clone for SplunkDestinationUpdate
Source§fn clone(&self) -> SplunkDestinationUpdate
fn clone(&self) -> SplunkDestinationUpdate
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for SplunkDestinationUpdate
impl Debug for SplunkDestinationUpdate
Source§impl PartialEq for SplunkDestinationUpdate
impl PartialEq for SplunkDestinationUpdate
impl StructuralPartialEq for SplunkDestinationUpdate
Auto Trait Implementations§
impl Freeze for SplunkDestinationUpdate
impl RefUnwindSafe for SplunkDestinationUpdate
impl Send for SplunkDestinationUpdate
impl Sync for SplunkDestinationUpdate
impl Unpin for SplunkDestinationUpdate
impl UnwindSafe for SplunkDestinationUpdate
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);