software.amazon.awssdk.services.kinesis.model

Class PutRecordsResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.kinesis.model.KinesisResponse

software.amazon.awssdk.services.kinesis.model.PutRecordsResponse

All Implemented Interfaces:

ToCopyableBuilder<PutRecordsResponse.Builder,PutRecordsResponse>

@Generated(value="software.amazon.awssdk:codegen")
public class PutRecordsResponse
extends KinesisResponse
implements ToCopyableBuilder<PutRecordsResponse.Builder,PutRecordsResponse>

PutRecords results.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PutRecordsResponse.Builder

Method Summary

Modifier and Type	Method and Description
static PutRecordsResponse.Builder	builder()
EncryptionType	encryptionType() The encryption type used on the records.
String	encryptionTypeAsString() The encryption type used on the records.
boolean	equals(Object obj)
Integer	failedRecordCount() The number of unsuccessfully processed records in a PutRecords request.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkResponse.
int	hashCode()
List<PutRecordsResultEntry>	records() An array of successfully and unsuccessfully processed record results, correlated with the request by natural ordering.
static Class<? extends PutRecordsResponse.Builder>	serializableBuilderClass()
PutRecordsResponse.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 software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

failedRecordCount

public Integer failedRecordCount()

The number of unsuccessfully processed records in a PutRecords request.

Returns:

The number of unsuccessfully processed records in a PutRecords request.

records

public List<PutRecordsResultEntry> records()

An array of successfully and unsuccessfully processed record results, correlated with the request by natural ordering. A record that is successfully added to a stream includes SequenceNumber and ShardId in the result. A record that fails to be added to a stream includes ErrorCode and ErrorMessage in the result.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

An array of successfully and unsuccessfully processed record results, correlated with the request by natural ordering. A record that is successfully added to a stream includes SequenceNumber and ShardId in the result. A record that fails to be added to a stream includes ErrorCode and ErrorMessage in the result.

encryptionType

public EncryptionType encryptionType()

The encryption type used on the records. This parameter can be one of the following values:

• NONE: Do not encrypt the records.

• KMS: Use server-side encryption on the records using a customer-managed KMS key.

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

Returns:

The encryption type used on the records. This parameter can be one of the following values:

• NONE: Do not encrypt the records.

• KMS: Use server-side encryption on the records using a customer-managed KMS key.

See Also:

EncryptionType

encryptionTypeAsString

public String encryptionTypeAsString()

The encryption type used on the records. This parameter can be one of the following values:

• NONE: Do not encrypt the records.

• KMS: Use server-side encryption on the records using a customer-managed KMS key.

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

Returns:

The encryption type used on the records. This parameter can be one of the following values:

• NONE: Do not encrypt the records.

• KMS: Use server-side encryption on the records using a customer-managed KMS key.

See Also:

EncryptionType

toBuilder

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

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static PutRecordsResponse.Builder builder()

serializableBuilderClass

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

Description copied from class: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value