Trait

com.zengularity.benji

VersionedObjectRef

Related Doc: package benji

Permalink

trait VersionedObjectRef extends AnyRef

A live reference to a versioned object. The operations are scoped on a specific object version.

Such reference must only be used with the storage which resolved it first.

See also

ObjectRef

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. VersionedObjectRef
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. trait DeleteRequest extends AnyRef

    Permalink

    A request to delete the bucket.

  2. trait GetRequest extends AnyRef

    Permalink

    A GET request.

Abstract Value Members

  1. abstract def bucket: String

    Permalink

    The name of parent bucket.

  2. abstract def delete: DeleteRequest

    Permalink

    Prepares a request to delete the referenced object

    Prepares a request to delete the referenced object

    import akka.stream.Materializer
    import com.zengularity.benji.VersionedObjectRef
    
    def foo(myObject: VersionedObjectRef)(implicit m: Materializer) =
      myObject.delete()
  3. abstract def exists(implicit ec: ExecutionContext): Future[Boolean]

    Permalink

    Checks whether or not this object exists.

    Checks whether or not this object exists. May also return false in cases you don't have permission to view a certain object.

    import scala.concurrent.ExecutionContext
    import com.zengularity.benji.VersionedObjectRef
    
    def foo(myObject: VersionedObjectRef)(implicit ec: ExecutionContext) =
      myObject.exists
  4. abstract def get: GetRequest

    Permalink

    Prepares the request to get the contents of this specific version.

    Prepares the request to get the contents of this specific version.

    import akka.stream.Materializer
    import com.zengularity.benji.VersionedObjectRef
    
    def foo(myObject: VersionedObjectRef)(implicit m: Materializer) =
      myObject.get()
  5. abstract def headers()(implicit ec: ExecutionContext): Future[Map[String, Seq[String]]]

    Permalink

    Returns the headers of the referenced version.

    Returns the headers of the referenced version.

    import scala.concurrent.ExecutionContext
    import com.zengularity.benji.VersionedObjectRef
    
    def foo(myObject: VersionedObjectRef)(implicit ec: ExecutionContext) =
      myObject.headers()
  6. abstract def metadata()(implicit ec: ExecutionContext): Future[Map[String, Seq[String]]]

    Permalink

    Returns the metadata of the referenced version.

    Returns the metadata of the referenced version. (normalized from the headers).

    import scala.concurrent.ExecutionContext
    import com.zengularity.benji.VersionedObjectRef
    
    def foo(myObject: VersionedObjectRef)(implicit ec: ExecutionContext) =
      myObject.metadata()
  7. abstract def name: String

    Permalink

    The name of the object itself.

  8. abstract def versionId: String

    Permalink

    The versionId of this reference.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  16. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped