software.amazon.awssdk.services.kinesisanalyticsv2.model

Class InputDescription

java.lang.Object

software.amazon.awssdk.services.kinesisanalyticsv2.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 an SQL-based Amazon Kinesis Data Analytics application.

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() The input ID that is 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() The point at which the application is configured to read from the input stream.
KinesisFirehoseInputDescription	kinesisFirehoseInputDescription() If a Kinesis Data Firehose delivery stream is configured as a streaming source, provides the delivery stream's ARN.
KinesisStreamsInputDescription	kinesisStreamsInputDescription() If a Kinesis data stream is configured as a streaming source, provides the Kinesis data stream's Amazon Resource Name (ARN).
String	namePrefix() The 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()

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

Returns:

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

namePrefix

public String namePrefix()

The in-application name prefix.

Returns:

The 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 a Kinesis data stream is configured as a streaming source, provides the Kinesis data stream's Amazon Resource Name (ARN).

Returns:

If a Kinesis data stream is configured as a streaming source, provides the Kinesis data stream's Amazon Resource Name (ARN).

kinesisFirehoseInputDescription

public KinesisFirehoseInputDescription kinesisFirehoseInputDescription()

If a Kinesis Data Firehose delivery stream is configured as a streaming source, provides the delivery stream's ARN.

Returns:

If a Kinesis Data Firehose delivery stream is configured as a streaming source, provides the delivery stream's ARN.

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

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

Returns:

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