pt.tecnico.dsi.openstack.common.services

CrudService

abstract class CrudService[F[_], Model, Create, Update] extends Service[F]

Source: CrudService.scala

Linear Supertypes

Service[F], AnyRef, Any

Type Hierarchy

Ordering

Alphabetic
By Inheritance

Inherited

CrudService
Service
AnyRef
Any

Implicitly

by StringFormat
by Ensuring
by ArrowAssoc

Hide All
Show All

Visibility

Public
Protected

Instance Constructors

new CrudService(baseUri: Uri, name: String, authToken: Header, wrapped: Boolean = true)(implicit arg0: Sync[F], arg1: Client[F], arg2: Decoder[Model], arg3: Encoder[Create], arg4: Encoder[Update])

Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
def ->[B](y: B): (CrudService[F, Model, Create, Update], B)
Implicit
This member is added by an implicit conversion from CrudService[F, Model, Create, Update] toArrowAssoc[CrudService[F, Model, Create, Update]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
implicit val F: Sync[F]
Attributes
protected
Definition Classes
Service
final def asInstanceOf[T0]: T0
Definition Classes
Any
val authToken: Header
Attributes
protected
Definition Classes
Service
implicit val client: Client[F]
Attributes
protected
Definition Classes
Service
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
def create(value: Create, extraHeaders: Header*): F[WithId[Model]]
def createHandleConflict(value: Create, extraHeaders: Header*)(onConflict: F[WithId[Model]]): F[WithId[Model]]
Attributes
protected
def delete(id: String, extraHeaders: Header*): F[Unit]
def delete(value: WithId[Model], extraHeaders: Header*): F[Unit]
def delete(uri: Uri, extraHeaders: Header*): F[Unit]
An idempotent delete.
An idempotent delete. If NotFound or Gone are returned this method will succeed.
uri
the uri to which the request will be made.
extraHeaders
extra headers to be used. The authToken header is always added.
Attributes
protected
Definition Classes
Service
val dsl: Http4sClientDsl[F]
Attributes
protected
Definition Classes
Service
def ensuring(cond: (CrudService[F, Model, Create, Update]) => Boolean, msg: => Any): CrudService[F, Model, Create, Update]
Implicit
This member is added by an implicit conversion from CrudService[F, Model, Create, Update] toEnsuring[CrudService[F, Model, Create, Update]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (CrudService[F, Model, Create, Update]) => Boolean): CrudService[F, Model, Create, Update]
Implicit
This member is added by an implicit conversion from CrudService[F, Model, Create, Update] toEnsuring[CrudService[F, Model, Create, Update]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: => Any): CrudService[F, Model, Create, Update]
Implicit
This member is added by an implicit conversion from CrudService[F, Model, Create, Update] toEnsuring[CrudService[F, Model, Create, Update]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): CrudService[F, Model, Create, Update]
Implicit
This member is added by an implicit conversion from CrudService[F, Model, Create, Update] toEnsuring[CrudService[F, Model, Create, Update]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
def expect[R](wrappedAt: Option[String], method: Method with PermitsBody, uri: Uri, extraHeaders: Header*)(implicit arg0: Decoder[R]): F[R]
Invokes method on the specified uri without any body.
Invokes method on the specified uri without any body. The response will be parsed to an R.
wrappedAt
whether to decode R at the Json root, or at the field at.
method
the method to use, eg: GET, POST, etc.
uri
the uri to which the request will be made.
extraHeaders
extra headers to be used. The authToken header is always added.
Attributes
protected
Definition Classes
Service
def expect[B, R](wrappedAt: Option[String], method: Method with PermitsBody, value: B, uri: Uri, extraHeaders: Header*)(implicit arg0: Encoder[B], arg1: Decoder[R]): F[R]
Invokes method on the specified uri passing as body value.
Invokes method on the specified uri passing as body value. The response will be parsed to an R.
wrappedAt
whether to encode B and decode R at the Json root, or at the field at.
method
the method to use, eg: GET, POST, etc.
value
the value to send in the body. This value will be json encoded using wrapped.
uri
the uri to which the request will be made.
extraHeaders
extra headers to be used. The authToken header is always added.
Attributes
protected
Definition Classes
Service
def expectUnwrapped[R](wrappedAt: Option[String], request: F[Request[F]])(implicit arg0: Decoder[R]): F[R]
Submits request and decodes the response to a R on success.
Submits request and decodes the response to a R on success.
wrappedAt
whether to decode R at the Json root, or at the field at.
request
the request to execute.
Attributes
protected
Definition Classes
Service
def formatted(fmtstr: String): String
Implicit
This member is added by an implicit conversion from CrudService[F, Model, Create, Update] toStringFormat[CrudService[F, Model, Create, Update]] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
def get(id: String, extraHeaders: Header*): F[WithId[Model]]
def get[R](wrappedAt: Option[String], uri: Uri, extraHeaders: Header*)(implicit arg0: Decoder[R]): F[R]
Attributes
protected
Definition Classes
Service
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native() @HotSpotIntrinsicCandidate()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native() @HotSpotIntrinsicCandidate()
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
implicit def jsonDecoder[A](implicit arg0: Decoder[A]): EntityDecoder[F, A]
Attributes
protected
Definition Classes
Service
implicit def jsonEncoder[A](implicit arg0: Encoder[A]): EntityEncoder[F, A]
Attributes
protected
Definition Classes
Service
val jsonPrinter: Printer
Attributes
protected
Definition Classes
Service
def list(query: Query, extraHeaders: Header*): Stream[F, WithId[Model]]
def list(extraHeaders: Header*): Stream[F, WithId[Model]]
def list[R](wrappedAt: String, uri: Uri, query: Query, extraHeaders: Header*)(implicit arg0: Decoder[R]): Stream[F, R]
Invokes a GET request on the specified uri, expecting the returned json to be paginated.
Invokes a GET request on the specified uri, expecting the returned json to be paginated. Automatically fetches more pages if more elements of the stream are consumed.
R
the type of the elements returned.
wrappedAt
the Json object field where R will be decoded from.
uri
the uri to which the request will be made.
query
extra query parameters to pass in every request. These are separated from Uri because this method will need to append query params for the next page/marker/offset.
extraHeaders
extra headers to be used. The authToken header is always added.
Attributes
protected
Definition Classes
Service
val name: String
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@native() @HotSpotIntrinsicCandidate()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native() @HotSpotIntrinsicCandidate()
def patch[V, R](wrappedAt: Option[String], value: V, uri: Uri, extraHeaders: Header*)(implicit arg0: Encoder[V], arg1: Decoder[R]): F[R]
Attributes
protected
Definition Classes
Service
val pluralName: String
def post[V, R](wrappedAt: Option[String], value: V, uri: Uri, extraHeaders: Header*)(implicit arg0: Encoder[V], arg1: Decoder[R]): F[R]
Attributes
protected
Definition Classes
Service
def put[V, R](wrappedAt: Option[String], value: V, uri: Uri, extraHeaders: Header*)(implicit arg0: Encoder[V], arg1: Decoder[R]): F[R]
Attributes
protected
Definition Classes
Service
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
AnyRef → Any
def unwrapped[R](at: Option[String] = None)(implicit decoder: Decoder[R]): EntityDecoder[F, R]
Creates an EntityDecoder which will decode the response from Json.
Creates an EntityDecoder which will decode the response from Json. When at is None R will be decoded directly from the Json root (the normal implementation for most Json REST APIs). Example:
```
{
  "id": "e4d02828-9cac-4765-bf7f-7e210dac7aba",
  "zones": 500,
  "zone_recordsets": 500
}
```
When at is a Some(x) R will be decoded from the Json object located in the field x. For R to be correctly parsed in this example at should be Some("quota"):
```
{
  "quota": {
    "id": "e4d02828-9cac-4765-bf7f-7e210dac7aba",
    "zones": 500,
    "zone_recordsets": 500
  }
}
```
at
whether to decode R at the Json root, or at the field at.
decoder
the circe decoder capable of converting Json to an R.
Attributes
protected
Definition Classes
Service
def update(id: String, value: Update, extraHeaders: Header*): F[WithId[Model]]
val uri: Uri
implicit val void: EntityDecoder[F, Unit]
Attributes
protected
Definition Classes
Service
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 wrapped[R](at: Option[String] = None)(implicit encoder: Encoder[R]): EntityEncoder[F, R]
Creates an EntityEncoder which will encode R to a Json.
Creates an EntityEncoder which will encode R to a Json. When at is None R will be encoded directly (the normal implementation for most Json REST APIs). Example:
```
{
  "id": "e4d02828-9cac-4765-bf7f-7e210dac7aba",
  "zones": 500,
  "zone_recordsets": 500
}
```
When at is a Some(x) R will be encoded inside a Json object with a single field named x. In this example at was set to Some("quota"):
```
{
  "quota": {
    "id": "e4d02828-9cac-4765-bf7f-7e210dac7aba",
    "zones": 500,
    "zone_recordsets": 500
  }
}
```
at
whether to encode R at the Json root, or at the field at.
encoder
the circe encoder capable of converting an R to Json.
Attributes
protected
Definition Classes
Service
val wrappedAt: Option[String]
Attributes
protected

Inherited from Service[F]

Value Members

implicit val F: Sync[F]
Attributes
protected
Definition Classes
Service
val authToken: Header
Attributes
protected
Definition Classes
Service
implicit val client: Client[F]
Attributes
protected
Definition Classes
Service
def delete(uri: Uri, extraHeaders: Header*): F[Unit]
An idempotent delete.
An idempotent delete. If NotFound or Gone are returned this method will succeed.
uri
the uri to which the request will be made.
extraHeaders
extra headers to be used. The authToken header is always added.
Attributes
protected
Definition Classes
Service
val dsl: Http4sClientDsl[F]
Attributes
protected
Definition Classes
Service
def expect[R](wrappedAt: Option[String], method: Method with PermitsBody, uri: Uri, extraHeaders: Header*)(implicit arg0: Decoder[R]): F[R]
Invokes method on the specified uri without any body.
Invokes method on the specified uri without any body. The response will be parsed to an R.
wrappedAt
whether to decode R at the Json root, or at the field at.
method
the method to use, eg: GET, POST, etc.
uri
the uri to which the request will be made.
extraHeaders
extra headers to be used. The authToken header is always added.
Attributes
protected
Definition Classes
Service
def expect[B, R](wrappedAt: Option[String], method: Method with PermitsBody, value: B, uri: Uri, extraHeaders: Header*)(implicit arg0: Encoder[B], arg1: Decoder[R]): F[R]
Invokes method on the specified uri passing as body value.
Invokes method on the specified uri passing as body value. The response will be parsed to an R.
wrappedAt
whether to encode B and decode R at the Json root, or at the field at.
method
the method to use, eg: GET, POST, etc.
value
the value to send in the body. This value will be json encoded using wrapped.
uri
the uri to which the request will be made.
extraHeaders
extra headers to be used. The authToken header is always added.
Attributes
protected
Definition Classes
Service
def expectUnwrapped[R](wrappedAt: Option[String], request: F[Request[F]])(implicit arg0: Decoder[R]): F[R]
Submits request and decodes the response to a R on success.
Submits request and decodes the response to a R on success.
wrappedAt
whether to decode R at the Json root, or at the field at.
request
the request to execute.
Attributes
protected
Definition Classes
Service
def get[R](wrappedAt: Option[String], uri: Uri, extraHeaders: Header*)(implicit arg0: Decoder[R]): F[R]
Attributes
protected
Definition Classes
Service
implicit def jsonDecoder[A](implicit arg0: Decoder[A]): EntityDecoder[F, A]
Attributes
protected
Definition Classes
Service
implicit def jsonEncoder[A](implicit arg0: Encoder[A]): EntityEncoder[F, A]
Attributes
protected
Definition Classes
Service
val jsonPrinter: Printer
Attributes
protected
Definition Classes
Service
def list[R](wrappedAt: String, uri: Uri, query: Query, extraHeaders: Header*)(implicit arg0: Decoder[R]): Stream[F, R]
Invokes a GET request on the specified uri, expecting the returned json to be paginated.
Invokes a GET request on the specified uri, expecting the returned json to be paginated. Automatically fetches more pages if more elements of the stream are consumed.
R
the type of the elements returned.
wrappedAt
the Json object field where R will be decoded from.
uri
the uri to which the request will be made.
query
extra query parameters to pass in every request. These are separated from Uri because this method will need to append query params for the next page/marker/offset.
extraHeaders
extra headers to be used. The authToken header is always added.
Attributes
protected
Definition Classes
Service
def patch[V, R](wrappedAt: Option[String], value: V, uri: Uri, extraHeaders: Header*)(implicit arg0: Encoder[V], arg1: Decoder[R]): F[R]
Attributes
protected
Definition Classes
Service
def post[V, R](wrappedAt: Option[String], value: V, uri: Uri, extraHeaders: Header*)(implicit arg0: Encoder[V], arg1: Decoder[R]): F[R]
Attributes
protected
Definition Classes
Service
def put[V, R](wrappedAt: Option[String], value: V, uri: Uri, extraHeaders: Header*)(implicit arg0: Encoder[V], arg1: Decoder[R]): F[R]
Attributes
protected
Definition Classes
Service
def unwrapped[R](at: Option[String] = None)(implicit decoder: Decoder[R]): EntityDecoder[F, R]
Creates an EntityDecoder which will decode the response from Json.
Creates an EntityDecoder which will decode the response from Json. When at is None R will be decoded directly from the Json root (the normal implementation for most Json REST APIs). Example:
```
{
  "id": "e4d02828-9cac-4765-bf7f-7e210dac7aba",
  "zones": 500,
  "zone_recordsets": 500
}
```
When at is a Some(x) R will be decoded from the Json object located in the field x. For R to be correctly parsed in this example at should be Some("quota"):
```
{
  "quota": {
    "id": "e4d02828-9cac-4765-bf7f-7e210dac7aba",
    "zones": 500,
    "zone_recordsets": 500
  }
}
```
at
whether to decode R at the Json root, or at the field at.
decoder
the circe decoder capable of converting Json to an R.
Attributes
protected
Definition Classes
Service
implicit val void: EntityDecoder[F, Unit]
Attributes
protected
Definition Classes
Service
def wrapped[R](at: Option[String] = None)(implicit encoder: Encoder[R]): EntityEncoder[F, R]
Creates an EntityEncoder which will encode R to a Json.
Creates an EntityEncoder which will encode R to a Json. When at is None R will be encoded directly (the normal implementation for most Json REST APIs). Example:
```
{
  "id": "e4d02828-9cac-4765-bf7f-7e210dac7aba",
  "zones": 500,
  "zone_recordsets": 500
}
```
When at is a Some(x) R will be encoded inside a Json object with a single field named x. In this example at was set to Some("quota"):
```
{
  "quota": {
    "id": "e4d02828-9cac-4765-bf7f-7e210dac7aba",
    "zones": 500,
    "zone_recordsets": 500
  }
}
```
at
whether to encode R at the Json root, or at the field at.
encoder
the circe encoder capable of converting an R to Json.
Attributes
protected
Definition Classes
Service

Inherited from AnyRef

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
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
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
@native() @HotSpotIntrinsicCandidate()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native() @HotSpotIntrinsicCandidate()
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@native() @HotSpotIntrinsicCandidate()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native() @HotSpotIntrinsicCandidate()
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
AnyRef → Any
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 finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable]) @Deprecated
Deprecated

Inherited from Any

Value Members

final def asInstanceOf[T0]: T0
Definition Classes
Any
final def isInstanceOf[T0]: Boolean
Definition Classes
Any

Inherited by implicit conversion StringFormat fromCrudService[F, Model, Create, Update] to StringFormat[CrudService[F, Model, Create, Update]]

Value Members

def formatted(fmtstr: String): String
Implicit
This member is added by an implicit conversion from CrudService[F, Model, Create, Update] toStringFormat[CrudService[F, Model, Create, Update]] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()

Inherited by implicit conversion Ensuring fromCrudService[F, Model, Create, Update] to Ensuring[CrudService[F, Model, Create, Update]]

Value Members

def ensuring(cond: (CrudService[F, Model, Create, Update]) => Boolean, msg: => Any): CrudService[F, Model, Create, Update]
Implicit
This member is added by an implicit conversion from CrudService[F, Model, Create, Update] toEnsuring[CrudService[F, Model, Create, Update]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (CrudService[F, Model, Create, Update]) => Boolean): CrudService[F, Model, Create, Update]
Implicit
This member is added by an implicit conversion from CrudService[F, Model, Create, Update] toEnsuring[CrudService[F, Model, Create, Update]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: => Any): CrudService[F, Model, Create, Update]
Implicit
This member is added by an implicit conversion from CrudService[F, Model, Create, Update] toEnsuring[CrudService[F, Model, Create, Update]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): CrudService[F, Model, Create, Update]
Implicit
This member is added by an implicit conversion from CrudService[F, Model, Create, Update] toEnsuring[CrudService[F, Model, Create, Update]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring

Inherited by implicit conversion ArrowAssoc fromCrudService[F, Model, Create, Update] to ArrowAssoc[CrudService[F, Model, Create, Update]]

Value Members

def ->[B](y: B): (CrudService[F, Model, Create, Update], B)
Implicit
This member is added by an implicit conversion from CrudService[F, Model, Create, Update] toArrowAssoc[CrudService[F, Model, Create, Update]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
def →[B](y: B): (CrudService[F, Model, Create, Update], B)
Implicit
This member is added by an implicit conversion from CrudService[F, Model, Create, Update] toArrowAssoc[CrudService[F, Model, Create, Update]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Ungrouped

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##: Int
Definition Classes
AnyRef → Any
def ->[B](y: B): (CrudService[F, Model, Create, Update], B)
Implicit
This member is added by an implicit conversion from CrudService[F, Model, Create, Update] toArrowAssoc[CrudService[F, Model, Create, Update]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@inline()
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
implicit val F: Sync[F]
Attributes
protected
Definition Classes
Service
final def asInstanceOf[T0]: T0
Definition Classes
Any
val authToken: Header
Attributes
protected
Definition Classes
Service
implicit val client: Client[F]
Attributes
protected
Definition Classes
Service
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
def create(value: Create, extraHeaders: Header*): F[WithId[Model]]
def createHandleConflict(value: Create, extraHeaders: Header*)(onConflict: F[WithId[Model]]): F[WithId[Model]]
Attributes
protected
def delete(id: String, extraHeaders: Header*): F[Unit]
def delete(value: WithId[Model], extraHeaders: Header*): F[Unit]
def delete(uri: Uri, extraHeaders: Header*): F[Unit]
An idempotent delete.
An idempotent delete. If NotFound or Gone are returned this method will succeed.
uri
the uri to which the request will be made.
extraHeaders
extra headers to be used. The authToken header is always added.
Attributes
protected
Definition Classes
Service
val dsl: Http4sClientDsl[F]
Attributes
protected
Definition Classes
Service
def ensuring(cond: (CrudService[F, Model, Create, Update]) => Boolean, msg: => Any): CrudService[F, Model, Create, Update]
Implicit
This member is added by an implicit conversion from CrudService[F, Model, Create, Update] toEnsuring[CrudService[F, Model, Create, Update]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: (CrudService[F, Model, Create, Update]) => Boolean): CrudService[F, Model, Create, Update]
Implicit
This member is added by an implicit conversion from CrudService[F, Model, Create, Update] toEnsuring[CrudService[F, Model, Create, Update]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean, msg: => Any): CrudService[F, Model, Create, Update]
Implicit
This member is added by an implicit conversion from CrudService[F, Model, Create, Update] toEnsuring[CrudService[F, Model, Create, Update]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
def ensuring(cond: Boolean): CrudService[F, Model, Create, Update]
Implicit
This member is added by an implicit conversion from CrudService[F, Model, Create, Update] toEnsuring[CrudService[F, Model, Create, Update]] performed by method Ensuring in scala.Predef.
Definition Classes
Ensuring
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
def expect[R](wrappedAt: Option[String], method: Method with PermitsBody, uri: Uri, extraHeaders: Header*)(implicit arg0: Decoder[R]): F[R]
Invokes method on the specified uri without any body.
Invokes method on the specified uri without any body. The response will be parsed to an R.
wrappedAt
whether to decode R at the Json root, or at the field at.
method
the method to use, eg: GET, POST, etc.
uri
the uri to which the request will be made.
extraHeaders
extra headers to be used. The authToken header is always added.
Attributes
protected
Definition Classes
Service
def expect[B, R](wrappedAt: Option[String], method: Method with PermitsBody, value: B, uri: Uri, extraHeaders: Header*)(implicit arg0: Encoder[B], arg1: Decoder[R]): F[R]
Invokes method on the specified uri passing as body value.
Invokes method on the specified uri passing as body value. The response will be parsed to an R.
wrappedAt
whether to encode B and decode R at the Json root, or at the field at.
method
the method to use, eg: GET, POST, etc.
value
the value to send in the body. This value will be json encoded using wrapped.
uri
the uri to which the request will be made.
extraHeaders
extra headers to be used. The authToken header is always added.
Attributes
protected
Definition Classes
Service
def expectUnwrapped[R](wrappedAt: Option[String], request: F[Request[F]])(implicit arg0: Decoder[R]): F[R]
Submits request and decodes the response to a R on success.
Submits request and decodes the response to a R on success.
wrappedAt
whether to decode R at the Json root, or at the field at.
request
the request to execute.
Attributes
protected
Definition Classes
Service
def formatted(fmtstr: String): String
Implicit
This member is added by an implicit conversion from CrudService[F, Model, Create, Update] toStringFormat[CrudService[F, Model, Create, Update]] performed by method StringFormat in scala.Predef.
Definition Classes
StringFormat
Annotations
@inline()
def get(id: String, extraHeaders: Header*): F[WithId[Model]]
def get[R](wrappedAt: Option[String], uri: Uri, extraHeaders: Header*)(implicit arg0: Decoder[R]): F[R]
Attributes
protected
Definition Classes
Service
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native() @HotSpotIntrinsicCandidate()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native() @HotSpotIntrinsicCandidate()
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
implicit def jsonDecoder[A](implicit arg0: Decoder[A]): EntityDecoder[F, A]
Attributes
protected
Definition Classes
Service
implicit def jsonEncoder[A](implicit arg0: Encoder[A]): EntityEncoder[F, A]
Attributes
protected
Definition Classes
Service
val jsonPrinter: Printer
Attributes
protected
Definition Classes
Service
def list(query: Query, extraHeaders: Header*): Stream[F, WithId[Model]]
def list(extraHeaders: Header*): Stream[F, WithId[Model]]
def list[R](wrappedAt: String, uri: Uri, query: Query, extraHeaders: Header*)(implicit arg0: Decoder[R]): Stream[F, R]
Invokes a GET request on the specified uri, expecting the returned json to be paginated.
Invokes a GET request on the specified uri, expecting the returned json to be paginated. Automatically fetches more pages if more elements of the stream are consumed.
R
the type of the elements returned.
wrappedAt
the Json object field where R will be decoded from.
uri
the uri to which the request will be made.
query
extra query parameters to pass in every request. These are separated from Uri because this method will need to append query params for the next page/marker/offset.
extraHeaders
extra headers to be used. The authToken header is always added.
Attributes
protected
Definition Classes
Service
val name: String
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@native() @HotSpotIntrinsicCandidate()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native() @HotSpotIntrinsicCandidate()
def patch[V, R](wrappedAt: Option[String], value: V, uri: Uri, extraHeaders: Header*)(implicit arg0: Encoder[V], arg1: Decoder[R]): F[R]
Attributes
protected
Definition Classes
Service
val pluralName: String
def post[V, R](wrappedAt: Option[String], value: V, uri: Uri, extraHeaders: Header*)(implicit arg0: Encoder[V], arg1: Decoder[R]): F[R]
Attributes
protected
Definition Classes
Service
def put[V, R](wrappedAt: Option[String], value: V, uri: Uri, extraHeaders: Header*)(implicit arg0: Encoder[V], arg1: Decoder[R]): F[R]
Attributes
protected
Definition Classes
Service
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
AnyRef → Any
def unwrapped[R](at: Option[String] = None)(implicit decoder: Decoder[R]): EntityDecoder[F, R]
Creates an EntityDecoder which will decode the response from Json.
Creates an EntityDecoder which will decode the response from Json. When at is None R will be decoded directly from the Json root (the normal implementation for most Json REST APIs). Example:
```
{
  "id": "e4d02828-9cac-4765-bf7f-7e210dac7aba",
  "zones": 500,
  "zone_recordsets": 500
}
```
When at is a Some(x) R will be decoded from the Json object located in the field x. For R to be correctly parsed in this example at should be Some("quota"):
```
{
  "quota": {
    "id": "e4d02828-9cac-4765-bf7f-7e210dac7aba",
    "zones": 500,
    "zone_recordsets": 500
  }
}
```
at
whether to decode R at the Json root, or at the field at.
decoder
the circe decoder capable of converting Json to an R.
Attributes
protected
Definition Classes
Service
def update(id: String, value: Update, extraHeaders: Header*): F[WithId[Model]]
val uri: Uri
implicit val void: EntityDecoder[F, Unit]
Attributes
protected
Definition Classes
Service
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 wrapped[R](at: Option[String] = None)(implicit encoder: Encoder[R]): EntityEncoder[F, R]
Creates an EntityEncoder which will encode R to a Json.
Creates an EntityEncoder which will encode R to a Json. When at is None R will be encoded directly (the normal implementation for most Json REST APIs). Example:
```
{
  "id": "e4d02828-9cac-4765-bf7f-7e210dac7aba",
  "zones": 500,
  "zone_recordsets": 500
}
```
When at is a Some(x) R will be encoded inside a Json object with a single field named x. In this example at was set to Some("quota"):
```
{
  "quota": {
    "id": "e4d02828-9cac-4765-bf7f-7e210dac7aba",
    "zones": 500,
    "zone_recordsets": 500
  }
}
```
at
whether to encode R at the Json root, or at the field at.
encoder
the circe encoder capable of converting an R to Json.
Attributes
protected
Definition Classes
Service
val wrappedAt: Option[String]
Attributes
protected
def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable]) @Deprecated
Deprecated
def →[B](y: B): (CrudService[F, Model, Create, Update], B)
Implicit
This member is added by an implicit conversion from CrudService[F, Model, Create, Update] toArrowAssoc[CrudService[F, Model, Create, Update]] performed by method ArrowAssoc in scala.Predef.
Definition Classes
ArrowAssoc
Annotations
@deprecated
Deprecated
(Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Packages

CrudService

abstract class CrudService[F[_], Model, Create, Update] extends Service[F]

Instance Constructors

Value Members

Deprecated Value Members

Inherited from Service[F]

Value Members

Inherited from AnyRef

Value Members

Inherited from Any

Value Members

Inherited by implicit conversion StringFormat fromCrudService[F, Model, Create, Update] to StringFormat[CrudService[F, Model, Create, Update]]

Value Members

Inherited by implicit conversion Ensuring fromCrudService[F, Model, Create, Update] to Ensuring[CrudService[F, Model, Create, Update]]

Value Members

Inherited by implicit conversion ArrowAssoc fromCrudService[F, Model, Create, Update] to ArrowAssoc[CrudService[F, Model, Create, Update]]

Value Members

Ungrouped

Packages

CrudService

abstract class CrudService[F[_], Model, Create, Update] extends Service[F]

Instance Constructors

Value Members

Deprecated Value Members

Inherited from Service[F]

Value Members

Inherited from AnyRef

Value Members

Inherited from Any

Value Members

Inherited by implicit conversion StringFormat fromCrudService[F, Model, Create, Update] to StringFormat[CrudService[F, Model, Create, Update]]

Value Members

Inherited by implicit conversion Ensuring fromCrudService[F, Model, Create, Update] to Ensuring[CrudService[F, Model, Create, Update]]

Value Members

Inherited by implicit conversion ArrowAssoc fromCrudService[F, Model, Create, Update] to ArrowAssoc[CrudService[F, Model, Create, Update]]

Value Members

Ungrouped

CrudService