com.amazonaws.services.kinesisfirehose.model.SplunkDestinationDescription Maven / Gradle / Ivy
Show all versions of aws-java-sdk-kinesis Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.kinesisfirehose.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Describes a destination in Splunk.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class SplunkDestinationDescription implements Serializable, Cloneable, StructuredPojo {
/**
*
* The HTTP Event Collector (HEC) endpoint to which Firehose sends your data.
*
*/
private String hECEndpoint;
/**
*
* This type can be either "Raw" or "Event."
*
*/
private String hECEndpointType;
/**
*
* A GUID you obtain from your Splunk cluster when you create a new HEC endpoint.
*
*/
private String hECToken;
/**
*
* 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.
*
*/
private Integer hECAcknowledgmentTimeoutInSeconds;
/**
*
* 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.
*
*/
private SplunkRetryOptions retryOptions;
/**
*
* 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.
*
*/
private String s3BackupMode;
/**
*
* The Amazon S3 destination.>
*
*/
private S3DestinationDescription s3DestinationDescription;
/**
*
* The data processing configuration.
*
*/
private ProcessingConfiguration processingConfiguration;
/**
*
* The Amazon CloudWatch logging options for your delivery stream.
*
*/
private CloudWatchLoggingOptions cloudWatchLoggingOptions;
/**
*
* The buffering options. If no value is specified, the default values for Splunk are used.
*
*/
private SplunkBufferingHints bufferingHints;
/**
*
* The configuration that defines how you access secrets for Splunk.
*
*/
private SecretsManagerConfiguration secretsManagerConfiguration;
/**
*
* The HTTP Event Collector (HEC) endpoint to which Firehose sends your data.
*
*
* @param hECEndpoint
* The HTTP Event Collector (HEC) endpoint to which Firehose sends your data.
*/
public void setHECEndpoint(String hECEndpoint) {
this.hECEndpoint = hECEndpoint;
}
/**
*
* The HTTP Event Collector (HEC) endpoint to which Firehose sends your data.
*
*
* @return The HTTP Event Collector (HEC) endpoint to which Firehose sends your data.
*/
public String getHECEndpoint() {
return this.hECEndpoint;
}
/**
*
* The HTTP Event Collector (HEC) endpoint to which Firehose sends your data.
*
*
* @param hECEndpoint
* The HTTP Event Collector (HEC) endpoint to which Firehose sends your data.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SplunkDestinationDescription withHECEndpoint(String hECEndpoint) {
setHECEndpoint(hECEndpoint);
return this;
}
/**
*
* This type can be either "Raw" or "Event."
*
*
* @param hECEndpointType
* This type can be either "Raw" or "Event."
* @see HECEndpointType
*/
public void setHECEndpointType(String hECEndpointType) {
this.hECEndpointType = hECEndpointType;
}
/**
*
* This type can be either "Raw" or "Event."
*
*
* @return This type can be either "Raw" or "Event."
* @see HECEndpointType
*/
public String getHECEndpointType() {
return this.hECEndpointType;
}
/**
*
* This type can be either "Raw" or "Event."
*
*
* @param hECEndpointType
* This type can be either "Raw" or "Event."
* @return Returns a reference to this object so that method calls can be chained together.
* @see HECEndpointType
*/
public SplunkDestinationDescription withHECEndpointType(String hECEndpointType) {
setHECEndpointType(hECEndpointType);
return this;
}
/**
*
* This type can be either "Raw" or "Event."
*
*
* @param hECEndpointType
* This type can be either "Raw" or "Event."
* @return Returns a reference to this object so that method calls can be chained together.
* @see HECEndpointType
*/
public SplunkDestinationDescription withHECEndpointType(HECEndpointType hECEndpointType) {
this.hECEndpointType = hECEndpointType.toString();
return this;
}
/**
*
* A GUID you obtain from your Splunk cluster when you create a new HEC endpoint.
*
*
* @param hECToken
* A GUID you obtain from your Splunk cluster when you create a new HEC endpoint.
*/
public void setHECToken(String hECToken) {
this.hECToken = hECToken;
}
/**
*
* A GUID you obtain from your Splunk cluster when you create a new HEC endpoint.
*
*
* @return A GUID you obtain from your Splunk cluster when you create a new HEC endpoint.
*/
public String getHECToken() {
return this.hECToken;
}
/**
*
* A GUID you obtain from your Splunk cluster when you create a new HEC endpoint.
*
*
* @param hECToken
* A GUID you obtain from your Splunk cluster when you create a new HEC endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SplunkDestinationDescription withHECToken(String hECToken) {
setHECToken(hECToken);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setHECAcknowledgmentTimeoutInSeconds(Integer hECAcknowledgmentTimeoutInSeconds) {
this.hECAcknowledgmentTimeoutInSeconds = 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.
*
*
* @return 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.
*/
public Integer getHECAcknowledgmentTimeoutInSeconds() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SplunkDestinationDescription withHECAcknowledgmentTimeoutInSeconds(Integer hECAcknowledgmentTimeoutInSeconds) {
setHECAcknowledgmentTimeoutInSeconds(hECAcknowledgmentTimeoutInSeconds);
return this;
}
/**
*
* 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.
*
*
* @param 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.
*/
public void setRetryOptions(SplunkRetryOptions retryOptions) {
this.retryOptions = 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.
*
*
* @return 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.
*/
public SplunkRetryOptions getRetryOptions() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SplunkDestinationDescription withRetryOptions(SplunkRetryOptions retryOptions) {
setRetryOptions(retryOptions);
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @see SplunkS3BackupMode
*/
public void setS3BackupMode(String s3BackupMode) {
this.s3BackupMode = 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.
*
*
* @return 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 SplunkS3BackupMode
*/
public String getS3BackupMode() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SplunkS3BackupMode
*/
public SplunkDestinationDescription withS3BackupMode(String s3BackupMode) {
setS3BackupMode(s3BackupMode);
return this;
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
* @see SplunkS3BackupMode
*/
public SplunkDestinationDescription withS3BackupMode(SplunkS3BackupMode s3BackupMode) {
this.s3BackupMode = s3BackupMode.toString();
return this;
}
/**
*
* The Amazon S3 destination.>
*
*
* @param s3DestinationDescription
* The Amazon S3 destination.>
*/
public void setS3DestinationDescription(S3DestinationDescription s3DestinationDescription) {
this.s3DestinationDescription = s3DestinationDescription;
}
/**
*
* The Amazon S3 destination.>
*
*
* @return The Amazon S3 destination.>
*/
public S3DestinationDescription getS3DestinationDescription() {
return this.s3DestinationDescription;
}
/**
*
* The Amazon S3 destination.>
*
*
* @param s3DestinationDescription
* The Amazon S3 destination.>
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SplunkDestinationDescription withS3DestinationDescription(S3DestinationDescription s3DestinationDescription) {
setS3DestinationDescription(s3DestinationDescription);
return this;
}
/**
*
* The data processing configuration.
*
*
* @param processingConfiguration
* The data processing configuration.
*/
public void setProcessingConfiguration(ProcessingConfiguration processingConfiguration) {
this.processingConfiguration = processingConfiguration;
}
/**
*
* The data processing configuration.
*
*
* @return The data processing configuration.
*/
public ProcessingConfiguration getProcessingConfiguration() {
return this.processingConfiguration;
}
/**
*
* The data processing configuration.
*
*
* @param processingConfiguration
* The data processing configuration.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SplunkDestinationDescription withProcessingConfiguration(ProcessingConfiguration processingConfiguration) {
setProcessingConfiguration(processingConfiguration);
return this;
}
/**
*
* The Amazon CloudWatch logging options for your delivery stream.
*
*
* @param cloudWatchLoggingOptions
* The Amazon CloudWatch logging options for your delivery stream.
*/
public void setCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions) {
this.cloudWatchLoggingOptions = cloudWatchLoggingOptions;
}
/**
*
* The Amazon CloudWatch logging options for your delivery stream.
*
*
* @return The Amazon CloudWatch logging options for your delivery stream.
*/
public CloudWatchLoggingOptions getCloudWatchLoggingOptions() {
return this.cloudWatchLoggingOptions;
}
/**
*
* The Amazon CloudWatch logging options for your delivery stream.
*
*
* @param cloudWatchLoggingOptions
* The Amazon CloudWatch logging options for your delivery stream.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SplunkDestinationDescription withCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions) {
setCloudWatchLoggingOptions(cloudWatchLoggingOptions);
return this;
}
/**
*
* The buffering options. If no value is specified, the default values for Splunk are used.
*
*
* @param bufferingHints
* The buffering options. If no value is specified, the default values for Splunk are used.
*/
public void setBufferingHints(SplunkBufferingHints bufferingHints) {
this.bufferingHints = bufferingHints;
}
/**
*
* The buffering options. If no value is specified, the default values for Splunk are used.
*
*
* @return The buffering options. If no value is specified, the default values for Splunk are used.
*/
public SplunkBufferingHints getBufferingHints() {
return this.bufferingHints;
}
/**
*
* The buffering options. If no value is specified, the default values for Splunk are used.
*
*
* @param bufferingHints
* The buffering options. If no value is specified, the default values for Splunk are used.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SplunkDestinationDescription withBufferingHints(SplunkBufferingHints bufferingHints) {
setBufferingHints(bufferingHints);
return this;
}
/**
*
* The configuration that defines how you access secrets for Splunk.
*
*
* @param secretsManagerConfiguration
* The configuration that defines how you access secrets for Splunk.
*/
public void setSecretsManagerConfiguration(SecretsManagerConfiguration secretsManagerConfiguration) {
this.secretsManagerConfiguration = secretsManagerConfiguration;
}
/**
*
* The configuration that defines how you access secrets for Splunk.
*
*
* @return The configuration that defines how you access secrets for Splunk.
*/
public SecretsManagerConfiguration getSecretsManagerConfiguration() {
return this.secretsManagerConfiguration;
}
/**
*
* The configuration that defines how you access secrets for Splunk.
*
*
* @param secretsManagerConfiguration
* The configuration that defines how you access secrets for Splunk.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public SplunkDestinationDescription withSecretsManagerConfiguration(SecretsManagerConfiguration secretsManagerConfiguration) {
setSecretsManagerConfiguration(secretsManagerConfiguration);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getHECEndpoint() != null)
sb.append("HECEndpoint: ").append(getHECEndpoint()).append(",");
if (getHECEndpointType() != null)
sb.append("HECEndpointType: ").append(getHECEndpointType()).append(",");
if (getHECToken() != null)
sb.append("HECToken: ").append(getHECToken()).append(",");
if (getHECAcknowledgmentTimeoutInSeconds() != null)
sb.append("HECAcknowledgmentTimeoutInSeconds: ").append(getHECAcknowledgmentTimeoutInSeconds()).append(",");
if (getRetryOptions() != null)
sb.append("RetryOptions: ").append(getRetryOptions()).append(",");
if (getS3BackupMode() != null)
sb.append("S3BackupMode: ").append(getS3BackupMode()).append(",");
if (getS3DestinationDescription() != null)
sb.append("S3DestinationDescription: ").append(getS3DestinationDescription()).append(",");
if (getProcessingConfiguration() != null)
sb.append("ProcessingConfiguration: ").append(getProcessingConfiguration()).append(",");
if (getCloudWatchLoggingOptions() != null)
sb.append("CloudWatchLoggingOptions: ").append(getCloudWatchLoggingOptions()).append(",");
if (getBufferingHints() != null)
sb.append("BufferingHints: ").append(getBufferingHints()).append(",");
if (getSecretsManagerConfiguration() != null)
sb.append("SecretsManagerConfiguration: ").append(getSecretsManagerConfiguration());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof SplunkDestinationDescription == false)
return false;
SplunkDestinationDescription other = (SplunkDestinationDescription) obj;
if (other.getHECEndpoint() == null ^ this.getHECEndpoint() == null)
return false;
if (other.getHECEndpoint() != null && other.getHECEndpoint().equals(this.getHECEndpoint()) == false)
return false;
if (other.getHECEndpointType() == null ^ this.getHECEndpointType() == null)
return false;
if (other.getHECEndpointType() != null && other.getHECEndpointType().equals(this.getHECEndpointType()) == false)
return false;
if (other.getHECToken() == null ^ this.getHECToken() == null)
return false;
if (other.getHECToken() != null && other.getHECToken().equals(this.getHECToken()) == false)
return false;
if (other.getHECAcknowledgmentTimeoutInSeconds() == null ^ this.getHECAcknowledgmentTimeoutInSeconds() == null)
return false;
if (other.getHECAcknowledgmentTimeoutInSeconds() != null
&& other.getHECAcknowledgmentTimeoutInSeconds().equals(this.getHECAcknowledgmentTimeoutInSeconds()) == false)
return false;
if (other.getRetryOptions() == null ^ this.getRetryOptions() == null)
return false;
if (other.getRetryOptions() != null && other.getRetryOptions().equals(this.getRetryOptions()) == false)
return false;
if (other.getS3BackupMode() == null ^ this.getS3BackupMode() == null)
return false;
if (other.getS3BackupMode() != null && other.getS3BackupMode().equals(this.getS3BackupMode()) == false)
return false;
if (other.getS3DestinationDescription() == null ^ this.getS3DestinationDescription() == null)
return false;
if (other.getS3DestinationDescription() != null && other.getS3DestinationDescription().equals(this.getS3DestinationDescription()) == false)
return false;
if (other.getProcessingConfiguration() == null ^ this.getProcessingConfiguration() == null)
return false;
if (other.getProcessingConfiguration() != null && other.getProcessingConfiguration().equals(this.getProcessingConfiguration()) == false)
return false;
if (other.getCloudWatchLoggingOptions() == null ^ this.getCloudWatchLoggingOptions() == null)
return false;
if (other.getCloudWatchLoggingOptions() != null && other.getCloudWatchLoggingOptions().equals(this.getCloudWatchLoggingOptions()) == false)
return false;
if (other.getBufferingHints() == null ^ this.getBufferingHints() == null)
return false;
if (other.getBufferingHints() != null && other.getBufferingHints().equals(this.getBufferingHints()) == false)
return false;
if (other.getSecretsManagerConfiguration() == null ^ this.getSecretsManagerConfiguration() == null)
return false;
if (other.getSecretsManagerConfiguration() != null && other.getSecretsManagerConfiguration().equals(this.getSecretsManagerConfiguration()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getHECEndpoint() == null) ? 0 : getHECEndpoint().hashCode());
hashCode = prime * hashCode + ((getHECEndpointType() == null) ? 0 : getHECEndpointType().hashCode());
hashCode = prime * hashCode + ((getHECToken() == null) ? 0 : getHECToken().hashCode());
hashCode = prime * hashCode + ((getHECAcknowledgmentTimeoutInSeconds() == null) ? 0 : getHECAcknowledgmentTimeoutInSeconds().hashCode());
hashCode = prime * hashCode + ((getRetryOptions() == null) ? 0 : getRetryOptions().hashCode());
hashCode = prime * hashCode + ((getS3BackupMode() == null) ? 0 : getS3BackupMode().hashCode());
hashCode = prime * hashCode + ((getS3DestinationDescription() == null) ? 0 : getS3DestinationDescription().hashCode());
hashCode = prime * hashCode + ((getProcessingConfiguration() == null) ? 0 : getProcessingConfiguration().hashCode());
hashCode = prime * hashCode + ((getCloudWatchLoggingOptions() == null) ? 0 : getCloudWatchLoggingOptions().hashCode());
hashCode = prime * hashCode + ((getBufferingHints() == null) ? 0 : getBufferingHints().hashCode());
hashCode = prime * hashCode + ((getSecretsManagerConfiguration() == null) ? 0 : getSecretsManagerConfiguration().hashCode());
return hashCode;
}
@Override
public SplunkDestinationDescription clone() {
try {
return (SplunkDestinationDescription) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.kinesisfirehose.model.transform.SplunkDestinationDescriptionMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}