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

Interface HttpEndpointDestinationDescription.Builder

All Superinterfaces:

Buildable, CopyableBuilder<HttpEndpointDestinationDescription.Builder,HttpEndpointDestinationDescription>, SdkBuilder<HttpEndpointDestinationDescription.Builder,HttpEndpointDestinationDescription>, SdkPojo

Enclosing class:

HttpEndpointDestinationDescription

public static interface HttpEndpointDestinationDescription.Builder
extends SdkPojo, CopyableBuilder<HttpEndpointDestinationDescription.Builder,HttpEndpointDestinationDescription>

Method Summary

Modifier and Type	Method	Description
default HttpEndpointDestinationDescription.Builder	bufferingHints(Consumer<HttpEndpointBufferingHints.Builder> bufferingHints)	Describes buffering options that can be applied to the data before it is delivered to the HTTPS endpoint destination.
HttpEndpointDestinationDescription.Builder	bufferingHints(HttpEndpointBufferingHints bufferingHints)	Describes buffering options that can be applied to the data before it is delivered to the HTTPS endpoint destination.
default HttpEndpointDestinationDescription.Builder	cloudWatchLoggingOptions(Consumer<CloudWatchLoggingOptions.Builder> cloudWatchLoggingOptions)	Sets the value of the CloudWatchLoggingOptions property for this object.
HttpEndpointDestinationDescription.Builder	cloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)	Sets the value of the CloudWatchLoggingOptions property for this object.
default HttpEndpointDestinationDescription.Builder	endpointConfiguration(Consumer<HttpEndpointDescription.Builder> endpointConfiguration)	The configuration of the specified HTTP endpoint destination.
HttpEndpointDestinationDescription.Builder	endpointConfiguration(HttpEndpointDescription endpointConfiguration)	The configuration of the specified HTTP endpoint destination.
default HttpEndpointDestinationDescription.Builder	processingConfiguration(Consumer<ProcessingConfiguration.Builder> processingConfiguration)	Sets the value of the ProcessingConfiguration property for this object.
HttpEndpointDestinationDescription.Builder	processingConfiguration(ProcessingConfiguration processingConfiguration)	Sets the value of the ProcessingConfiguration property for this object.
default HttpEndpointDestinationDescription.Builder	requestConfiguration(Consumer<HttpEndpointRequestConfiguration.Builder> requestConfiguration)	The configuration of request sent to the HTTP endpoint specified as the destination.
HttpEndpointDestinationDescription.Builder	requestConfiguration(HttpEndpointRequestConfiguration requestConfiguration)	The configuration of request sent to the HTTP endpoint specified as the destination.
default HttpEndpointDestinationDescription.Builder	retryOptions(Consumer<HttpEndpointRetryOptions.Builder> 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.
HttpEndpointDestinationDescription.Builder	retryOptions(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.
HttpEndpointDestinationDescription.Builder	roleARN(String roleARN)	Firehose uses this IAM role for all the permissions that the delivery stream needs.
HttpEndpointDestinationDescription.Builder	s3BackupMode(String s3BackupMode)	Describes the S3 bucket backup options for the data that Kinesis Firehose delivers to the HTTP endpoint destination.
HttpEndpointDestinationDescription.Builder	s3BackupMode(HttpEndpointS3BackupMode s3BackupMode)	Describes the S3 bucket backup options for the data that Kinesis Firehose delivers to the HTTP endpoint destination.
default HttpEndpointDestinationDescription.Builder	s3DestinationDescription(Consumer<S3DestinationDescription.Builder> s3DestinationDescription)	Sets the value of the S3DestinationDescription property for this object.
HttpEndpointDestinationDescription.Builder	s3DestinationDescription(S3DestinationDescription s3DestinationDescription)	Sets the value of the S3DestinationDescription property for this object.
default HttpEndpointDestinationDescription.Builder	secretsManagerConfiguration(Consumer<SecretsManagerConfiguration.Builder> secretsManagerConfiguration)	The configuration that defines how you access secrets for HTTP Endpoint destination.
HttpEndpointDestinationDescription.Builder	secretsManagerConfiguration(SecretsManagerConfiguration secretsManagerConfiguration)	The configuration that defines how you access secrets for HTTP Endpoint destination.

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

copy

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Detail

endpointConfiguration

HttpEndpointDestinationDescription.Builder endpointConfiguration(HttpEndpointDescription endpointConfiguration)

The configuration of the specified HTTP endpoint destination.

Parameters:

endpointConfiguration - The configuration of the specified HTTP endpoint destination.

Returns:

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

endpointConfiguration

default HttpEndpointDestinationDescription.Builder endpointConfiguration(Consumer<HttpEndpointDescription.Builder> endpointConfiguration)

The configuration of the specified HTTP endpoint destination.

This is a convenience method that creates an instance of the HttpEndpointDescription.Builder avoiding the need to create one manually via HttpEndpointDescription.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to endpointConfiguration(HttpEndpointDescription).

Parameters:

endpointConfiguration - a consumer that will call methods on HttpEndpointDescription.Builder

Returns:

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

See Also:

endpointConfiguration(HttpEndpointDescription)

bufferingHints

HttpEndpointDestinationDescription.Builder bufferingHints(HttpEndpointBufferingHints 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.

Parameters:

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.

Returns:

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

bufferingHints

default HttpEndpointDestinationDescription.Builder bufferingHints(Consumer<HttpEndpointBufferingHints.Builder> 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.

This is a convenience method that creates an instance of the HttpEndpointBufferingHints.Builder avoiding the need to create one manually via HttpEndpointBufferingHints.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to bufferingHints(HttpEndpointBufferingHints).

Parameters:

bufferingHints - a consumer that will call methods on HttpEndpointBufferingHints.Builder

Returns:

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

See Also:

bufferingHints(HttpEndpointBufferingHints)

cloudWatchLoggingOptions

HttpEndpointDestinationDescription.Builder cloudWatchLoggingOptions(CloudWatchLoggingOptions cloudWatchLoggingOptions)

Sets the value of the CloudWatchLoggingOptions property for this object.

Parameters:

cloudWatchLoggingOptions - The new value for the CloudWatchLoggingOptions property for this object.

Returns:

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

cloudWatchLoggingOptions

default HttpEndpointDestinationDescription.Builder cloudWatchLoggingOptions(Consumer<CloudWatchLoggingOptions.Builder> cloudWatchLoggingOptions)

Sets the value of the CloudWatchLoggingOptions property for this object. This is a convenience method that creates an instance of the CloudWatchLoggingOptions.Builder avoiding the need to create one manually via CloudWatchLoggingOptions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to cloudWatchLoggingOptions(CloudWatchLoggingOptions).

Parameters:

cloudWatchLoggingOptions - a consumer that will call methods on CloudWatchLoggingOptions.Builder

Returns:

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

See Also:

cloudWatchLoggingOptions(CloudWatchLoggingOptions)

requestConfiguration

HttpEndpointDestinationDescription.Builder requestConfiguration(HttpEndpointRequestConfiguration requestConfiguration)

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

Parameters:

requestConfiguration - The configuration of request sent to the HTTP endpoint specified as the destination.

Returns:

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

requestConfiguration

default HttpEndpointDestinationDescription.Builder requestConfiguration(Consumer<HttpEndpointRequestConfiguration.Builder> requestConfiguration)

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

This is a convenience method that creates an instance of the HttpEndpointRequestConfiguration.Builder avoiding the need to create one manually via HttpEndpointRequestConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to requestConfiguration(HttpEndpointRequestConfiguration).

Parameters:

requestConfiguration - a consumer that will call methods on HttpEndpointRequestConfiguration.Builder

Returns:

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

See Also:

requestConfiguration(HttpEndpointRequestConfiguration)

processingConfiguration

HttpEndpointDestinationDescription.Builder processingConfiguration(ProcessingConfiguration processingConfiguration)

Sets the value of the ProcessingConfiguration property for this object.

Parameters:

processingConfiguration - The new value for the ProcessingConfiguration property for this object.

Returns:

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

processingConfiguration

default HttpEndpointDestinationDescription.Builder processingConfiguration(Consumer<ProcessingConfiguration.Builder> processingConfiguration)

Sets the value of the ProcessingConfiguration property for this object. This is a convenience method that creates an instance of the ProcessingConfiguration.Builder avoiding the need to create one manually via ProcessingConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to processingConfiguration(ProcessingConfiguration).

Parameters:

processingConfiguration - a consumer that will call methods on ProcessingConfiguration.Builder

Returns:

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

See Also:

processingConfiguration(ProcessingConfiguration)

roleARN

HttpEndpointDestinationDescription.Builder roleARN(String roleARN)

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

Parameters:

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

Returns:

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

retryOptions

HttpEndpointDestinationDescription.Builder retryOptions(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.

Parameters:

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:

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

retryOptions

default HttpEndpointDestinationDescription.Builder retryOptions(Consumer<HttpEndpointRetryOptions.Builder> 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.

This is a convenience method that creates an instance of the HttpEndpointRetryOptions.Builder avoiding the need to create one manually via HttpEndpointRetryOptions.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to retryOptions(HttpEndpointRetryOptions).

Parameters:

retryOptions - a consumer that will call methods on HttpEndpointRetryOptions.Builder

Returns:

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

See Also:

retryOptions(HttpEndpointRetryOptions)

s3BackupMode

HttpEndpointDestinationDescription.Builder s3BackupMode(String 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).

Parameters:

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).

Returns:

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

See Also:

HttpEndpointS3BackupMode, HttpEndpointS3BackupMode

s3BackupMode

HttpEndpointDestinationDescription.Builder s3BackupMode(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 Firehose could not deliver to the specified HTTP endpoint destination (FailedDataOnly).

Parameters:

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).

Returns:

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

See Also:

HttpEndpointS3BackupMode, HttpEndpointS3BackupMode

s3DestinationDescription

HttpEndpointDestinationDescription.Builder s3DestinationDescription(S3DestinationDescription s3DestinationDescription)

Sets the value of the S3DestinationDescription property for this object.

Parameters:

s3DestinationDescription - The new value for the S3DestinationDescription property for this object.

Returns:

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

s3DestinationDescription

default HttpEndpointDestinationDescription.Builder s3DestinationDescription(Consumer<S3DestinationDescription.Builder> s3DestinationDescription)

Sets the value of the S3DestinationDescription property for this object. This is a convenience method that creates an instance of the S3DestinationDescription.Builder avoiding the need to create one manually via S3DestinationDescription.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to s3DestinationDescription(S3DestinationDescription).

Parameters:

s3DestinationDescription - a consumer that will call methods on S3DestinationDescription.Builder

Returns:

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

See Also:

s3DestinationDescription(S3DestinationDescription)

secretsManagerConfiguration

HttpEndpointDestinationDescription.Builder secretsManagerConfiguration(SecretsManagerConfiguration secretsManagerConfiguration)

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

Parameters:

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

Returns:

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

secretsManagerConfiguration

default HttpEndpointDestinationDescription.Builder secretsManagerConfiguration(Consumer<SecretsManagerConfiguration.Builder> secretsManagerConfiguration)

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

This is a convenience method that creates an instance of the SecretsManagerConfiguration.Builder avoiding the need to create one manually via SecretsManagerConfiguration.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to secretsManagerConfiguration(SecretsManagerConfiguration).

Parameters:

secretsManagerConfiguration - a consumer that will call methods on SecretsManagerConfiguration.Builder

Returns:

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

See Also:

secretsManagerConfiguration(SecretsManagerConfiguration)