java.lang.Object
- software.amazon.awssdk.services.firehose.model.SplunkDestinationDescription

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<SplunkDestinationDescription.Builder,SplunkDestinationDescription>

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

Describes a destination in Splunk.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface SplunkDestinationDescription.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`SplunkBufferingHints`	`bufferingHints()`	The buffering options.
`static SplunkDestinationDescription.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 Firehose waits to receive an acknowledgment from Splunk after it sends it data.
`String`	`hecEndpoint()`	The HTTP Event Collector (HEC) endpoint to which 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 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 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.
`S3DestinationDescription`	`s3DestinationDescription()`	The Amazon S3 destination.>
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`SecretsManagerConfiguration`	`secretsManagerConfiguration()`	The configuration that defines how you access secrets for Splunk.
`static Class<? extends SplunkDestinationDescription.Builder>`	`serializableBuilderClass()`
`SplunkDestinationDescription.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 Firehose sends your data.
    
    Returns:
    
    The HTTP Event Collector (HEC) endpoint to which 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 you obtain from your Splunk cluster when you create a new HEC endpoint.
    
    Returns:
    
    A GUID you obtain from your Splunk cluster when you create a new HEC endpoint.
  - hecAcknowledgmentTimeoutInSeconds
```
public final 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.
    
    Returns:
    
    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.
  - retryOptions
```
public final 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.
    
    Returns:
    
    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.
  - s3BackupMode
```
public final 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.
    
    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, 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.
    
    See Also:
    
    SplunkS3BackupMode
  - s3BackupModeAsString
```
public final String s3BackupModeAsString()
```
    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.
    
    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, 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.
    
    See Also:
    
    SplunkS3BackupMode
  - s3DestinationDescription
```
public final S3DestinationDescription s3DestinationDescription()
```
    The Amazon S3 destination.>
    
    Returns:
    
    The Amazon S3 destination.>
  - 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.
  - bufferingHints
```
public final SplunkBufferingHints bufferingHints()
```
    The buffering options. If no value is specified, the default values for Splunk are used.
    
    Returns:
    
    The buffering options. If no value is specified, the default values for Splunk are used.
  - secretsManagerConfiguration
```
public final SecretsManagerConfiguration secretsManagerConfiguration()
```
    The configuration that defines how you access secrets for Splunk.
    
    Returns:
    
    The configuration that defines how you access secrets for Splunk.
  - toBuilder
```
public SplunkDestinationDescription.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SplunkDestinationDescription.Builder,SplunkDestinationDescription>
  - builder
```
public static SplunkDestinationDescription.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SplunkDestinationDescription.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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class SplunkDestinationDescription

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

hecEndpoint

hecEndpointType

hecEndpointTypeAsString

hecToken

hecAcknowledgmentTimeoutInSeconds

retryOptions

s3BackupMode

s3BackupModeAsString

s3DestinationDescription

processingConfiguration

cloudWatchLoggingOptions

bufferingHints

secretsManagerConfiguration

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField