class PlayObjectStoreClientEither extends ObjectStoreClient[FutureEither, Request, Response, ResBody]
Client which returns responses within Future[Either[PlayObjectStoreException, *]].
- Annotations
- @Singleton()
- Alphabetic
- By Inheritance
- PlayObjectStoreClientEither
- ObjectStoreClient
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new PlayObjectStoreClientEither(wsClient: WSClient, config: ObjectStoreClientConfig)(implicit m: Materializer, ec: ExecutionContext)
- Annotations
- @Inject()
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[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- def deleteObject(path: File, owner: String = config.owner)(implicit hc: HeaderCarrier): FutureEither[Unit]
Delete object
Delete object
- path
Path of the object in object-store under owner
- owner
Owner service of this object
- returns
Unit wrapped in the effect F
- Definition Classes
- ObjectStoreClient
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def getObject[CONTENT](path: File, owner: String = config.owner)(implicit cr: ObjectStoreContentRead[FutureEither, ResBody, CONTENT], hc: HeaderCarrier): FutureEither[Option[Object[CONTENT]]]
Get object
Get object
- CONTENT
- path
Path of the object in object-store under owner
- owner
Owner service of this object
- returns
optional Object
[CONTENT]wrapped in the effect F
- Definition Classes
- ObjectStoreClient
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def listObjects(path: Directory, owner: String = config.owner)(implicit hc: HeaderCarrier): FutureEither[ObjectListing]
List objects
List objects
- path
Path of the object in object-store under owner
- owner
Owner service
- returns
ObjectSummary wrapped in the effect F
- Definition Classes
- ObjectStoreClient
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- def putObject[CONTENT](path: File, content: CONTENT, retentionPeriod: RetentionPeriod = config.defaultRetentionPeriod, contentType: Option[String] = None, contentMd5: Option[Md5Hash] = None, owner: String = config.owner)(implicit w: ObjectStoreContentWrite[FutureEither, CONTENT, Request], hc: HeaderCarrier): FutureEither[ObjectSummaryWithMd5]
Put object
Put object
- CONTENT
- path
Path of the object in object-store under owner
- content
Content to upload
- retentionPeriod
Retention period of the object in object-store
- contentType
Optional Content-Type
- contentMd5
Optional MD5 hash of content
- owner
Owner service of this object
- returns
ObjectSummaryWithMd5 wrapped in the effect F
- Definition Classes
- ObjectStoreClient
- Note
Storing an object on an existing path will overwrite the previously stored object on that path.
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- def uploadFromUrl(from: URL, to: File, retentionPeriod: RetentionPeriod = config.defaultRetentionPeriod, contentType: Option[String] = None, contentMd5: Option[Md5Hash] = None, owner: String = config.owner)(implicit hc: HeaderCarrier): FutureEither[ObjectSummaryWithMd5]
Upload object from a url
Upload object from a url
- from
Path of the object in object-store under owner
- to
Url of content to upload
- retentionPeriod
Retention period of the object in object-store
- contentType
Optional Content-Type
- contentMd5
Optional MD5 hash of content
- owner
Owner service of this object
- returns
ObjectSummaryWithMd5 wrapped in the effect F
- Definition Classes
- ObjectStoreClient
- Note
Storing an object on an existing path will overwrite the previously stored object on that path.
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def zip(from: Directory, to: File, retentionPeriod: RetentionPeriod = config.defaultRetentionPeriod, fromOwner: String = config.owner, toOwner: String = config.owner)(implicit hc: HeaderCarrier): FutureEither[ObjectSummaryWithMd5]
Zip objects in a directory
Zip objects in a directory
- from
Path of the directory to be zipped
- to
Path of the target zip file
- retentionPeriod
Retention period of the object in object-store
- fromOwner
Owner service of the directory to be zipped
- toOwner
Owner service of the target zip file
- returns
ObjectSummaryWithMd5 wrapped in the effect F
- Definition Classes
- ObjectStoreClient
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)