Package software.amazon.awssdk.services.firehose.model

Class HttpEndpointDestinationConfiguration

java.lang.Object

software.amazon.awssdk.services.firehose.model.HttpEndpointDestinationConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<HttpEndpointDestinationConfiguration.Builder,HttpEndpointDestinationConfiguration>

@Generated("software.amazon.awssdk:codegen")
public final class HttpEndpointDestinationConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<HttpEndpointDestinationConfiguration.Builder,HttpEndpointDestinationConfiguration>

Describes the configuration of the HTTP endpoint destination.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	HttpEndpointDestinationConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
HttpEndpointBufferingHints	bufferingHints()	The buffering options that can be used before data is delivered to the specified destination.
static HttpEndpointDestinationConfiguration.Builder	builder()
CloudWatchLoggingOptions	cloudWatchLoggingOptions()	Returns the value of the CloudWatchLoggingOptions property for this object.
HttpEndpointConfiguration	endpointConfiguration()	The configuration of the HTTP endpoint selected as the destination.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
ProcessingConfiguration	processingConfiguration()	Returns the value of the ProcessingConfiguration property for this object.
HttpEndpointRequestConfiguration	requestConfiguration()	The configuration of the request sent to the HTTP endpoint that is specified as the destination.
HttpEndpointRetryOptions	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.
String	roleARN()	Firehose uses this IAM role for all the permissions that the delivery stream needs.
HttpEndpointS3BackupMode	s3BackupMode()	Describes the S3 bucket backup options for the data that Firehose delivers to the HTTP endpoint destination.
String	s3BackupModeAsString()	Describes the S3 bucket backup options for the data that Firehose delivers to the HTTP endpoint destination.
S3DestinationConfiguration	s3Configuration()	Returns the value of the S3Configuration property for this object.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
SecretsManagerConfiguration	secretsManagerConfiguration()	The configuration that defines how you access secrets for HTTP Endpoint destination.
static Class<? extends HttpEndpointDestinationConfiguration.Builder>	serializableBuilderClass()
HttpEndpointDestinationConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

endpointConfiguration

public final HttpEndpointConfiguration endpointConfiguration()

The configuration of the HTTP endpoint selected as the destination.

Returns:

The configuration of the HTTP endpoint selected as the destination.

bufferingHints

public final HttpEndpointBufferingHints bufferingHints()

The buffering options that can be used before data is delivered to the specified destination. Firehose treats these options as hints, and it might choose to use more optimal values. The SizeInMBs and IntervalInSeconds parameters are optional. However, if you specify a value for one of them, you must also provide a value for the other.

Returns:

The buffering options that can be used before data is delivered to the specified destination. Firehose treats these options as hints, and it might choose to use more optimal values. The SizeInMBs and IntervalInSeconds parameters are optional. However, if you specify a value for one of them, you must also provide a value for the other.

cloudWatchLoggingOptions

public final CloudWatchLoggingOptions cloudWatchLoggingOptions()

Returns the value of the CloudWatchLoggingOptions property for this object.

Returns:

The value of the CloudWatchLoggingOptions property for this object.

requestConfiguration

public final HttpEndpointRequestConfiguration requestConfiguration()

The configuration of the request sent to the HTTP endpoint that is specified as the destination.

Returns:

The configuration of the request sent to the HTTP endpoint that is specified as the destination.

processingConfiguration

public final ProcessingConfiguration processingConfiguration()

Returns the value of the ProcessingConfiguration property for this object.

Returns:

The value of the ProcessingConfiguration property for this object.

roleARN

public final String roleARN()

Firehose uses this IAM role for all the permissions that the delivery stream needs.

Returns:

Firehose uses this IAM role for all the permissions that the delivery stream needs.

retryOptions

public final HttpEndpointRetryOptions 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.

Returns:

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.

s3BackupMode

public final HttpEndpointS3BackupMode s3BackupMode()

Describes the S3 bucket backup options for the data that 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).

If the service returns an enum value that is not available in the current SDK version, s3BackupMode will return HttpEndpointS3BackupMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from s3BackupModeAsString().

Returns:

Describes the S3 bucket backup options for the data that 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 Also:

HttpEndpointS3BackupMode

s3BackupModeAsString

public final String s3BackupModeAsString()

Describes the S3 bucket backup options for the data that 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).

If the service returns an enum value that is not available in the current SDK version, s3BackupMode will return HttpEndpointS3BackupMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from s3BackupModeAsString().

Returns:

Describes the S3 bucket backup options for the data that 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 Also:

HttpEndpointS3BackupMode

s3Configuration

public final S3DestinationConfiguration s3Configuration()

Returns the value of the S3Configuration property for this object.

Returns:

The value of the S3Configuration property for this object.

secretsManagerConfiguration

public final SecretsManagerConfiguration secretsManagerConfiguration()

The configuration that defines how you access secrets for HTTP Endpoint destination.

Returns:

The configuration that defines how you access secrets for HTTP Endpoint destination.

toBuilder

public HttpEndpointDestinationConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<HttpEndpointDestinationConfiguration.Builder,HttpEndpointDestinationConfiguration>

builder

public static HttpEndpointDestinationConfiguration.Builder builder()

serializableBuilderClass

public static Class<? extends HttpEndpointDestinationConfiguration.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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo