software.amazon.awssdk.services.firehose.model

Class SplunkDestinationConfiguration

java.lang.Object

software.amazon.awssdk.services.firehose.model.SplunkDestinationConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SplunkDestinationConfiguration.Builder,SplunkDestinationConfiguration>

@Generated(value="software.amazon.awssdk:codegen")
public final class SplunkDestinationConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SplunkDestinationConfiguration.Builder,SplunkDestinationConfiguration>

Describes the configuration of a destination in Splunk.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SplunkDestinationConfiguration.Builder

Method Summary

Modifier and Type	Method and Description
static SplunkDestinationConfiguration.Builder	builder()
CloudWatchLoggingOptions	cloudWatchLoggingOptions() The Amazon CloudWatch logging options for your delivery stream.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	hecAcknowledgmentTimeoutInSeconds() The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends it data.
String	hecEndpoint() The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.
HECEndpointType	hecEndpointType() This type can be either "Raw" or "Event."
String	hecEndpointTypeAsString() This type can be either "Raw" or "Event."
String	hecToken() This is a GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.
ProcessingConfiguration	processingConfiguration() The data processing configuration.
SplunkRetryOptions	retryOptions() The retry behavior in case Kinesis Data Firehose is unable to deliver data to Splunk, or if it doesn't receive an acknowledgment of receipt from Splunk.
SplunkS3BackupMode	s3BackupMode() Defines how documents should be delivered to Amazon S3.
String	s3BackupModeAsString() Defines how documents should be delivered to Amazon S3.
S3DestinationConfiguration	s3Configuration() The configuration for the backup Amazon S3 location.
List<SdkField<?>>	sdkFields()
static Class<? extends SplunkDestinationConfiguration.Builder>	serializableBuilderClass()
SplunkDestinationConfiguration.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

hecEndpoint

public String hecEndpoint()

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

Returns:

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

hecEndpointType

public HECEndpointType hecEndpointType()

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

If the service returns an enum value that is not available in the current SDK version, hecEndpointType will return HECEndpointType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from hecEndpointTypeAsString().

Returns:

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

See Also:

HECEndpointType

hecEndpointTypeAsString

public String hecEndpointTypeAsString()

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

If the service returns an enum value that is not available in the current SDK version, hecEndpointType will return HECEndpointType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from hecEndpointTypeAsString().

Returns:

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

See Also:

HECEndpointType

hecToken

public String hecToken()

This is a GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.

Returns:

This is a GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.

hecAcknowledgmentTimeoutInSeconds

public Integer hecAcknowledgmentTimeoutInSeconds()

The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends it data. At the end of the timeout period, Kinesis Data Firehose either tries to send the data again or considers it an error, based on your retry settings.

Returns:

The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends it data. At the end of the timeout period, Kinesis Data Firehose either tries to send the data again or considers it an error, based on your retry settings.

retryOptions

public SplunkRetryOptions retryOptions()

The retry behavior in case Kinesis Data Firehose is unable to deliver data to Splunk, or if it doesn't receive an acknowledgment of receipt from Splunk.

Returns:

The retry behavior in case Kinesis Data Firehose is unable to deliver data to Splunk, or if it doesn't receive an acknowledgment of receipt from Splunk.

s3BackupMode

public SplunkS3BackupMode s3BackupMode()

Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Kinesis Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. Default value is FailedDocumentsOnly.

If the service returns an enum value that is not available in the current SDK version, s3BackupMode will return SplunkS3BackupMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from s3BackupModeAsString().

Returns:

Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Kinesis Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. Default value is FailedDocumentsOnly.

See Also:

SplunkS3BackupMode

s3BackupModeAsString

public String s3BackupModeAsString()

Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Kinesis Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. Default value is FailedDocumentsOnly.

If the service returns an enum value that is not available in the current SDK version, s3BackupMode will return SplunkS3BackupMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from s3BackupModeAsString().

Returns:

Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly, Kinesis Data Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. Default value is FailedDocumentsOnly.

See Also:

SplunkS3BackupMode

s3Configuration

public S3DestinationConfiguration s3Configuration()

The configuration for the backup Amazon S3 location.

Returns:

The configuration for the backup Amazon S3 location.

processingConfiguration

public ProcessingConfiguration processingConfiguration()

The data processing configuration.

Returns:

The data processing configuration.

cloudWatchLoggingOptions

public CloudWatchLoggingOptions cloudWatchLoggingOptions()

The Amazon CloudWatch logging options for your delivery stream.

Returns:

The Amazon CloudWatch logging options for your delivery stream.

toBuilder

public SplunkDestinationConfiguration.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<SplunkDestinationConfiguration.Builder,SplunkDestinationConfiguration>

Returns:

a builder for type T

builder

public static SplunkDestinationConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends SplunkDestinationConfiguration.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.