Package software.amazon.awssdk.services.kinesisanalytics.model

Class InputDescription

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

Describes the application input configuration. For more information, see Configuring Application Input.

See Also:

  • Method Details

    • inputId

      public final String inputId()

      Input ID associated with the application input. This is the ID that Amazon Kinesis Analytics assigns to each input configuration you add to your application.

      Returns:
      Input ID associated with the application input. This is the ID that Amazon Kinesis Analytics assigns to each input configuration you add to your application.

    • namePrefix

      public final String namePrefix()

      In-application name prefix.

      Returns:
      In-application name prefix.

    • hasInAppStreamNames

      public final boolean hasInAppStreamNames()
      For responses, this returns true if the service returned a value for the InAppStreamNames 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.

    • inAppStreamNames

      public final List<String> inAppStreamNames()

      Returns the in-application stream names that are mapped to the stream source.

      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 hasInAppStreamNames() method.

      Returns:
      Returns the in-application stream names that are mapped to the stream source.

    • inputProcessingConfigurationDescription

      public final InputProcessingConfigurationDescription inputProcessingConfigurationDescription()

      The description of the preprocessor that executes on records in this input before the application's code is run.

      Returns:
      The description of the preprocessor that executes on records in this input before the application's code is run.

    • kinesisStreamsInputDescription

      public final KinesisStreamsInputDescription kinesisStreamsInputDescription()

      If an Amazon Kinesis stream is configured as streaming source, provides Amazon Kinesis stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.

      Returns:
      If an Amazon Kinesis stream is configured as streaming source, provides Amazon Kinesis stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.

    • kinesisFirehoseInputDescription

      public final KinesisFirehoseInputDescription kinesisFirehoseInputDescription()

      If an Amazon Kinesis Firehose delivery stream is configured as a streaming source, provides the delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.

      Returns:
      If an Amazon Kinesis Firehose delivery stream is configured as a streaming source, provides the delivery stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.

    • inputSchema

      public final SourceSchema inputSchema()

      Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.

      Returns:
      Describes the format of the data in the streaming source, and how each data element maps to corresponding columns in the in-application stream that is being created.

    • inputParallelism

      public final InputParallelism inputParallelism()

      Describes the configured parallelism (number of in-application streams mapped to the streaming source).

      Returns:
      Describes the configured parallelism (number of in-application streams mapped to the streaming source).

    • inputStartingPositionConfiguration

      public final InputStartingPositionConfiguration inputStartingPositionConfiguration()

      Point at which the application is configured to read from the input stream.

      Returns:
      Point at which the application is configured to read from the input stream.

    • toBuilder

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

    • builder

      public static InputDescription.Builder builder()

    • serializableBuilderClass

      public static Class<? extends InputDescription.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.