Class DeliveryStreamDescription
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DeliveryStreamDescription.Builder,
DeliveryStreamDescription>
Contains information about a delivery stream.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Instant
The date and time that the delivery stream was created.final String
The Amazon Resource Name (ARN) of the delivery stream.Indicates the server-side encryption (SSE) status for the delivery stream.final String
The name of the delivery stream.final DeliveryStreamStatus
The status of the delivery stream.final String
The status of the delivery stream.final DeliveryStreamType
The delivery stream type.final String
The delivery stream type.final List
<DestinationDescription> The destinations.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final FailureDescription
Provides details in case one of the following operations fails due to an error related to KMS: CreateDeliveryStream, DeleteDeliveryStream, StartDeliveryStreamEncryption, StopDeliveryStreamEncryption.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Destinations property.final int
hashCode()
final Boolean
Indicates whether there are more destinations available to list.final Instant
The date and time that the delivery stream was last updated.static Class
<? extends DeliveryStreamDescription.Builder> final SourceDescription
source()
If theDeliveryStreamType
parameter isKinesisStreamAsSource
, a SourceDescription object describing the source Kinesis data stream.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final String
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.ToCopyableBuilder
copy
-
Method Details
-
deliveryStreamName
The name of the delivery stream.
- Returns:
- The name of the delivery stream.
-
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
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 invokeCreateDeliveryStream
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 returnDeliveryStreamStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdeliveryStreamStatusAsString()
.- 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 invokeCreateDeliveryStream
again on it. However, you can invoke the DeleteDeliveryStream operation to delete it. - See Also:
-
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 invokeCreateDeliveryStream
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 returnDeliveryStreamStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdeliveryStreamStatusAsString()
.- 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 invokeCreateDeliveryStream
again on it. However, you can invoke the DeleteDeliveryStream operation to delete it. - See Also:
-
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
Indicates the server-side encryption (SSE) status for the delivery stream.
- Returns:
- Indicates the server-side encryption (SSE) status for the delivery stream.
-
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 returnDeliveryStreamType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdeliveryStreamTypeAsString()
.- 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:
-
-
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 returnDeliveryStreamType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromdeliveryStreamTypeAsString()
.- 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:
-
-
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
The date and time that the delivery stream was created.
- Returns:
- The date and time that the delivery stream was created.
-
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
If the
DeliveryStreamType
parameter isKinesisStreamAsSource
, a SourceDescription object describing the source Kinesis data stream.- Returns:
- If the
DeliveryStreamType
parameter isKinesisStreamAsSource
, 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 theisEmpty()
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
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
Indicates whether there are more destinations available to list.
- Returns:
- Indicates whether there are more destinations available to list.
-
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 interfaceToCopyableBuilder<DeliveryStreamDescription.Builder,
DeliveryStreamDescription> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-