software.amazon.awssdk.services.firehose.model

Class SplunkDestinationUpdate

java.lang.Object

software.amazon.awssdk.services.firehose.model.SplunkDestinationUpdate

All Implemented Interfaces:

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

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

Describes an update for a destination in Splunk.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SplunkDestinationUpdate.Builder

Method Summary

Modifier and Type	Method and Description
static SplunkDestinationUpdate.Builder	builder()
CloudWatchLoggingOptions	cloudWatchLoggingOptions() The Amazon CloudWatch logging options for your delivery stream.
boolean	equals(Object obj)
boolean	equalsBySdkFields(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 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() 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() Specifies how you want Kinesis Data Firehose to back up documents to Amazon S3.
String	s3BackupModeAsString() Specifies how you want Kinesis Data Firehose to back up documents to Amazon S3.
S3DestinationUpdate	s3Update() Your update to the configuration of the backup Amazon S3 location.
List<SdkField<?>>	sdkFields()
static Class<? extends SplunkDestinationUpdate.Builder>	serializableBuilderClass()
SplunkDestinationUpdate.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

hecEndpoint

public final 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 final 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 final 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 final String hecToken()

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

Returns:

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

hecAcknowledgmentTimeoutInSeconds

public final Integer hecAcknowledgmentTimeoutInSeconds()

The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends 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 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 final 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 final SplunkS3BackupMode s3BackupMode()

Specifies how you want Kinesis Data Firehose to back up documents 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 AllEvents, Kinesis Data 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.

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:

Specifies how you want Kinesis Data Firehose to back up documents 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 AllEvents, Kinesis Data 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.

See Also:

SplunkS3BackupMode

s3BackupModeAsString

public final String s3BackupModeAsString()

Specifies how you want Kinesis Data Firehose to back up documents 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 AllEvents, Kinesis Data 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.

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:

Specifies how you want Kinesis Data Firehose to back up documents 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 AllEvents, Kinesis Data 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.

See Also:

SplunkS3BackupMode

s3Update

public final S3DestinationUpdate s3Update()

Your update to the configuration of the backup Amazon S3 location.

Returns:

Your update to the configuration of the backup Amazon S3 location.

processingConfiguration

public final ProcessingConfiguration processingConfiguration()

The data processing configuration.

Returns:

The data processing configuration.

cloudWatchLoggingOptions

public final CloudWatchLoggingOptions cloudWatchLoggingOptions()

The Amazon CloudWatch logging options for your delivery stream.

Returns:

The Amazon CloudWatch logging options for your delivery stream.

toBuilder

public SplunkDestinationUpdate.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SplunkDestinationUpdate.Builder,SplunkDestinationUpdate>

builder

public static SplunkDestinationUpdate.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

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

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo