@Generated(value="software.amazon.awssdk:codegen") public final class SplunkDestinationConfiguration extends Object implements StructuredPojo, ToCopyableBuilder<SplunkDestinationConfiguration.Builder,SplunkDestinationConfiguration>
Describes the configuration of a destination in Splunk.
Modifier and Type | Class and Description |
---|---|
static interface |
SplunkDestinationConfiguration.Builder |
Modifier and Type | Method and Description |
---|---|
static SplunkDestinationConfiguration.Builder |
builder() |
CloudWatchLoggingOptions |
cloudWatchLoggingOptions()
The 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 Firehose waits to receive an acknowledgment from Splunk after it sends it data.
|
String |
hecEndpoint()
The HTTP Event Collector (HEC) endpoint to which Kinesis 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 you obtain from your Splunk cluster when you create a new HEC endpoint.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
ProcessingConfiguration |
processingConfiguration()
The data processing configuration.
|
SplunkRetryOptions |
retryOptions()
The retry behavior in case Kinesis 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.
|
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() |
copy
public String hecEndpoint()
The HTTP Event Collector (HEC) endpoint to which Kinesis Firehose sends your data.
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()
.
HECEndpointType
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()
.
HECEndpointType
public String hecToken()
This is a GUID you obtain from your Splunk cluster when you create a new HEC endpoint.
public Integer hecAcknowledgmentTimeoutInSeconds()
The amount of time that Kinesis Firehose waits to receive an acknowledgment from Splunk after it sends it data. At the end of the timeout period Kinesis Firehose either tries to send the data again or considers it an error, based on your retry settings.
public SplunkRetryOptions retryOptions()
The retry behavior in case Kinesis Firehose is unable to deliver data to Splunk or if it doesn't receive an acknowledgment of receipt from Splunk.
public SplunkS3BackupMode s3BackupMode()
Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly
, Kinesis
Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to
AllDocuments
, Kinesis 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()
.
FailedDocumentsOnly
,
Kinesis Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When
set to AllDocuments
, Kinesis Firehose delivers all incoming records to Amazon S3, and also
writes failed documents to Amazon S3. Default value is FailedDocumentsOnly
.SplunkS3BackupMode
public String s3BackupModeAsString()
Defines how documents should be delivered to Amazon S3. When set to FailedDocumentsOnly
, Kinesis
Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to
AllDocuments
, Kinesis 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()
.
FailedDocumentsOnly
,
Kinesis Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When
set to AllDocuments
, Kinesis Firehose delivers all incoming records to Amazon S3, and also
writes failed documents to Amazon S3. Default value is FailedDocumentsOnly
.SplunkS3BackupMode
public S3DestinationConfiguration s3Configuration()
The configuration for the backup Amazon S3 location.
public ProcessingConfiguration processingConfiguration()
The data processing configuration.
public CloudWatchLoggingOptions cloudWatchLoggingOptions()
The CloudWatch logging options for your delivery stream.
public SplunkDestinationConfiguration.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<SplunkDestinationConfiguration.Builder,SplunkDestinationConfiguration>
public static SplunkDestinationConfiguration.Builder builder()
public static Class<? extends SplunkDestinationConfiguration.Builder> serializableBuilderClass()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.