software.amazon.awssdk.services.firehose.model

Class HttpEndpointDestinationDescription

java.lang.Object

software.amazon.awssdk.services.firehose.model.HttpEndpointDestinationDescription

All Implemented Interfaces:

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

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

Describes the HTTP endpoint destination.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HttpEndpointDestinationDescription.Builder

Method Summary

Modifier and Type	Method and Description
HttpEndpointBufferingHints	bufferingHints() Describes buffering options that can be applied to the data before it is delivered to the HTTPS endpoint destination.
static HttpEndpointDestinationDescription.Builder	builder()
CloudWatchLoggingOptions	cloudWatchLoggingOptions() Returns the value of the CloudWatchLoggingOptions property for this object.
HttpEndpointDescription	endpointConfiguration() The configuration of the specified HTTP endpoint 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 request sent to the HTTP endpoint specified as the destination.
HttpEndpointRetryOptions	retryOptions() Describes the retry behavior in case Kinesis Data 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() Kinesis Data 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 Kinesis Firehose delivers to the HTTP endpoint destination.
String	s3BackupModeAsString() Describes the S3 bucket backup options for the data that Kinesis Firehose delivers to the HTTP endpoint destination.
S3DestinationDescription	s3DestinationDescription() Returns the value of the S3DestinationDescription property for this object.
List<SdkField<?>>	sdkFields()
static Class<? extends HttpEndpointDestinationDescription.Builder>	serializableBuilderClass()
HttpEndpointDestinationDescription.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 HttpEndpointDescription endpointConfiguration()

The configuration of the specified HTTP endpoint destination.

Returns:

The configuration of the specified HTTP endpoint destination.

bufferingHints

public final HttpEndpointBufferingHints bufferingHints()

Describes buffering options that can be applied to the data before it is delivered to the HTTPS endpoint destination. Kinesis Data 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.

Returns:

Describes buffering options that can be applied to the data before it is delivered to the HTTPS endpoint destination. Kinesis Data 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.

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 request sent to the HTTP endpoint specified as the destination.

Returns:

The configuration of request sent to the HTTP endpoint 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()

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

Returns:

Kinesis Data 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 Kinesis Data 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 Kinesis Data 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 Kinesis Firehose delivers to the HTTP endpoint destination. You can back up all documents (AllData) or only the documents that Kinesis Data 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 Kinesis Firehose delivers to the HTTP endpoint destination. You can back up all documents (AllData) or only the documents that Kinesis Data 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 Kinesis Firehose delivers to the HTTP endpoint destination. You can back up all documents (AllData) or only the documents that Kinesis Data 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 Kinesis Firehose delivers to the HTTP endpoint destination. You can back up all documents (AllData) or only the documents that Kinesis Data Firehose could not deliver to the specified HTTP endpoint destination (FailedDataOnly).

See Also:

HttpEndpointS3BackupMode

s3DestinationDescription

public final S3DestinationDescription s3DestinationDescription()

Returns the value of the S3DestinationDescription property for this object.

Returns:

The value of the S3DestinationDescription property for this object.

toBuilder

public HttpEndpointDestinationDescription.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<HttpEndpointDestinationDescription.Builder,HttpEndpointDestinationDescription>

builder

public static HttpEndpointDestinationDescription.Builder builder()

serializableBuilderClass

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