Package software.amazon.awssdk.services.kinesis.model

Class RecordConfiguration

java.lang.Object

software.amazon.awssdk.services.kinesis.model.RecordConfiguration

All Implemented Interfaces:

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

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

Specifies the format of records read from the source stream.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RecordConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static RecordConfiguration.Builder	builder()
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final String	gsrSchemaARN()	The Amazon Resource Name (ARN) of the Amazon Web Services Glue Schema Registry schema used to validate records.
final int	hashCode()
final RecordFormatType	recordFormatType()	The format of records on the source stream.
final String	recordFormatTypeAsString()	The format of records on the source stream.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends RecordConfiguration.Builder>	serializableBuilderClass()
RecordConfiguration.Builder	toBuilder()
final String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Details

recordFormatType

public final RecordFormatType recordFormatType()

The format of records on the source stream. Valid values:

• GSR_JSON - Supported only for streaming table (Amazon S3 Tables) destinations.

• JSON - Supported for both general purpose Amazon S3 and streaming table destinations.

• STRING - Supported only for general purpose Amazon S3 destinations.

• BYTE_ARRAY - Supported only for general purpose Amazon S3 destinations.

If the service returns an enum value that is not available in the current SDK version, recordFormatType will return RecordFormatType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from recordFormatTypeAsString().

Returns:

The format of records on the source stream. Valid values:

• GSR_JSON - Supported only for streaming table (Amazon S3 Tables) destinations.

• JSON - Supported for both general purpose Amazon S3 and streaming table destinations.

• STRING - Supported only for general purpose Amazon S3 destinations.

• BYTE_ARRAY - Supported only for general purpose Amazon S3 destinations.

See Also:

• RecordFormatType

recordFormatTypeAsString

public final String recordFormatTypeAsString()

The format of records on the source stream. Valid values:

• GSR_JSON - Supported only for streaming table (Amazon S3 Tables) destinations.

• JSON - Supported for both general purpose Amazon S3 and streaming table destinations.

• STRING - Supported only for general purpose Amazon S3 destinations.

• BYTE_ARRAY - Supported only for general purpose Amazon S3 destinations.

If the service returns an enum value that is not available in the current SDK version, recordFormatType will return RecordFormatType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from recordFormatTypeAsString().

Returns:

The format of records on the source stream. Valid values:

• GSR_JSON - Supported only for streaming table (Amazon S3 Tables) destinations.

• JSON - Supported for both general purpose Amazon S3 and streaming table destinations.

• STRING - Supported only for general purpose Amazon S3 destinations.

• BYTE_ARRAY - Supported only for general purpose Amazon S3 destinations.

See Also:

• RecordFormatType

gsrSchemaARN

public final String gsrSchemaARN()

The Amazon Resource Name (ARN) of the Amazon Web Services Glue Schema Registry schema used to validate records. Required when the channel destination is a streaming table (Amazon S3 Tables), for both the JSON and GSR_JSON record formats.

Returns:

The Amazon Resource Name (ARN) of the Amazon Web Services Glue Schema Registry schema used to validate records. Required when the channel destination is a streaming table (Amazon S3 Tables), for both the JSON and GSR_JSON record formats.

toBuilder

public RecordConfiguration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RecordConfiguration.Builder,RecordConfiguration>

builder

public static RecordConfiguration.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo