DeliveryStreamDescription (AWS Java SDK :: Services :: Amazon Kinesis Firehose 2.20.110 API)

java.lang.Object
- software.amazon.awssdk.services.firehose.model.DeliveryStreamDescription

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<DeliveryStreamDescription.Builder,DeliveryStreamDescription>

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

Contains information about a delivery stream.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DeliveryStreamDescription.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DeliveryStreamDescription.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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.
`DeliveryStreamEncryptionConfiguration`	`deliveryStreamEncryptionConfiguration()` Indicates the server-side encryption (SSE) status for 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)`
`boolean`	`equalsBySdkFields(Object obj)`
`FailureDescription`	`failureDescription()` Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasDestinations()` For responses, this returns true if the service returned a value for the Destinations property.
`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.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DeliveryStreamDescription.Builder>`	`serializableBuilderClass()`
`SourceDescription`	`source()` If the `DeliveryStreamType` parameter is `KinesisStreamAsSource`, a SourceDescription object describing the source Kinesis data stream.
`DeliveryStreamDescription.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`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
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - deliveryStreamName
```
public final String deliveryStreamName()
```
    The name of the delivery stream.
    
    Returns:
    
    The name of the delivery stream.
  - deliveryStreamARN
```
public final 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.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the delivery stream. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
  - deliveryStreamStatus
```
public final 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.
    
    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. 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.
    
    See Also:
    
    DeliveryStreamStatus
  - deliveryStreamStatusAsString
```
public final String deliveryStreamStatusAsString()
```
    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.
    
    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. 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.
    
    See Also:
    
    DeliveryStreamStatus
  - failureDescription
```
public final FailureDescription failureDescription()
```
    Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.
    
    Returns:
    
    Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.
  - deliveryStreamEncryptionConfiguration
```
public final DeliveryStreamEncryptionConfiguration deliveryStreamEncryptionConfiguration()
```
    Indicates the server-side encryption (SSE) status for the delivery stream.
    
    Returns:
    
    Indicates the server-side encryption (SSE) status for the delivery stream.
  - deliveryStreamType
```
public final 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.
    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 data stream as a source.
    See Also:
    
    DeliveryStreamType
  - deliveryStreamTypeAsString
```
public final 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 data 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 data stream as a source.
    See Also:
    
    DeliveryStreamType
  - versionId
```
public final 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 final 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 final 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 final SourceDescription source()
```
    If the DeliveryStreamType parameter is KinesisStreamAsSource, a SourceDescription object describing the source Kinesis data stream.
    
    Returns:
    
    If the DeliveryStreamType parameter is KinesisStreamAsSource, a SourceDescription object describing the source Kinesis data stream.
  - hasDestinations
```
public final boolean hasDestinations()
```
    For responses, this returns true if the service returned a value for the Destinations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - destinations
```
public final List<DestinationDescription> destinations()
```
    The destinations.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDestinations() method.
    
    Returns:
    
    The destinations.
  - hasMoreDestinations
```
public final 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DeliveryStreamDescription.Builder,DeliveryStreamDescription>
  - builder
```
public static DeliveryStreamDescription.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DeliveryStreamDescription.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

Class DeliveryStreamDescription

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

deliveryStreamName

deliveryStreamARN

deliveryStreamStatus

deliveryStreamStatusAsString

failureDescription

deliveryStreamEncryptionConfiguration

deliveryStreamType

deliveryStreamTypeAsString

versionId

createTimestamp

lastUpdateTimestamp

source

hasDestinations

destinations

hasMoreDestinations

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields