software.amazon.awssdk.services.kinesisanalytics.model

Class SourceSchema

java.lang.Object

software.amazon.awssdk.services.kinesisanalytics.model.SourceSchema

All Implemented Interfaces:

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

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

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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SourceSchema.Builder

Method Summary

Modifier and Type	Method and Description
static SourceSchema.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRecordColumns() For responses, this returns true if the service returned a value for the RecordColumns property.
List<RecordColumn>	recordColumns() A list of RecordColumn objects.
String	recordEncoding() Specifies the encoding of the records in the streaming source.
RecordFormat	recordFormat() Specifies the format of the records on the streaming source.
List<SdkField<?>>	sdkFields()
static Class<? extends SourceSchema.Builder>	serializableBuilderClass()
SourceSchema.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
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 Detail

recordFormat

public final RecordFormat recordFormat()

Specifies the format of the records on the streaming source.

Returns:

Specifies the format of the records on the streaming source.

recordEncoding

public final String recordEncoding()

Specifies the encoding of the records in the streaming source. For example, UTF-8.

Returns:

Specifies the encoding of the records in the streaming source. For example, UTF-8.

hasRecordColumns

public final boolean hasRecordColumns()

For responses, this returns true if the service returned a value for the RecordColumns 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.

recordColumns

public final List<RecordColumn> recordColumns()

A list of RecordColumn objects.

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

Returns:

A list of RecordColumn objects.

toBuilder

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

Returns:

a builder for type T

builder

public static SourceSchema.Builder builder()

serializableBuilderClass

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