software.amazon.awssdk.services.firehose.model

Class DeliveryStreamDescription

java.lang.Object

software.amazon.awssdk.services.firehose.model.DeliveryStreamDescription

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<DeliveryStreamDescription.Builder,DeliveryStreamDescription>

@Generated(value="software.amazon.awssdk:codegen")
public class DeliveryStreamDescription
extends Object
implements StructuredPojo, ToCopyableBuilder<DeliveryStreamDescription.Builder,DeliveryStreamDescription>

Contains information about a delivery stream.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DeliveryStreamDescription.Builder

Method Summary

Modifier and Type	Method and Description
static DeliveryStreamDescription.Builder	builder()
Instant	createTimestamp() The date and time that the delivery stream was created.
String	deliveryStreamARN() The Amazon Resource Name (ARN) of the delivery stream.
String	deliveryStreamName() The name of the delivery stream.
DeliveryStreamStatus	deliveryStreamStatus() The status of the delivery stream.
String	deliveryStreamStatusAsString() The status of the delivery stream.
DeliveryStreamType	deliveryStreamType() The delivery stream type.
String	deliveryStreamTypeAsString() The delivery stream type.
List<DestinationDescription>	destinations() The destinations.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	hasMoreDestinations() Indicates whether there are more destinations available to list.
Instant	lastUpdateTimestamp() The date and time that the delivery stream was last updated.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
static Class<? extends DeliveryStreamDescription.Builder>	serializableBuilderClass()
SourceDescription	source() If the DeliveryStreamType parameter is KinesisStreamAsSource, a SourceDescription object describing the source Kinesis stream.
DeliveryStreamDescription.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
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 class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

deliveryStreamName

public String deliveryStreamName()

The name of the delivery stream.

Returns:

The name of the delivery stream.

deliveryStreamARN

public String deliveryStreamARN()

The Amazon Resource Name (ARN) of the delivery stream.

Returns:

The Amazon Resource Name (ARN) of the delivery stream.

deliveryStreamStatus

public DeliveryStreamStatus deliveryStreamStatus()

The status of the delivery stream.

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

Returns:

The status of the delivery stream.

See Also:

DeliveryStreamStatus

deliveryStreamStatusAsString

public String deliveryStreamStatusAsString()

The status of the delivery stream.

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

Returns:

The status of the delivery stream.

See Also:

DeliveryStreamStatus

deliveryStreamType

public 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 stream as a source.

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

Returns:

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 stream as a source.

See Also:

DeliveryStreamType

deliveryStreamTypeAsString

public String deliveryStreamTypeAsString()

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 stream as a source.

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

Returns:

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 stream as a source.

See Also:

DeliveryStreamType

versionId

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

Returns:

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.

createTimestamp

public Instant createTimestamp()

The date and time that the delivery stream was created.

Returns:

The date and time that the delivery stream was created.

lastUpdateTimestamp

public Instant lastUpdateTimestamp()

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

Returns:

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

source

public SourceDescription source()

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

Returns:

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

destinations

public List<DestinationDescription> destinations()

The destinations.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

The destinations.

hasMoreDestinations

public Boolean hasMoreDestinations()

Indicates whether there are more destinations available to list.

Returns:

Indicates whether there are more destinations available to list.

toBuilder

public DeliveryStreamDescription.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<DeliveryStreamDescription.Builder,DeliveryStreamDescription>

Returns:

a builder for type T

builder

public static DeliveryStreamDescription.Builder builder()

serializableBuilderClass

public static Class<? extends DeliveryStreamDescription.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.