Package 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:
SdkPojo, ToCopyableBuilder<PutRecordsResponse.Builder,PutRecordsResponse>
@Generated("software.amazon.awssdk:codegen") public final class PutRecordsResponse extends KinesisResponse implements ToCopyableBuilder<PutRecordsResponse.Builder,PutRecordsResponse>

PutRecords results.

  • Method Details

    • failedRecordCount

      public final Integer failedRecordCount()

      The number of unsuccessfully processed records in a PutRecords request.

      Returns:
      The number of unsuccessfully processed records in a PutRecords request.

    • hasRecords

      public final boolean hasRecords()
      For responses, this returns true if the service returned a value for the Records 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.

    • records

      public final List<PutRecordsResultEntry> records()

      An array of successfully and unsuccessfully processed record results. 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.

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

      Returns:
      An array of successfully and unsuccessfully processed record results. 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 final 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 Amazon Web Services 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 Amazon Web Services KMS key.

      See Also:

    • encryptionTypeAsString

      public final 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 Amazon Web Services 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 Amazon Web Services KMS key.

      See Also:

    • toBuilder

      public PutRecordsResponse.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<PutRecordsResponse.Builder,PutRecordsResponse>
      Specified by:
      toBuilder in class AwsResponse

    • builder

      public static PutRecordsResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PutRecordsResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Overrides:
      getValueForField in class SdkResponse

    • 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