com.amazonaws.services.kinesisfirehose.model

Class SplunkDestinationUpdate

java.lang.Object

com.amazonaws.services.kinesisfirehose.model.SplunkDestinationUpdate

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SplunkDestinationUpdate
extends Object
implements Serializable, Cloneable, StructuredPojo

Describes an update for a destination in Splunk.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
SplunkDestinationUpdate()

Method Summary

Modifier and Type	Method and Description
SplunkDestinationUpdate	clone()
boolean	equals(Object obj)
CloudWatchLoggingOptions	getCloudWatchLoggingOptions() The Amazon CloudWatch logging options for your delivery stream.
Integer	getHECAcknowledgmentTimeoutInSeconds() The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends data.
String	getHECEndpoint() The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.
String	getHECEndpointType() This type can be either "Raw" or "Event."
String	getHECToken() A GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.
ProcessingConfiguration	getProcessingConfiguration() The data processing configuration.
SplunkRetryOptions	getRetryOptions() 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.
String	getS3BackupMode() Defines how documents should be delivered to Amazon S3.
S3DestinationUpdate	getS3Update() Your update to the configuration of the backup Amazon S3 location.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller)
void	setCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions) The Amazon CloudWatch logging options for your delivery stream.
void	setHECAcknowledgmentTimeoutInSeconds(Integer hECAcknowledgmentTimeoutInSeconds) The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends data.
void	setHECEndpoint(String hECEndpoint) The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.
void	setHECEndpointType(String hECEndpointType) This type can be either "Raw" or "Event."
void	setHECToken(String hECToken) A GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.
void	setProcessingConfiguration(ProcessingConfiguration processingConfiguration) The data processing configuration.
void	setRetryOptions(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.
void	setS3BackupMode(String s3BackupMode) Defines how documents should be delivered to Amazon S3.
void	setS3Update(S3DestinationUpdate s3Update) Your update to the configuration of the backup Amazon S3 location.
String	toString() Returns a string representation of this object.
SplunkDestinationUpdate	withCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions) The Amazon CloudWatch logging options for your delivery stream.
SplunkDestinationUpdate	withHECAcknowledgmentTimeoutInSeconds(Integer hECAcknowledgmentTimeoutInSeconds) The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends data.
SplunkDestinationUpdate	withHECEndpoint(String hECEndpoint) The HTTP Event Collector (HEC) endpoint to which Kinesis Data Firehose sends your data.
SplunkDestinationUpdate	withHECEndpointType(HECEndpointType hECEndpointType) This type can be either "Raw" or "Event."
SplunkDestinationUpdate	withHECEndpointType(String hECEndpointType) This type can be either "Raw" or "Event."
SplunkDestinationUpdate	withHECToken(String hECToken) A GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.
SplunkDestinationUpdate	withProcessingConfiguration(ProcessingConfiguration processingConfiguration) The data processing configuration.
SplunkDestinationUpdate	withRetryOptions(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.
SplunkDestinationUpdate	withS3BackupMode(SplunkS3BackupMode s3BackupMode) Defines how documents should be delivered to Amazon S3.
SplunkDestinationUpdate	withS3BackupMode(String s3BackupMode) Defines how documents should be delivered to Amazon S3.
SplunkDestinationUpdate	withS3Update(S3DestinationUpdate s3Update) Your update to the configuration of the backup Amazon S3 location.

Methods inherited from class java.lang.Object

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

Constructor Detail

SplunkDestinationUpdate

public SplunkDestinationUpdate()

Method Detail

setHECEndpoint

public void setHECEndpoint(String hECEndpoint)

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

Parameters:

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

getHECEndpoint

public String getHECEndpoint()

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.

withHECEndpoint

public SplunkDestinationUpdate withHECEndpoint(String hECEndpoint)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setHECEndpointType

public void setHECEndpointType(String hECEndpointType)

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

Parameters:

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

See Also:

HECEndpointType

getHECEndpointType

public String getHECEndpointType()

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

Returns:

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

See Also:

HECEndpointType

withHECEndpointType

public SplunkDestinationUpdate withHECEndpointType(String hECEndpointType)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

HECEndpointType

withHECEndpointType

public SplunkDestinationUpdate withHECEndpointType(HECEndpointType hECEndpointType)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

HECEndpointType

setHECToken

public void setHECToken(String hECToken)

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

Parameters:

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

getHECToken

public String getHECToken()

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.

withHECToken

public SplunkDestinationUpdate withHECToken(String hECToken)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setHECAcknowledgmentTimeoutInSeconds

public void setHECAcknowledgmentTimeoutInSeconds(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.

Parameters:

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.

getHECAcknowledgmentTimeoutInSeconds

public Integer getHECAcknowledgmentTimeoutInSeconds()

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.

withHECAcknowledgmentTimeoutInSeconds

public SplunkDestinationUpdate withHECAcknowledgmentTimeoutInSeconds(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setRetryOptions

public void setRetryOptions(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.

Parameters:

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.

getRetryOptions

public SplunkRetryOptions getRetryOptions()

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.

withRetryOptions

public SplunkDestinationUpdate withRetryOptions(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setS3BackupMode

public void setS3BackupMode(String 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.

Parameters:

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.

See Also:

SplunkS3BackupMode

getS3BackupMode

public String getS3BackupMode()

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.

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

withS3BackupMode

public SplunkDestinationUpdate withS3BackupMode(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SplunkS3BackupMode

withS3BackupMode

public SplunkDestinationUpdate withS3BackupMode(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

SplunkS3BackupMode

setS3Update

public void setS3Update(S3DestinationUpdate s3Update)

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

Parameters:

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

getS3Update

public S3DestinationUpdate getS3Update()

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

Returns:

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

withS3Update

public SplunkDestinationUpdate withS3Update(S3DestinationUpdate s3Update)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setProcessingConfiguration

public void setProcessingConfiguration(ProcessingConfiguration processingConfiguration)

The data processing configuration.

Parameters:

processingConfiguration - The data processing configuration.

getProcessingConfiguration

public ProcessingConfiguration getProcessingConfiguration()

The data processing configuration.

Returns:

The data processing configuration.

withProcessingConfiguration

public SplunkDestinationUpdate withProcessingConfiguration(ProcessingConfiguration processingConfiguration)

The data processing configuration.

Parameters:

processingConfiguration - The data processing configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

setCloudWatchLoggingOptions

public void setCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)

The Amazon CloudWatch logging options for your delivery stream.

Parameters:

cloudWatchLoggingOptions - The Amazon CloudWatch logging options for your delivery stream.

getCloudWatchLoggingOptions

public CloudWatchLoggingOptions getCloudWatchLoggingOptions()

The Amazon CloudWatch logging options for your delivery stream.

Returns:

The Amazon CloudWatch logging options for your delivery stream.

withCloudWatchLoggingOptions

public SplunkDestinationUpdate withCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)

The Amazon CloudWatch logging options for your delivery stream.

Parameters:

cloudWatchLoggingOptions - The Amazon CloudWatch logging options for your delivery stream.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public SplunkDestinationUpdate clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Specified by:

marshall in interface StructuredPojo