c

uk.gov.hmrc.objectstore.client.play

PlayObjectStoreClientEither

class PlayObjectStoreClientEither extends ObjectStoreClient[FutureEither, Request, Response, ResBody]

Client which returns responses within Future[Either[PlayObjectStoreException, *]].

Annotations
@Singleton()
Linear Supertypes
ObjectStoreClient[FutureEither, Request, Response, ResBody], AnyRef, Any
Known Subclasses
StubPlayObjectStoreClientEither
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. PlayObjectStoreClientEither
  2. ObjectStoreClient
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new PlayObjectStoreClientEither(wsClient: WSClient, config: ObjectStoreClientConfig)(implicit m: Materializer, ec: ExecutionContext)
    Annotations
    @Inject()

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. 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
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. 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

    @see https://github.com/hmrc/object-store-client#get-object

    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
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. 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

    ObjectListing wrapped in the effect F

    Definition Classes
    ObjectStoreClient
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. def putObject[CONTENT](path: File, content: CONTENT, retentionPeriod: RetentionPeriod = config.defaultRetentionPeriod, contentType: Option[String] = None, owner: String = config.owner)(implicit w: ObjectStoreContentWrite[FutureEither, CONTENT, Request], hc: HeaderCarrier): FutureEither[Unit]

    Put object

    Put object

    CONTENT

    @see https://github.com/hmrc/object-store-client#put-object

    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

    owner

    Owner service of this object

    returns

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

  19. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from ObjectStoreClient[FutureEither, Request, Response, ResBody]

Inherited from AnyRef

Inherited from Any

Ungrouped