InputDescription (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.kinesisanalytics.model.InputDescription

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class InputDescription
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Describes the application input configuration. For more information, see Configuring Application Input.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

InputDescription()

Constructors
Constructor and Description
`InputDescription()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`InputDescription`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getInAppStreamNames()` Returns the in-application stream names that are mapped to the stream source.
`String`	`getInputId()` Input ID associated with the application input.
`InputParallelism`	`getInputParallelism()` Describes the configured parallelism (number of in-application streams mapped to the streaming source).
`InputProcessingConfigurationDescription`	`getInputProcessingConfigurationDescription()` The description of the preprocessor that executes on records in this input before the application's code is run.
`SourceSchema`	`getInputSchema()` 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.
`InputStartingPositionConfiguration`	`getInputStartingPositionConfiguration()` Point at which the application is configured to read from the input stream.
`KinesisFirehoseInputDescription`	`getKinesisFirehoseInputDescription()` If an Amazon Kinesis Firehose delivery stream is configured as a streaming source, provides the Firehose delivery stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.
`KinesisStreamsInputDescription`	`getKinesisStreamsInputDescription()` If an Amazon Kinesis stream is configured as streaming source, provides Amazon Kinesis stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.
`String`	`getNamePrefix()` In-application name prefix.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setInAppStreamNames(Collection<String> inAppStreamNames)` Returns the in-application stream names that are mapped to the stream source.
`void`	`setInputId(String inputId)` Input ID associated with the application input.
`void`	`setInputParallelism(InputParallelism inputParallelism)` Describes the configured parallelism (number of in-application streams mapped to the streaming source).
`void`	`setInputProcessingConfigurationDescription(InputProcessingConfigurationDescription inputProcessingConfigurationDescription)` The description of the preprocessor that executes on records in this input before the application's code is run.
`void`	`setInputSchema(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.
`void`	`setInputStartingPositionConfiguration(InputStartingPositionConfiguration inputStartingPositionConfiguration)` Point at which the application is configured to read from the input stream.
`void`	`setKinesisFirehoseInputDescription(KinesisFirehoseInputDescription kinesisFirehoseInputDescription)` If an Amazon Kinesis Firehose delivery stream is configured as a streaming source, provides the Firehose delivery stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.
`void`	`setKinesisStreamsInputDescription(KinesisStreamsInputDescription kinesisStreamsInputDescription)` If an Amazon Kinesis stream is configured as streaming source, provides Amazon Kinesis stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.
`void`	`setNamePrefix(String namePrefix)` In-application name prefix.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`InputDescription`	`withInAppStreamNames(Collection<String> inAppStreamNames)` Returns the in-application stream names that are mapped to the stream source.
`InputDescription`	`withInAppStreamNames(String... inAppStreamNames)` Returns the in-application stream names that are mapped to the stream source.
`InputDescription`	`withInputId(String inputId)` Input ID associated with the application input.
`InputDescription`	`withInputParallelism(InputParallelism inputParallelism)` Describes the configured parallelism (number of in-application streams mapped to the streaming source).
`InputDescription`	`withInputProcessingConfigurationDescription(InputProcessingConfigurationDescription inputProcessingConfigurationDescription)` The description of the preprocessor that executes on records in this input before the application's code is run.
`InputDescription`	`withInputSchema(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.
`InputDescription`	`withInputStartingPositionConfiguration(InputStartingPositionConfiguration inputStartingPositionConfiguration)` Point at which the application is configured to read from the input stream.
`InputDescription`	`withKinesisFirehoseInputDescription(KinesisFirehoseInputDescription kinesisFirehoseInputDescription)` If an Amazon Kinesis Firehose delivery stream is configured as a streaming source, provides the Firehose delivery stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.
`InputDescription`	`withKinesisStreamsInputDescription(KinesisStreamsInputDescription kinesisStreamsInputDescription)` If an Amazon Kinesis stream is configured as streaming source, provides Amazon Kinesis stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.
`InputDescription`	`withNamePrefix(String namePrefix)` In-application name prefix.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - InputDescription
```
public InputDescription()
```
- Method Detail
  - setInputId
```
public void setInputId(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.
    
    Parameters:
    
    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.
  - getInputId
```
public String getInputId()
```
    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.
  - withInputId
```
public InputDescription withInputId(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNamePrefix
```
public void setNamePrefix(String namePrefix)
```
    In-application name prefix.
    
    Parameters:
    
    namePrefix - In-application name prefix.
  - getNamePrefix
```
public String getNamePrefix()
```
    In-application name prefix.
    
    Returns:
    
    In-application name prefix.
  - withNamePrefix
```
public InputDescription withNamePrefix(String namePrefix)
```
    In-application name prefix.
    
    Parameters:
    
    namePrefix - In-application name prefix.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getInAppStreamNames
```
public List<String> getInAppStreamNames()
```
    Returns the in-application stream names that are mapped to the stream source.
    
    Returns:
    
    Returns the in-application stream names that are mapped to the stream source.
  - setInAppStreamNames
```
public void setInAppStreamNames(Collection<String> inAppStreamNames)
```
    Returns the in-application stream names that are mapped to the stream source.
    
    Parameters:
    
    inAppStreamNames - Returns the in-application stream names that are mapped to the stream source.
  - withInAppStreamNames
```
public InputDescription withInAppStreamNames(String... inAppStreamNames)
```
    Returns the in-application stream names that are mapped to the stream source.
    
    NOTE: This method appends the values to the existing list (if any). Use setInAppStreamNames(java.util.Collection) or withInAppStreamNames(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    inAppStreamNames - Returns the in-application stream names that are mapped to the stream source.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withInAppStreamNames
```
public InputDescription withInAppStreamNames(Collection<String> inAppStreamNames)
```
    Returns the in-application stream names that are mapped to the stream source.
    
    Parameters:
    
    inAppStreamNames - Returns the in-application stream names that are mapped to the stream source.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInputProcessingConfigurationDescription
```
public void setInputProcessingConfigurationDescription(InputProcessingConfigurationDescription inputProcessingConfigurationDescription)
```
    The description of the preprocessor that executes on records in this input before the application's code is run.
    
    Parameters:
    
    inputProcessingConfigurationDescription - The description of the preprocessor that executes on records in this input before the application's code is run.
  - getInputProcessingConfigurationDescription
```
public InputProcessingConfigurationDescription getInputProcessingConfigurationDescription()
```
    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.
  - withInputProcessingConfigurationDescription
```
public InputDescription withInputProcessingConfigurationDescription(InputProcessingConfigurationDescription inputProcessingConfigurationDescription)
```
    The description of the preprocessor that executes on records in this input before the application's code is run.
    
    Parameters:
    
    inputProcessingConfigurationDescription - The description of the preprocessor that executes on records in this input before the application's code is run.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKinesisStreamsInputDescription
```
public void setKinesisStreamsInputDescription(KinesisStreamsInputDescription kinesisStreamsInputDescription)
```
    If an Amazon Kinesis stream is configured as streaming source, provides Amazon Kinesis stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.
    
    Parameters:
    
    kinesisStreamsInputDescription - If an Amazon Kinesis stream is configured as streaming source, provides Amazon Kinesis stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.
  - getKinesisStreamsInputDescription
```
public KinesisStreamsInputDescription getKinesisStreamsInputDescription()
```
    If an Amazon Kinesis stream is configured as streaming source, provides Amazon Kinesis stream's 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 ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.
  - withKinesisStreamsInputDescription
```
public InputDescription withKinesisStreamsInputDescription(KinesisStreamsInputDescription kinesisStreamsInputDescription)
```
    If an Amazon Kinesis stream is configured as streaming source, provides Amazon Kinesis stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.
    
    Parameters:
    
    kinesisStreamsInputDescription - If an Amazon Kinesis stream is configured as streaming source, provides Amazon Kinesis stream's ARN and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setKinesisFirehoseInputDescription
```
public void setKinesisFirehoseInputDescription(KinesisFirehoseInputDescription kinesisFirehoseInputDescription)
```
    If an Amazon Kinesis Firehose delivery stream is configured as a streaming source, provides the Firehose delivery stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.
    
    Parameters:
    
    kinesisFirehoseInputDescription - If an Amazon Kinesis Firehose delivery stream is configured as a streaming source, provides the Firehose delivery stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.
  - getKinesisFirehoseInputDescription
```
public KinesisFirehoseInputDescription getKinesisFirehoseInputDescription()
```
    If an Amazon Kinesis Firehose delivery stream is configured as a streaming source, provides the Firehose delivery 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 Firehose delivery stream is configured as a streaming source, provides the Firehose delivery stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.
  - withKinesisFirehoseInputDescription
```
public InputDescription withKinesisFirehoseInputDescription(KinesisFirehoseInputDescription kinesisFirehoseInputDescription)
```
    If an Amazon Kinesis Firehose delivery stream is configured as a streaming source, provides the Firehose delivery stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.
    
    Parameters:
    
    kinesisFirehoseInputDescription - If an Amazon Kinesis Firehose delivery stream is configured as a streaming source, provides the Firehose delivery stream's Amazon Resource Name (ARN) and an IAM role that enables Amazon Kinesis Analytics to access the stream on your behalf.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInputSchema
```
public void setInputSchema(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.
    
    Parameters:
    
    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.
  - getInputSchema
```
public SourceSchema getInputSchema()
```
    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.
  - withInputSchema
```
public InputDescription withInputSchema(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInputParallelism
```
public void setInputParallelism(InputParallelism inputParallelism)
```
    Describes the configured parallelism (number of in-application streams mapped to the streaming source).
    
    Parameters:
    
    inputParallelism - Describes the configured parallelism (number of in-application streams mapped to the streaming source).
  - getInputParallelism
```
public InputParallelism getInputParallelism()
```
    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).
  - withInputParallelism
```
public InputDescription withInputParallelism(InputParallelism inputParallelism)
```
    Describes the configured parallelism (number of in-application streams mapped to the streaming source).
    
    Parameters:
    
    inputParallelism - Describes the configured parallelism (number of in-application streams mapped to the streaming source).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInputStartingPositionConfiguration
```
public void setInputStartingPositionConfiguration(InputStartingPositionConfiguration inputStartingPositionConfiguration)
```
    Point at which the application is configured to read from the input stream.
    
    Parameters:
    
    inputStartingPositionConfiguration - Point at which the application is configured to read from the input stream.
  - getInputStartingPositionConfiguration
```
public InputStartingPositionConfiguration getInputStartingPositionConfiguration()
```
    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.
  - withInputStartingPositionConfiguration
```
public InputDescription withInputStartingPositionConfiguration(InputStartingPositionConfiguration inputStartingPositionConfiguration)
```
    Point at which the application is configured to read from the input stream.
    
    Parameters:
    
    inputStartingPositionConfiguration - Point at which the application is configured to read from the input stream.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public InputDescription clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class InputDescription

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

InputDescription

Method Detail

setInputId

getInputId

withInputId

setNamePrefix

getNamePrefix

withNamePrefix

getInAppStreamNames

setInAppStreamNames

withInAppStreamNames

withInAppStreamNames

setInputProcessingConfigurationDescription

getInputProcessingConfigurationDescription

withInputProcessingConfigurationDescription

setKinesisStreamsInputDescription

getKinesisStreamsInputDescription

withKinesisStreamsInputDescription

setKinesisFirehoseInputDescription

getKinesisFirehoseInputDescription

withKinesisFirehoseInputDescription

setInputSchema

getInputSchema

withInputSchema

setInputParallelism

getInputParallelism

withInputParallelism

setInputStartingPositionConfiguration

getInputStartingPositionConfiguration

withInputStartingPositionConfiguration

toString

equals

hashCode

clone

marshall