Package software.amazon.awssdk.services.s3.model

Class RecordsEvent

java.lang.Object
software.amazon.awssdk.services.s3.model.RecordsEvent
All Implemented Interfaces:
Serializable, SdkPojo, SelectObjectContentEventStream, ToCopyableBuilder<RecordsEvent.Builder,RecordsEvent>
Direct Known Subclasses:
DefaultRecords
@Generated("software.amazon.awssdk:codegen") public class RecordsEvent extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RecordsEvent.Builder,RecordsEvent>, SelectObjectContentEventStream

The container for the records event.

See Also:

  • Constructor Details

  • Method Details

    • payload

      public final SdkBytes payload()

      The byte array of partial, one or more result records. S3 Select doesn't guarantee that a record will be self-contained in one record frame. To ensure continuous streaming of data, S3 Select might split the same record across multiple record frames instead of aggregating the results in memory. Some S3 clients (for example, the SDK for Java) handle this behavior by creating a ByteStream out of the response by default. Other clients might not handle this behavior by default. In those cases, you must aggregate the results on the client side and parse the response.

      Returns:
      The byte array of partial, one or more result records. S3 Select doesn't guarantee that a record will be self-contained in one record frame. To ensure continuous streaming of data, S3 Select might split the same record across multiple record frames instead of aggregating the results in memory. Some S3 clients (for example, the SDK for Java) handle this behavior by creating a ByteStream out of the response by default. Other clients might not handle this behavior by default. In those cases, you must aggregate the results on the client side and parse the response.

    • toBuilder

      public RecordsEvent.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<RecordsEvent.Builder,RecordsEvent>

    • builder

      public static RecordsEvent.Builder builder()

    • serializableBuilderClass

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

    • copy

      public final RecordsEvent copy(Consumer<? super RecordsEvent.Builder> modifier)
      Specified by:
      copy in interface ToCopyableBuilder<RecordsEvent.Builder,RecordsEvent>

    • 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

    • accept

      public void accept(SelectObjectContentResponseHandler.Visitor visitor)
      Calls the appropriate visit method depending on the subtype of RecordsEvent.
      Specified by:
      accept in interface SelectObjectContentEventStream
      Parameters:
      visitor - Visitor to invoke.