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

Class DeliveryStreamDescription

    • Method Detail

      • deliveryStreamName

        public final String deliveryStreamName()

        The name of the Firehose stream.

        Returns:
        The name of the Firehose stream.

      • deliveryStreamStatus

        public final DeliveryStreamStatus deliveryStreamStatus()

        The status of the Firehose stream. If the status of a Firehose 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 Firehose stream. If the status of a Firehose 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 Firehose stream. If the status of a Firehose 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 Firehose stream. If the status of a Firehose 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

      • deliveryStreamEncryptionConfiguration

        public final DeliveryStreamEncryptionConfiguration deliveryStreamEncryptionConfiguration()

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

        Returns:
        Indicates the server-side encryption (SSE) status for the Firehose stream.

      • deliveryStreamType

        public final DeliveryStreamType deliveryStreamType()

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

        • DirectPut: Provider applications access the Firehose stream directly.

        • KinesisStreamAsSource: The Firehose 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 Firehose stream type. This can be one of the following values:

        • DirectPut: Provider applications access the Firehose stream directly.

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

        See Also:
        DeliveryStreamType

      • deliveryStreamTypeAsString

        public final String deliveryStreamTypeAsString()

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

        • DirectPut: Provider applications access the Firehose stream directly.

        • KinesisStreamAsSource: The Firehose 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 Firehose stream type. This can be one of the following values:

        • DirectPut: Provider applications access the Firehose stream directly.

        • KinesisStreamAsSource: The Firehose 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 Firehose 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 Firehose 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 Firehose stream was created.

        Returns:
        The date and time that the Firehose stream was created.

      • lastUpdateTimestamp

        public final Instant lastUpdateTimestamp()

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

        Returns:
        The date and time that the Firehose 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.

      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object

      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object

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