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

Interface DeliveryStreamDescription.Builder

All Superinterfaces:

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

Enclosing class:

DeliveryStreamDescription

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

Method Summary

Modifier and Type	Method	Description
DeliveryStreamDescription.Builder	createTimestamp(Instant createTimestamp)	The date and time that the delivery stream was created.
DeliveryStreamDescription.Builder	deliveryStreamARN(String deliveryStreamARN)	The Amazon Resource Name (ARN) of the delivery stream.
default DeliveryStreamDescription.Builder	deliveryStreamEncryptionConfiguration(Consumer<DeliveryStreamEncryptionConfiguration.Builder> deliveryStreamEncryptionConfiguration)	Indicates the server-side encryption (SSE) status for the delivery stream.
DeliveryStreamDescription.Builder	deliveryStreamEncryptionConfiguration(DeliveryStreamEncryptionConfiguration deliveryStreamEncryptionConfiguration)	Indicates the server-side encryption (SSE) status for the delivery stream.
DeliveryStreamDescription.Builder	deliveryStreamName(String deliveryStreamName)	The name of the delivery stream.
DeliveryStreamDescription.Builder	deliveryStreamStatus(String deliveryStreamStatus)	The status of the delivery stream.
DeliveryStreamDescription.Builder	deliveryStreamStatus(DeliveryStreamStatus deliveryStreamStatus)	The status of the delivery stream.
DeliveryStreamDescription.Builder	deliveryStreamType(String deliveryStreamType)	The delivery stream type.
DeliveryStreamDescription.Builder	deliveryStreamType(DeliveryStreamType deliveryStreamType)	The delivery stream type.
DeliveryStreamDescription.Builder	destinations(Collection<DestinationDescription> destinations)	The destinations.
DeliveryStreamDescription.Builder	destinations(Consumer<DestinationDescription.Builder>... destinations)	The destinations.
DeliveryStreamDescription.Builder	destinations(DestinationDescription... destinations)	The destinations.
default DeliveryStreamDescription.Builder	failureDescription(Consumer<FailureDescription.Builder> failureDescription)	Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.
DeliveryStreamDescription.Builder	failureDescription(FailureDescription failureDescription)	Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.
DeliveryStreamDescription.Builder	hasMoreDestinations(Boolean hasMoreDestinations)	Indicates whether there are more destinations available to list.
DeliveryStreamDescription.Builder	lastUpdateTimestamp(Instant lastUpdateTimestamp)	The date and time that the delivery stream was last updated.
default DeliveryStreamDescription.Builder	source(Consumer<SourceDescription.Builder> source)	If the DeliveryStreamType parameter is KinesisStreamAsSource, a SourceDescription object describing the source Kinesis data stream.
DeliveryStreamDescription.Builder	source(SourceDescription source)	If the DeliveryStreamType parameter is KinesisStreamAsSource, a SourceDescription object describing the source Kinesis data stream.
DeliveryStreamDescription.Builder	versionId(String versionId)	Each time the destination is updated for a delivery stream, the version ID is changed, and the current version ID is required when updating the 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 Details

deliveryStreamName

DeliveryStreamDescription.Builder deliveryStreamName(String deliveryStreamName)

The name of the delivery stream.

Parameters:

deliveryStreamName - The name of the delivery stream.

Returns:

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

deliveryStreamARN

DeliveryStreamDescription.Builder deliveryStreamARN(String deliveryStreamARN)

The Amazon Resource Name (ARN) of the delivery stream. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

Parameters:

deliveryStreamARN - The Amazon Resource Name (ARN) of the delivery stream. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.

Returns:

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

deliveryStreamStatus

DeliveryStreamDescription.Builder deliveryStreamStatus(String deliveryStreamStatus)

The status of the delivery stream. If the status of a delivery stream is CREATING_FAILED, this status doesn't change, and you can't invoke CreateDeliveryStream again on it. However, you can invoke the DeleteDeliveryStream operation to delete it.

Parameters:

deliveryStreamStatus - The status of the delivery stream. If the status of a delivery stream is CREATING_FAILED, this status doesn't change, and you can't invoke CreateDeliveryStream again on it. However, you can invoke the DeleteDeliveryStream operation to delete it.

Returns:

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

See Also:

• DeliveryStreamStatus
• DeliveryStreamStatus

deliveryStreamStatus

DeliveryStreamDescription.Builder deliveryStreamStatus(DeliveryStreamStatus deliveryStreamStatus)

The status of the delivery stream. If the status of a delivery stream is CREATING_FAILED, this status doesn't change, and you can't invoke CreateDeliveryStream again on it. However, you can invoke the DeleteDeliveryStream operation to delete it.

Parameters:

deliveryStreamStatus - The status of the delivery stream. If the status of a delivery stream is CREATING_FAILED, this status doesn't change, and you can't invoke CreateDeliveryStream again on it. However, you can invoke the DeleteDeliveryStream operation to delete it.

Returns:

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

See Also:

• DeliveryStreamStatus
• DeliveryStreamStatus

failureDescription

DeliveryStreamDescription.Builder failureDescription(FailureDescription failureDescription)

Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.

Parameters:

failureDescription - Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.

Returns:

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

failureDescription

default DeliveryStreamDescription.Builder failureDescription(Consumer<FailureDescription.Builder> failureDescription)

Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.

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

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

Parameters:

failureDescription - a consumer that will call methods on FailureDescription.Builder

Returns:

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

See Also:

• failureDescription(FailureDescription)

deliveryStreamEncryptionConfiguration

DeliveryStreamDescription.Builder deliveryStreamEncryptionConfiguration(DeliveryStreamEncryptionConfiguration deliveryStreamEncryptionConfiguration)

Indicates the server-side encryption (SSE) status for the delivery stream.

Parameters:

deliveryStreamEncryptionConfiguration - Indicates the server-side encryption (SSE) status for the delivery stream.

Returns:

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

deliveryStreamEncryptionConfiguration

default DeliveryStreamDescription.Builder deliveryStreamEncryptionConfiguration(Consumer<DeliveryStreamEncryptionConfiguration.Builder> deliveryStreamEncryptionConfiguration)

Indicates the server-side encryption (SSE) status for the delivery stream.

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

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

Parameters:

deliveryStreamEncryptionConfiguration - a consumer that will call methods on DeliveryStreamEncryptionConfiguration.Builder

Returns:

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

See Also:

• deliveryStreamEncryptionConfiguration(DeliveryStreamEncryptionConfiguration)

deliveryStreamType

DeliveryStreamDescription.Builder deliveryStreamType(String deliveryStreamType)

The delivery stream type. This can be one of the following values:

• DirectPut: Provider applications access the delivery stream directly.

• KinesisStreamAsSource: The delivery stream uses a Kinesis data stream as a source.

Parameters:

deliveryStreamType - The delivery stream type. This can be one of the following values:

• DirectPut: Provider applications access the delivery stream directly.

• KinesisStreamAsSource: The delivery stream uses a Kinesis data stream as a source.

Returns:

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

See Also:

• DeliveryStreamType
• DeliveryStreamType

deliveryStreamType

DeliveryStreamDescription.Builder deliveryStreamType(DeliveryStreamType deliveryStreamType)

The delivery stream type. This can be one of the following values:

• DirectPut: Provider applications access the delivery stream directly.

• KinesisStreamAsSource: The delivery stream uses a Kinesis data stream as a source.

Parameters:

deliveryStreamType - The delivery stream type. This can be one of the following values:

• DirectPut: Provider applications access the delivery stream directly.

• KinesisStreamAsSource: The delivery stream uses a Kinesis data stream as a source.

Returns:

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

See Also:

• DeliveryStreamType
• DeliveryStreamType

versionId

DeliveryStreamDescription.Builder versionId(String versionId)

Each time the destination is updated for a delivery stream, the version ID is changed, and the current version ID is required when updating the destination. This is so that the service knows it is applying the changes to the correct version of the delivery stream.

Parameters:

versionId - Each time the destination is updated for a delivery stream, the version ID is changed, and the current version ID is required when updating the destination. This is so that the service knows it is applying the changes to the correct version of the delivery stream.

Returns:

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

createTimestamp

DeliveryStreamDescription.Builder createTimestamp(Instant createTimestamp)

The date and time that the delivery stream was created.

Parameters:

createTimestamp - The date and time that the delivery stream was created.

Returns:

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

lastUpdateTimestamp

DeliveryStreamDescription.Builder lastUpdateTimestamp(Instant lastUpdateTimestamp)

The date and time that the delivery stream was last updated.

Parameters:

lastUpdateTimestamp - The date and time that the delivery stream was last updated.

Returns:

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

source

DeliveryStreamDescription.Builder source(SourceDescription source)

If the DeliveryStreamType parameter is KinesisStreamAsSource, a SourceDescription object describing the source Kinesis data stream.

Parameters:

source - If the DeliveryStreamType parameter is KinesisStreamAsSource, a SourceDescription object describing the source Kinesis data stream.

Returns:

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

source

default DeliveryStreamDescription.Builder source(Consumer<SourceDescription.Builder> source)

If the DeliveryStreamType parameter is KinesisStreamAsSource, a SourceDescription object describing the source Kinesis data stream.

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

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

Parameters:

source - a consumer that will call methods on SourceDescription.Builder

Returns:

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

See Also:

• source(SourceDescription)

destinations

DeliveryStreamDescription.Builder destinations(Collection<DestinationDescription> destinations)

The destinations.

Parameters:

destinations - The destinations.

Returns:

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

destinations

DeliveryStreamDescription.Builder destinations(DestinationDescription... destinations)

The destinations.

Parameters:

destinations - The destinations.

Returns:

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

destinations

DeliveryStreamDescription.Builder destinations(Consumer<DestinationDescription.Builder>... destinations)

The destinations.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to destinations(List<DestinationDescription>).

Parameters:

destinations - a consumer that will call methods on DestinationDescription.Builder

Returns:

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

See Also:

• destinations(java.util.Collection<DestinationDescription>)

hasMoreDestinations

DeliveryStreamDescription.Builder hasMoreDestinations(Boolean hasMoreDestinations)

Indicates whether there are more destinations available to list.

Parameters:

hasMoreDestinations - Indicates whether there are more destinations available to list.

Returns:

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