ObjectRef

Type Members

trait DeleteRequest extends AnyRef

A request to delete the bucket.
trait GetRequest extends AnyRef

A GET request.
trait PutRequest[E, A] extends AnyRef

A PUT request: allows you to update the contents of this object.
A PUT request: allows you to update the contents of this object.
E
the consumer input type
A
the consumer output type

Abstract Value Members

abstract def bucket: String

The name of parent bucket.
abstract def copyTo(targetBucketName: String, targetObjectName: String)(implicit ec: ExecutionContext): Future[Unit]

Copies the referenced object to another one.
Copies the referenced object to another one.
targetBucketName
the name of the parent bucket for the target object
targetObjectName
the name of the target object
```
import scala.concurrent.ExecutionContext
import com.zengularity.benji.ObjectRef
def foo(myObject: ObjectRef)(implicit ec: ExecutionContext) =
  myObject.copyTo("targetBucket", "copyName")
```
abstract def defaultThreshold: Bytes

The default threshold for multipart (multi-component) upload.

abstract def delete: DeleteRequest

Prepares a request to delete the referenced object.

import scala.concurrent.ExecutionContext
import com.zengularity.benji.ObjectRef

def foo(myObject: ObjectRef)(implicit ec: ExecutionContext) =
  myObject.delete()

abstract def exists(implicit ec: ExecutionContext): Future[Boolean]

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.ObjectRef

def foo(myObject: ObjectRef)(implicit ec: ExecutionContext) =
  myObject.exists
```

abstract def get: GetRequest

Prepares the request to get the contents of this object.

import akka.stream.Materializer
import com.zengularity.benji.ObjectRef

def foo(myObject: ObjectRef)(implicit m: Materializer) =
  myObject.get()

abstract def headers()(implicit ec: ExecutionContext): Future[Map[String, Seq[String]]]

Returns the headers associated with the currently referenced object.
Returns the headers associated with the currently referenced object.
```
import scala.concurrent.ExecutionContext
import com.zengularity.benji.ObjectRef

def foo(myObject: ObjectRef)(implicit ec: ExecutionContext) =
  myObject.headers()
```
abstract def metadata()(implicit ec: ExecutionContext): Future[Map[String, Seq[String]]]

Returns the metadata associated with the currently referenced object (normalized from the headers).
Returns the metadata associated with the currently referenced object (normalized from the headers).
```
import scala.concurrent.ExecutionContext
import com.zengularity.benji.ObjectRef

def foo(myObject: ObjectRef)(implicit ec: ExecutionContext) =
  myObject.metadata()
```
abstract def moveTo(targetBucketName: String, targetObjectName: String, preventOverwrite: Boolean)(implicit ec: ExecutionContext): Future[Unit]

Moves the referenced object to another one.
Moves the referenced object to another one. If fails, the current object is still available.
targetBucketName
the name of the parent bucket for the target object
targetObjectName
the name of the target object
preventOverwrite
if true, prevents overwriting an existing target object
```
import scala.concurrent.ExecutionContext
import com.zengularity.benji.ObjectRef
def foo(myObject: ObjectRef)(implicit ec: ExecutionContext) =
  myObject.moveTo("targetBucket", "newName", false)
```
abstract def name: String

The name of the object itself.

abstract def put[E, A]: PutRequest[E, A]

E

the consumer input type

A

the consumer output type

import akka.util.ByteString
import akka.stream.Materializer
import play.api.libs.ws.BodyWritable
import scala.concurrent.Future
import com.zengularity.benji.ObjectRef
def upload(obj: ObjectRef)(
  implicit m: Materializer, w: BodyWritable[ByteString]) =
  obj.put[ByteString, Unit]({})((_, _) => Future.successful({}))

abstract def versioning: Option[ObjectVersioning]

Try to get a reference of this object that would allow you to perform versioning related operations.
Try to get a reference of this object that would allow you to perform versioning related operations.
returns
Some if the module of the object supports versioning related operations, otherwise None.
```
def foo(myObject: com.zengularity.benji.ObjectRef) =
  myObject.versioning.isDefined
```

Concrete Value Members

final def !=(arg0: Any): Boolean

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

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

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

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )

def copyTo(target: ObjectRef)(implicit ec: ExecutionContext): Future[Unit]

Copies the referenced object to another one.

target

the reference to the target object

import scala.concurrent.ExecutionContext
import com.zengularity.benji.ObjectRef
def foo(
  myObject: ObjectRef,
  otherRef: ObjectRef)(implicit ec: ExecutionContext) =
  myObject.copyTo(otherRef)

final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

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

Definition Classes
AnyRef → Any
def hashCode(): Int

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

Definition Classes
Any
final def moveTo(target: ObjectRef, preventOverwrite: Boolean = true)(implicit ec: ExecutionContext): Future[Unit]

Moves the referenced object to another one.
Moves the referenced object to another one. If fails, the current object is still available.
target
the reference to the target object
preventOverwrite
if true, prevents overwriting an existing target object (default: true)
```
import scala.concurrent.ExecutionContext
import com.zengularity.benji.ObjectRef
def foo(
  myObject: ObjectRef, otherRef: ObjectRef)(
  implicit ec: ExecutionContext) = myObject.moveTo(otherRef)
```
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def put[E](size: Long)(implicit m: Materializer, w: BodyWritable[E]): Sink[E, Future[NotUsed]]

E
the consumer input type
size
the total size in bytes to be PUTed
def put[E](implicit m: Materializer, w: BodyWritable[E]): Sink[E, Future[NotUsed]]

E
the consumer input type
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

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

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object ObjectRef | package benji

trait ObjectRef extends AnyRef

Type Members

trait DeleteRequest extends AnyRef

trait GetRequest extends AnyRef

trait PutRequest[E, A] extends AnyRef

Abstract Value Members

abstract def bucket: String

abstract def copyTo(targetBucketName: String, targetObjectName: String)(implicit ec: ExecutionContext): Future[Unit]

abstract def defaultThreshold: Bytes

abstract def delete: DeleteRequest

abstract def exists(implicit ec: ExecutionContext): Future[Boolean]

abstract def get: GetRequest

abstract def headers()(implicit ec: ExecutionContext): Future[Map[String, Seq[String]]]

abstract def metadata()(implicit ec: ExecutionContext): Future[Map[String, Seq[String]]]

abstract def moveTo(targetBucketName: String, targetObjectName: String, preventOverwrite: Boolean)(implicit ec: ExecutionContext): Future[Unit]

abstract def name: String

abstract def put[E, A]: PutRequest[E, A]

abstract def versioning: Option[ObjectVersioning]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

def copyTo(target: ObjectRef)(implicit ec: ExecutionContext): Future[Unit]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def moveTo(target: ObjectRef, preventOverwrite: Boolean = true)(implicit ec: ExecutionContext): Future[Unit]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def put[E](size: Long)(implicit m: Materializer, w: BodyWritable[E]): Sink[E, Future[NotUsed]]

def put[E](implicit m: Materializer, w: BodyWritable[E]): Sink[E, Future[NotUsed]]

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Ungrouped