Class PutRecordsResultEntry

java.lang.Object
software.amazon.awssdk.services.kinesis.model.PutRecordsResultEntry
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PutRecordsResultEntry.Builder,PutRecordsResultEntry>
@Generated("software.amazon.awssdk:codegen") public final class PutRecordsResultEntry extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PutRecordsResultEntry.Builder,PutRecordsResultEntry>

Represents the result of an individual record from a PutRecords request. A record that is successfully added to a stream includes SequenceNumber and ShardId in the result. A record that fails to be added to the stream includes ErrorCode and ErrorMessage in the result.

See Also:

  • Method Details

    • sequenceNumber

      public final String sequenceNumber()

      The sequence number for an individual record result.

      Returns:
      The sequence number for an individual record result.

    • shardId

      public final String shardId()

      The shard ID for an individual record result.

      Returns:
      The shard ID for an individual record result.

    • errorCode

      public final String errorCode()

      The error code for an individual record result. ErrorCodes can be either ProvisionedThroughputExceededException or InternalFailure.

      Returns:
      The error code for an individual record result. ErrorCodes can be either ProvisionedThroughputExceededException or InternalFailure.

    • errorMessage

      public final String errorMessage()

      The error message for an individual record result. An ErrorCode value of ProvisionedThroughputExceededException has an error message that includes the account ID, stream name, and shard ID. An ErrorCode value of InternalFailure has the error message "Internal Service Failure".

      Returns:
      The error message for an individual record result. An ErrorCode value of ProvisionedThroughputExceededException has an error message that includes the account ID, stream name, and shard ID. An ErrorCode value of InternalFailure has the error message "Internal Service Failure".

    • toBuilder

      public PutRecordsResultEntry.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<PutRecordsResultEntry.Builder,PutRecordsResultEntry>
      Returns:
      a builder for type T

    • builder

      public static PutRecordsResultEntry.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.