Package 

Interface S3Object

  • All Implemented Interfaces:
    org.veupathdb.lib.s3.s34k.S3Response , org.veupathdb.lib.s3.s34k.objects.ObjectResponse 
    
public interface S3Object
 implements ObjectResponse

    S3 Object

    Represents a single object in an S3 store and provides methods and properties for operating on the object and its tags.

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description

    • Field Summary

      Fields 
      Modifier and Type Field Description

    • Constructor Summary

      Constructors 
      Constructor Description

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description

    • Constructor Detail

    • Method Detail

      • exists

         abstract Boolean exists()

        Tests whether this object still exists.

      • delete

         abstract Unit delete()

        Deletes the current object.

      • delete

         abstract Unit delete(Function1<DeleteParams, Unit> action)

        Deletes the current object.

        Parameters:
        action - Action used to configure the backing S3 operation.

      • delete

         abstract Unit delete(DeleteParams params)

        Deletes the current object.

        Parameters:
        params - Parameters for the backing S3 operation.

      • stat

         abstract ObjectMeta stat()

        Fetches metadata for this object.

        If this object no longer exists, null will be returned.

      • stat

         abstract ObjectMeta stat(Function1<ObjectStatParams, Unit> action)

        Fetches metadata for this object.

        If this object no longer exists, null will be returned.

        Parameters:
        action - Action used to configure the backing S3 operation.

      • stat

         abstract ObjectMeta stat(ObjectStatParams params)

        Fetches metadata for this object.

        If this object no longer exists, null will be returned.

        Parameters:
        params - Parameters for the backing S3 operation.

      • getLastModified

         abstract OffsetDateTime getLastModified()

        Object last modified/created timestamp.

        This value will not be present on responses from object puts.

      • getBaseName

         abstract String getBaseName()

        Returns the base name of this object, or in other words, the last segment of the path.

        Examples:

        Given the object path foo/bar/fizz/buzz the base name would be "buzz"

        Given the object path foo the base name would be "foo"

      • getDirName

         abstract String getDirName()

        Returns the 'directory' parent of this object.

        If this path is a root level object, the returned dirName will be blank.

        Examples:

        Given the object path foo/bar/fizz/buzz the dir name would be "foo/bar/fizz".

        Given the object path foo, the dir name would be "".