com.amazonaws.services.kinesisfirehose.model.HttpEndpointDestinationDescription 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 the HTTP endpoint destination.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class HttpEndpointDestinationDescription implements Serializable, Cloneable, StructuredPojo {
/**
*
* The configuration of the specified HTTP endpoint destination.
*
*/
private HttpEndpointDescription endpointConfiguration;
/**
*
* Describes buffering options that can be applied to the data before it is delivered to the HTTPS endpoint
* destination. Firehose teats these options as hints, and it might choose to use more optimal values. The
* SizeInMBs and IntervalInSeconds parameters are optional. However, if specify a value
* for one of them, you must also provide a value for the other.
*
*/
private HttpEndpointBufferingHints bufferingHints;
private CloudWatchLoggingOptions cloudWatchLoggingOptions;
/**
*
* The configuration of request sent to the HTTP endpoint specified as the destination.
*
*/
private HttpEndpointRequestConfiguration requestConfiguration;
private ProcessingConfiguration processingConfiguration;
/**
*
* Firehose uses this IAM role for all the permissions that the delivery stream needs.
*
*/
private String roleARN;
/**
*
* Describes the retry behavior in case Firehose is unable to deliver data to the specified HTTP endpoint
* destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint
* destination.
*
*/
private HttpEndpointRetryOptions retryOptions;
/**
*
* Describes the S3 bucket backup options for the data that Kinesis Firehose delivers to the HTTP endpoint
* destination. You can back up all documents (AllData) or only the documents that Firehose could not
* deliver to the specified HTTP endpoint destination (FailedDataOnly).
*
*/
private String s3BackupMode;
private S3DestinationDescription s3DestinationDescription;
/**
*
* The configuration that defines how you access secrets for HTTP Endpoint destination.
*
*/
private SecretsManagerConfiguration secretsManagerConfiguration;
/**
*
* The configuration of the specified HTTP endpoint destination.
*
*
* @param endpointConfiguration
* The configuration of the specified HTTP endpoint destination.
*/
public void setEndpointConfiguration(HttpEndpointDescription endpointConfiguration) {
this.endpointConfiguration = endpointConfiguration;
}
/**
*
* The configuration of the specified HTTP endpoint destination.
*
*
* @return The configuration of the specified HTTP endpoint destination.
*/
public HttpEndpointDescription getEndpointConfiguration() {
return this.endpointConfiguration;
}
/**
*
* The configuration of the specified HTTP endpoint destination.
*
*
* @param endpointConfiguration
* The configuration of the specified HTTP endpoint destination.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public HttpEndpointDestinationDescription withEndpointConfiguration(HttpEndpointDescription endpointConfiguration) {
setEndpointConfiguration(endpointConfiguration);
return this;
}
/**
*
* Describes buffering options that can be applied to the data before it is delivered to the HTTPS endpoint
* destination. Firehose teats these options as hints, and it might choose to use more optimal values. The
* SizeInMBs and IntervalInSeconds parameters are optional. However, if specify a value
* for one of them, you must also provide a value for the other.
*
*
* @param bufferingHints
* Describes buffering options that can be applied to the data before it is delivered to the HTTPS endpoint
* destination. Firehose teats these options as hints, and it might choose to use more optimal values. The
* SizeInMBs and IntervalInSeconds parameters are optional. However, if specify a
* value for one of them, you must also provide a value for the other.
*/
public void setBufferingHints(HttpEndpointBufferingHints bufferingHints) {
this.bufferingHints = bufferingHints;
}
/**
*
* Describes buffering options that can be applied to the data before it is delivered to the HTTPS endpoint
* destination. Firehose teats these options as hints, and it might choose to use more optimal values. The
* SizeInMBs and IntervalInSeconds parameters are optional. However, if specify a value
* for one of them, you must also provide a value for the other.
*
*
* @return Describes buffering options that can be applied to the data before it is delivered to the HTTPS endpoint
* destination. Firehose teats these options as hints, and it might choose to use more optimal values. The
* SizeInMBs and IntervalInSeconds parameters are optional. However, if specify a
* value for one of them, you must also provide a value for the other.
*/
public HttpEndpointBufferingHints getBufferingHints() {
return this.bufferingHints;
}
/**
*
* Describes buffering options that can be applied to the data before it is delivered to the HTTPS endpoint
* destination. Firehose teats these options as hints, and it might choose to use more optimal values. The
* SizeInMBs and IntervalInSeconds parameters are optional. However, if specify a value
* for one of them, you must also provide a value for the other.
*
*
* @param bufferingHints
* Describes buffering options that can be applied to the data before it is delivered to the HTTPS endpoint
* destination. Firehose teats these options as hints, and it might choose to use more optimal values. The
* SizeInMBs and IntervalInSeconds parameters are optional. However, if specify a
* value for one of them, you must also provide a value for the other.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public HttpEndpointDestinationDescription withBufferingHints(HttpEndpointBufferingHints bufferingHints) {
setBufferingHints(bufferingHints);
return this;
}
/**
* @param cloudWatchLoggingOptions
*/
public void setCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions) {
this.cloudWatchLoggingOptions = cloudWatchLoggingOptions;
}
/**
* @return
*/
public CloudWatchLoggingOptions getCloudWatchLoggingOptions() {
return this.cloudWatchLoggingOptions;
}
/**
* @param cloudWatchLoggingOptions
* @return Returns a reference to this object so that method calls can be chained together.
*/
public HttpEndpointDestinationDescription withCloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions) {
setCloudWatchLoggingOptions(cloudWatchLoggingOptions);
return this;
}
/**
*
* The configuration of request sent to the HTTP endpoint specified as the destination.
*
*
* @param requestConfiguration
* The configuration of request sent to the HTTP endpoint specified as the destination.
*/
public void setRequestConfiguration(HttpEndpointRequestConfiguration requestConfiguration) {
this.requestConfiguration = requestConfiguration;
}
/**
*
* The configuration of request sent to the HTTP endpoint specified as the destination.
*
*
* @return The configuration of request sent to the HTTP endpoint specified as the destination.
*/
public HttpEndpointRequestConfiguration getRequestConfiguration() {
return this.requestConfiguration;
}
/**
*
* The configuration of request sent to the HTTP endpoint specified as the destination.
*
*
* @param requestConfiguration
* The configuration of request sent to the HTTP endpoint specified as the destination.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public HttpEndpointDestinationDescription withRequestConfiguration(HttpEndpointRequestConfiguration requestConfiguration) {
setRequestConfiguration(requestConfiguration);
return this;
}
/**
* @param processingConfiguration
*/
public void setProcessingConfiguration(ProcessingConfiguration processingConfiguration) {
this.processingConfiguration = processingConfiguration;
}
/**
* @return
*/
public ProcessingConfiguration getProcessingConfiguration() {
return this.processingConfiguration;
}
/**
* @param processingConfiguration
* @return Returns a reference to this object so that method calls can be chained together.
*/
public HttpEndpointDestinationDescription withProcessingConfiguration(ProcessingConfiguration processingConfiguration) {
setProcessingConfiguration(processingConfiguration);
return this;
}
/**
*
* Firehose uses this IAM role for all the permissions that the delivery stream needs.
*
*
* @param roleARN
* Firehose uses this IAM role for all the permissions that the delivery stream needs.
*/
public void setRoleARN(String roleARN) {
this.roleARN = roleARN;
}
/**
*
* Firehose uses this IAM role for all the permissions that the delivery stream needs.
*
*
* @return Firehose uses this IAM role for all the permissions that the delivery stream needs.
*/
public String getRoleARN() {
return this.roleARN;
}
/**
*
* Firehose uses this IAM role for all the permissions that the delivery stream needs.
*
*
* @param roleARN
* Firehose uses this IAM role for all the permissions that the delivery stream needs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public HttpEndpointDestinationDescription withRoleARN(String roleARN) {
setRoleARN(roleARN);
return this;
}
/**
*
* Describes the retry behavior in case Firehose is unable to deliver data to the specified HTTP endpoint
* destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint
* destination.
*
*
* @param retryOptions
* Describes the retry behavior in case Firehose is unable to deliver data to the specified HTTP endpoint
* destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint
* destination.
*/
public void setRetryOptions(HttpEndpointRetryOptions retryOptions) {
this.retryOptions = retryOptions;
}
/**
*
* Describes the retry behavior in case Firehose is unable to deliver data to the specified HTTP endpoint
* destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint
* destination.
*
*
* @return Describes the retry behavior in case Firehose is unable to deliver data to the specified HTTP endpoint
* destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint
* destination.
*/
public HttpEndpointRetryOptions getRetryOptions() {
return this.retryOptions;
}
/**
*
* Describes the retry behavior in case Firehose is unable to deliver data to the specified HTTP endpoint
* destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint
* destination.
*
*
* @param retryOptions
* Describes the retry behavior in case Firehose is unable to deliver data to the specified HTTP endpoint
* destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint
* destination.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public HttpEndpointDestinationDescription withRetryOptions(HttpEndpointRetryOptions retryOptions) {
setRetryOptions(retryOptions);
return this;
}
/**
*
* Describes the S3 bucket backup options for the data that Kinesis Firehose delivers to the HTTP endpoint
* destination. You can back up all documents (AllData) or only the documents that Firehose could not
* deliver to the specified HTTP endpoint destination (FailedDataOnly).
*
*
* @param s3BackupMode
* Describes the S3 bucket backup options for the data that Kinesis Firehose delivers to the HTTP endpoint
* destination. You can back up all documents (AllData) or only the documents that Firehose
* could not deliver to the specified HTTP endpoint destination (FailedDataOnly).
* @see HttpEndpointS3BackupMode
*/
public void setS3BackupMode(String s3BackupMode) {
this.s3BackupMode = s3BackupMode;
}
/**
*
* Describes the S3 bucket backup options for the data that Kinesis Firehose delivers to the HTTP endpoint
* destination. You can back up all documents (AllData) or only the documents that Firehose could not
* deliver to the specified HTTP endpoint destination (FailedDataOnly).
*
*
* @return Describes the S3 bucket backup options for the data that Kinesis Firehose delivers to the HTTP endpoint
* destination. You can back up all documents (AllData) or only the documents that Firehose
* could not deliver to the specified HTTP endpoint destination (FailedDataOnly).
* @see HttpEndpointS3BackupMode
*/
public String getS3BackupMode() {
return this.s3BackupMode;
}
/**
*
* Describes the S3 bucket backup options for the data that Kinesis Firehose delivers to the HTTP endpoint
* destination. You can back up all documents (AllData) or only the documents that Firehose could not
* deliver to the specified HTTP endpoint destination (FailedDataOnly).
*
*
* @param s3BackupMode
* Describes the S3 bucket backup options for the data that Kinesis Firehose delivers to the HTTP endpoint
* destination. You can back up all documents (AllData) or only the documents that Firehose
* could not deliver to the specified HTTP endpoint destination (FailedDataOnly).
* @return Returns a reference to this object so that method calls can be chained together.
* @see HttpEndpointS3BackupMode
*/
public HttpEndpointDestinationDescription withS3BackupMode(String s3BackupMode) {
setS3BackupMode(s3BackupMode);
return this;
}
/**
*
* Describes the S3 bucket backup options for the data that Kinesis Firehose delivers to the HTTP endpoint
* destination. You can back up all documents (AllData) or only the documents that Firehose could not
* deliver to the specified HTTP endpoint destination (FailedDataOnly).
*
*
* @param s3BackupMode
* Describes the S3 bucket backup options for the data that Kinesis Firehose delivers to the HTTP endpoint
* destination. You can back up all documents (AllData) or only the documents that Firehose
* could not deliver to the specified HTTP endpoint destination (FailedDataOnly).
* @return Returns a reference to this object so that method calls can be chained together.
* @see HttpEndpointS3BackupMode
*/
public HttpEndpointDestinationDescription withS3BackupMode(HttpEndpointS3BackupMode s3BackupMode) {
this.s3BackupMode = s3BackupMode.toString();
return this;
}
/**
* @param s3DestinationDescription
*/
public void setS3DestinationDescription(S3DestinationDescription s3DestinationDescription) {
this.s3DestinationDescription = s3DestinationDescription;
}
/**
* @return
*/
public S3DestinationDescription getS3DestinationDescription() {
return this.s3DestinationDescription;
}
/**
* @param s3DestinationDescription
* @return Returns a reference to this object so that method calls can be chained together.
*/
public HttpEndpointDestinationDescription withS3DestinationDescription(S3DestinationDescription s3DestinationDescription) {
setS3DestinationDescription(s3DestinationDescription);
return this;
}
/**
*
* The configuration that defines how you access secrets for HTTP Endpoint destination.
*
*
* @param secretsManagerConfiguration
* The configuration that defines how you access secrets for HTTP Endpoint destination.
*/
public void setSecretsManagerConfiguration(SecretsManagerConfiguration secretsManagerConfiguration) {
this.secretsManagerConfiguration = secretsManagerConfiguration;
}
/**
*
* The configuration that defines how you access secrets for HTTP Endpoint destination.
*
*
* @return The configuration that defines how you access secrets for HTTP Endpoint destination.
*/
public SecretsManagerConfiguration getSecretsManagerConfiguration() {
return this.secretsManagerConfiguration;
}
/**
*
* The configuration that defines how you access secrets for HTTP Endpoint destination.
*
*
* @param secretsManagerConfiguration
* The configuration that defines how you access secrets for HTTP Endpoint destination.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public HttpEndpointDestinationDescription 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 (getEndpointConfiguration() != null)
sb.append("EndpointConfiguration: ").append(getEndpointConfiguration()).append(",");
if (getBufferingHints() != null)
sb.append("BufferingHints: ").append(getBufferingHints()).append(",");
if (getCloudWatchLoggingOptions() != null)
sb.append("CloudWatchLoggingOptions: ").append(getCloudWatchLoggingOptions()).append(",");
if (getRequestConfiguration() != null)
sb.append("RequestConfiguration: ").append(getRequestConfiguration()).append(",");
if (getProcessingConfiguration() != null)
sb.append("ProcessingConfiguration: ").append(getProcessingConfiguration()).append(",");
if (getRoleARN() != null)
sb.append("RoleARN: ").append(getRoleARN()).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 (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 HttpEndpointDestinationDescription == false)
return false;
HttpEndpointDestinationDescription other = (HttpEndpointDestinationDescription) obj;
if (other.getEndpointConfiguration() == null ^ this.getEndpointConfiguration() == null)
return false;
if (other.getEndpointConfiguration() != null && other.getEndpointConfiguration().equals(this.getEndpointConfiguration()) == 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.getCloudWatchLoggingOptions() == null ^ this.getCloudWatchLoggingOptions() == null)
return false;
if (other.getCloudWatchLoggingOptions() != null && other.getCloudWatchLoggingOptions().equals(this.getCloudWatchLoggingOptions()) == false)
return false;
if (other.getRequestConfiguration() == null ^ this.getRequestConfiguration() == null)
return false;
if (other.getRequestConfiguration() != null && other.getRequestConfiguration().equals(this.getRequestConfiguration()) == 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.getRoleARN() == null ^ this.getRoleARN() == null)
return false;
if (other.getRoleARN() != null && other.getRoleARN().equals(this.getRoleARN()) == 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.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 + ((getEndpointConfiguration() == null) ? 0 : getEndpointConfiguration().hashCode());
hashCode = prime * hashCode + ((getBufferingHints() == null) ? 0 : getBufferingHints().hashCode());
hashCode = prime * hashCode + ((getCloudWatchLoggingOptions() == null) ? 0 : getCloudWatchLoggingOptions().hashCode());
hashCode = prime * hashCode + ((getRequestConfiguration() == null) ? 0 : getRequestConfiguration().hashCode());
hashCode = prime * hashCode + ((getProcessingConfiguration() == null) ? 0 : getProcessingConfiguration().hashCode());
hashCode = prime * hashCode + ((getRoleARN() == null) ? 0 : getRoleARN().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 + ((getSecretsManagerConfiguration() == null) ? 0 : getSecretsManagerConfiguration().hashCode());
return hashCode;
}
@Override
public HttpEndpointDestinationDescription clone() {
try {
return (HttpEndpointDestinationDescription) 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.HttpEndpointDestinationDescriptionMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}