Class SplunkDestinationConfiguration

java.lang.Object
software.amazon.awssdk.services.firehose.model.SplunkDestinationConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SplunkDestinationConfiguration.Builder,SplunkDestinationConfiguration>
@Generated("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:

  • Method Details

    • 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:

    • 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:

    • hecToken

      public final 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 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 FailedEventsOnly, 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.

      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 FailedEventsOnly, 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.

      See Also:

    • s3BackupModeAsString

      public final String s3BackupModeAsString()

      Defines how documents should be delivered to Amazon S3. When set to FailedEventsOnly, 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.

      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 FailedEventsOnly, 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.

      See Also:

    • s3Configuration

      public final S3DestinationConfiguration s3Configuration()

      The configuration for the backup Amazon S3 location.

      Returns:
      The configuration for 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 Firehose stream.

      Returns:
      The Amazon CloudWatch logging options for your Firehose 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 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 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.