Class OutputDescription

java.lang.Object
software.amazon.awssdk.services.kinesisanalyticsv2.model.OutputDescription
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<OutputDescription.Builder,OutputDescription>
@Generated("software.amazon.awssdk:codegen") public final class OutputDescription extends Object implements SdkPojo, Serializable, ToCopyableBuilder<OutputDescription.Builder,OutputDescription>

For a SQL-based Kinesis Data Analytics application, describes the application output configuration, which includes the in-application stream name and the destination where the stream data is written. The destination can be a Kinesis data stream or a Kinesis Data Firehose delivery stream.

See Also:

  • Method Details

    • outputId

      public final String outputId()

      A unique identifier for the output configuration.

      Returns:
      A unique identifier for the output configuration.

    • name

      public final String name()

      The name of the in-application stream that is configured as output.

      Returns:
      The name of the in-application stream that is configured as output.

    • kinesisStreamsOutputDescription

      public final KinesisStreamsOutputDescription kinesisStreamsOutputDescription()

      Describes the Kinesis data stream that is configured as the destination where output is written.

      Returns:
      Describes the Kinesis data stream that is configured as the destination where output is written.

    • kinesisFirehoseOutputDescription

      public final KinesisFirehoseOutputDescription kinesisFirehoseOutputDescription()

      Describes the Kinesis Data Firehose delivery stream that is configured as the destination where output is written.

      Returns:
      Describes the Kinesis Data Firehose delivery stream that is configured as the destination where output is written.

    • lambdaOutputDescription

      public final LambdaOutputDescription lambdaOutputDescription()

      Describes the Lambda function that is configured as the destination where output is written.

      Returns:
      Describes the Lambda function that is configured as the destination where output is written.

    • destinationSchema

      public final DestinationSchema destinationSchema()

      The data format used for writing data to the destination.

      Returns:
      The data format used for writing data to the destination.

    • toBuilder

      public OutputDescription.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<OutputDescription.Builder,OutputDescription>
      Returns:
      a builder for type T

    • builder

      public static OutputDescription.Builder builder()

    • serializableBuilderClass

      public static Class<? extends OutputDescription.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.