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(value="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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	InputDescription.Builder

Method Summary

Modifier and Type	Method and Description
static InputDescription.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<String>	inAppStreamNames() Returns the in-application stream names that are mapped to the stream source.
String	inputId() Input ID associated with the application input.
InputParallelism	inputParallelism() Describes the configured parallelism (number of in-application streams mapped to the streaming source).
InputProcessingConfigurationDescription	inputProcessingConfigurationDescription() The description of the preprocessor that executes on records in this input before the application's code is run.
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.
InputStartingPositionConfiguration	inputStartingPositionConfiguration() Point at which the application is configured to read from the input stream.
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.
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.
String	namePrefix() In-application name prefix.
List<SdkField<?>>	sdkFields()
static Class<? extends InputDescription.Builder>	serializableBuilderClass()
InputDescription.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

inputId

public 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 String namePrefix()

In-application name prefix.

Returns:

In-application name prefix.

inAppStreamNames

public 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.

Returns:

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

inputProcessingConfigurationDescription

public 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 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 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 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 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 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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public 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.