Class ReferenceDataSourceDescription

java.lang.Object

software.amazon.awssdk.services.kinesisanalytics.model.ReferenceDataSourceDescription

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ReferenceDataSourceDescription.Builder,ReferenceDataSourceDescription>

@Generated("software.amazon.awssdk:codegen")
public final class ReferenceDataSourceDescription
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ReferenceDataSourceDescription.Builder,ReferenceDataSourceDescription>

Describes the reference data source configured for an application.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ReferenceDataSourceDescription.Builder

Method Summary

Modifier and Type	Method	Description
static ReferenceDataSourceDescription.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final String	referenceId()	ID of the reference data source.
final SourceSchema	referenceSchema()	Describes the format of the data in the streaming source, and how each data element maps to corresponding columns created in the in-application stream.
final S3ReferenceDataSourceDescription	s3ReferenceDataSourceDescription()	Provides the S3 bucket name, the object key name that contains the reference data.
final List<SdkField<?>>	sdkFields()
static Class<? extends ReferenceDataSourceDescription.Builder>	serializableBuilderClass()
final String	tableName()	The in-application table name created by the specific reference data source configuration.
ReferenceDataSourceDescription.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
final String	toString()	Returns a string representation of this object.

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 Details

referenceId

public final String referenceId()

ID of the reference data source. This is the ID that Amazon Kinesis Analytics assigns when you add the reference data source to your application using the AddApplicationReferenceDataSource operation.

Returns:

ID of the reference data source. This is the ID that Amazon Kinesis Analytics assigns when you add the reference data source to your application using the AddApplicationReferenceDataSource operation.

tableName

public final String tableName()

The in-application table name created by the specific reference data source configuration.

Returns:

The in-application table name created by the specific reference data source configuration.

s3ReferenceDataSourceDescription

public final S3ReferenceDataSourceDescription s3ReferenceDataSourceDescription()

Provides the S3 bucket name, the object key name that contains the reference data. It also provides the Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object and populate the in-application reference table.

Returns:

Provides the S3 bucket name, the object key name that contains the reference data. It also provides the Amazon Resource Name (ARN) of the IAM role that Amazon Kinesis Analytics can assume to read the Amazon S3 object and populate the in-application reference table.

referenceSchema

public final SourceSchema referenceSchema()

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

Returns:

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

toBuilder

public ReferenceDataSourceDescription.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<ReferenceDataSourceDescription.Builder,ReferenceDataSourceDescription>

Returns:

a builder for type T

builder

public static ReferenceDataSourceDescription.Builder builder()

serializableBuilderClass

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