Package software.amazon.awssdk.services.firehose.model

Interface SplunkDestinationDescription.Builder

All Superinterfaces:

Buildable, CopyableBuilder<SplunkDestinationDescription.Builder,SplunkDestinationDescription>, SdkBuilder<SplunkDestinationDescription.Builder,SplunkDestinationDescription>, SdkPojo

Enclosing class:

SplunkDestinationDescription

public static interface SplunkDestinationDescription.Builder
extends SdkPojo, CopyableBuilder<SplunkDestinationDescription.Builder,SplunkDestinationDescription>

Method Summary

Modifier and Type	Method	Description
default SplunkDestinationDescription.Builder	bufferingHints(Consumer<SplunkBufferingHints.Builder> bufferingHints)	The buffering options.
SplunkDestinationDescription.Builder	bufferingHints(SplunkBufferingHints bufferingHints)	The buffering options.
default SplunkDestinationDescription.Builder	cloudWatchLoggingOptions(Consumer<CloudWatchLoggingOptions.Builder> cloudWatchLoggingOptions)	The Amazon CloudWatch logging options for your delivery stream.
SplunkDestinationDescription.Builder	cloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)	The Amazon CloudWatch logging options for your delivery stream.
SplunkDestinationDescription.Builder	hecAcknowledgmentTimeoutInSeconds(Integer hecAcknowledgmentTimeoutInSeconds)	The amount of time that Firehose waits to receive an acknowledgment from Splunk after it sends it data.
SplunkDestinationDescription.Builder	hecEndpoint(String hecEndpoint)	The HTTP Event Collector (HEC) endpoint to which Firehose sends your data.
SplunkDestinationDescription.Builder	hecEndpointType(String hecEndpointType)	This type can be either "Raw" or "Event."
SplunkDestinationDescription.Builder	hecEndpointType(HECEndpointType hecEndpointType)	This type can be either "Raw" or "Event."
SplunkDestinationDescription.Builder	hecToken(String hecToken)	A GUID you obtain from your Splunk cluster when you create a new HEC endpoint.
default SplunkDestinationDescription.Builder	processingConfiguration(Consumer<ProcessingConfiguration.Builder> processingConfiguration)	The data processing configuration.
SplunkDestinationDescription.Builder	processingConfiguration(ProcessingConfiguration processingConfiguration)	The data processing configuration.
default SplunkDestinationDescription.Builder	retryOptions(Consumer<SplunkRetryOptions.Builder> retryOptions)	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.
SplunkDestinationDescription.Builder	retryOptions(SplunkRetryOptions retryOptions)	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.
SplunkDestinationDescription.Builder	s3BackupMode(String s3BackupMode)	Defines how documents should be delivered to Amazon S3.
SplunkDestinationDescription.Builder	s3BackupMode(SplunkS3BackupMode s3BackupMode)	Defines how documents should be delivered to Amazon S3.
default SplunkDestinationDescription.Builder	s3DestinationDescription(Consumer<S3DestinationDescription.Builder> s3DestinationDescription)	The Amazon S3 destination.>
SplunkDestinationDescription.Builder	s3DestinationDescription(S3DestinationDescription s3DestinationDescription)	The Amazon S3 destination.>

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Details

hecEndpoint

SplunkDestinationDescription.Builder hecEndpoint(String hecEndpoint)

The HTTP Event Collector (HEC) endpoint to which Firehose sends your data.

Parameters:

hecEndpoint - The HTTP Event Collector (HEC) endpoint to which Firehose sends your data.

Returns:

Returns a reference to this object so that method calls can be chained together.

hecEndpointType

SplunkDestinationDescription.Builder hecEndpointType(String hecEndpointType)

This type can be either "Raw" or "Event."

Parameters:

hecEndpointType - This type can be either "Raw" or "Event."

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• HECEndpointType
• HECEndpointType

hecEndpointType

SplunkDestinationDescription.Builder hecEndpointType(HECEndpointType hecEndpointType)

This type can be either "Raw" or "Event."

Parameters:

hecEndpointType - This type can be either "Raw" or "Event."

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• HECEndpointType
• HECEndpointType

hecToken

SplunkDestinationDescription.Builder hecToken(String hecToken)

A GUID you obtain from your Splunk cluster when you create a new HEC endpoint.

Parameters:

hecToken - A GUID you obtain from your Splunk cluster when you create a new HEC endpoint.

Returns:

Returns a reference to this object so that method calls can be chained together.

hecAcknowledgmentTimeoutInSeconds

SplunkDestinationDescription.Builder hecAcknowledgmentTimeoutInSeconds(Integer hecAcknowledgmentTimeoutInSeconds)

The amount of time that Firehose waits to receive an acknowledgment from Splunk after it sends it 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.

Parameters:

hecAcknowledgmentTimeoutInSeconds - The amount of time that Firehose waits to receive an acknowledgment from Splunk after it sends it 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

retryOptions

SplunkDestinationDescription.Builder retryOptions(SplunkRetryOptions retryOptions)

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.

Parameters:

retryOptions - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

retryOptions

default SplunkDestinationDescription.Builder retryOptions(Consumer<SplunkRetryOptions.Builder> retryOptions)

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.

This is a convenience method that creates an instance of the SplunkRetryOptions.Builder avoiding the need to create one manually via SplunkRetryOptions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to retryOptions(SplunkRetryOptions).

Parameters:

retryOptions - a consumer that will call methods on SplunkRetryOptions.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• retryOptions(SplunkRetryOptions)

s3BackupMode

SplunkDestinationDescription.Builder s3BackupMode(String s3BackupMode)

Defines how documents should be delivered 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 AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. Default value is FailedDocumentsOnly.

Parameters:

s3BackupMode - Defines how documents should be delivered 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 AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. Default value is FailedDocumentsOnly.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• SplunkS3BackupMode
• SplunkS3BackupMode

s3BackupMode

SplunkDestinationDescription.Builder s3BackupMode(SplunkS3BackupMode s3BackupMode)

Defines how documents should be delivered 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 AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. Default value is FailedDocumentsOnly.

Parameters:

s3BackupMode - Defines how documents should be delivered 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 AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. Default value is FailedDocumentsOnly.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• SplunkS3BackupMode
• SplunkS3BackupMode

s3DestinationDescription

SplunkDestinationDescription.Builder s3DestinationDescription(S3DestinationDescription s3DestinationDescription)

The Amazon S3 destination.>

Parameters:

s3DestinationDescription - The Amazon S3 destination.>

Returns:

Returns a reference to this object so that method calls can be chained together.

s3DestinationDescription

default SplunkDestinationDescription.Builder s3DestinationDescription(Consumer<S3DestinationDescription.Builder> s3DestinationDescription)

The Amazon S3 destination.>

This is a convenience method that creates an instance of the S3DestinationDescription.Builder avoiding the need to create one manually via S3DestinationDescription.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to s3DestinationDescription(S3DestinationDescription).

Parameters:

s3DestinationDescription - a consumer that will call methods on S3DestinationDescription.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• s3DestinationDescription(S3DestinationDescription)

processingConfiguration

SplunkDestinationDescription.Builder processingConfiguration(ProcessingConfiguration processingConfiguration)

The data processing configuration.

Parameters:

processingConfiguration - The data processing configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

processingConfiguration

default SplunkDestinationDescription.Builder processingConfiguration(Consumer<ProcessingConfiguration.Builder> processingConfiguration)

The data processing configuration.

This is a convenience method that creates an instance of the ProcessingConfiguration.Builder avoiding the need to create one manually via ProcessingConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to processingConfiguration(ProcessingConfiguration).

Parameters:

processingConfiguration - a consumer that will call methods on ProcessingConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• processingConfiguration(ProcessingConfiguration)

cloudWatchLoggingOptions

SplunkDestinationDescription.Builder cloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)

The Amazon CloudWatch logging options for your delivery stream.

Parameters:

cloudWatchLoggingOptions - The Amazon CloudWatch logging options for your delivery stream.

Returns:

Returns a reference to this object so that method calls can be chained together.

cloudWatchLoggingOptions

default SplunkDestinationDescription.Builder cloudWatchLoggingOptions(Consumer<CloudWatchLoggingOptions.Builder> cloudWatchLoggingOptions)

The Amazon CloudWatch logging options for your delivery stream.

This is a convenience method that creates an instance of the CloudWatchLoggingOptions.Builder avoiding the need to create one manually via CloudWatchLoggingOptions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to cloudWatchLoggingOptions(CloudWatchLoggingOptions).

Parameters:

cloudWatchLoggingOptions - a consumer that will call methods on CloudWatchLoggingOptions.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• cloudWatchLoggingOptions(CloudWatchLoggingOptions)

bufferingHints

SplunkDestinationDescription.Builder bufferingHints(SplunkBufferingHints bufferingHints)

The buffering options. If no value is specified, the default values for Splunk are used.

Parameters:

bufferingHints - The buffering options. If no value is specified, the default values for Splunk are used.

Returns:

Returns a reference to this object so that method calls can be chained together.

bufferingHints

default SplunkDestinationDescription.Builder bufferingHints(Consumer<SplunkBufferingHints.Builder> bufferingHints)

The buffering options. If no value is specified, the default values for Splunk are used.

This is a convenience method that creates an instance of the SplunkBufferingHints.Builder avoiding the need to create one manually via SplunkBufferingHints.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to bufferingHints(SplunkBufferingHints).

Parameters:

bufferingHints - a consumer that will call methods on SplunkBufferingHints.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• bufferingHints(SplunkBufferingHints)