Record Class ObjectMetadataWrite

java.lang.Object
java.lang.Record
io.micronaut.objectstorage.metadata.ObjectMetadataWrite
Record Components:
key - The object key.
metadata - User metadata.
attributes - Portable custom attributes.
contentType - The optional content type.
contentLength - The optional content length.
etag - The optional entity tag.
lastModified - The optional last modified instant.
public record ObjectMetadataWrite(@NonNull String key, @NonNull Map<String,String> metadata, @NonNull Map<String,String> attributes, @Nullable String contentType, @Nullable Long contentLength, @Nullable String etag, @Nullable Instant lastModified) extends Record
Portable object metadata write model.

This write model represents a full metadata snapshot. Implementations should treat save operations as replace/upsert, not patch/merge.

Since:
3.0.0
Author:
Álvaro Sánchez-Mariscal

  • Constructor Details

    • ObjectMetadataWrite

      public ObjectMetadataWrite(@NonNull String key, @NonNull Map<String,String> metadata, @NonNull Map<String,String> attributes, @Nullable String contentType, @Nullable Long contentLength, @Nullable String etag, @Nullable Instant lastModified)
      Creates an instance of a ObjectMetadataWrite record class.
      Parameters:
      key - the value for the key record component
      metadata - the value for the metadata record component
      attributes - the value for the attributes record component
      contentType - the value for the contentType record component
      contentLength - the value for the contentLength record component
      etag - the value for the etag record component
      lastModified - the value for the lastModified record component

    • ObjectMetadataWrite

      public ObjectMetadataWrite(@NonNull String key, @NonNull Map<String,String> metadata)
      Creates a metadata write with metadata only.
      Parameters:
      key - The object key.
      metadata - User metadata.

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • key

      public @NonNull String key()
      Returns the value of the key record component.
      Returns:
      the value of the key record component

    • metadata

      public @NonNull Map<String,String> metadata()
      Returns the value of the metadata record component.
      Returns:
      the value of the metadata record component

    • attributes

      public @NonNull Map<String,String> attributes()
      Returns the value of the attributes record component.
      Returns:
      the value of the attributes record component

    • contentType

      public @Nullable String contentType()
      Returns the value of the contentType record component.
      Returns:
      the value of the contentType record component

    • contentLength

      public @Nullable Long contentLength()
      Returns the value of the contentLength record component.
      Returns:
      the value of the contentLength record component

    • etag

      public @Nullable String etag()
      Returns the value of the etag record component.
      Returns:
      the value of the etag record component

    • lastModified

      public @Nullable Instant lastModified()
      Returns the value of the lastModified record component.
      Returns:
      the value of the lastModified record component