Service
Attributes
- Source
- Service.scala
- Graph
-
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
class PartialCrudService[F]
Members list
Type members
Types
Attributes
- Source
- Service.scala
Value members
Concrete methods
Attributes
- Source
- Service.scala
An idempotent delete. If NotFound or Gone are returned this method will succeed.
An idempotent delete. If NotFound or Gone are returned this method will succeed.
Value parameters
- extraHeaders
-
extra headers to be used. The
authToken
header is always added. - uri
-
the uri to which the request will be made.
Attributes
- Source
- Service.scala
Invokes method
on the specified uri
passing as body value
. The response will be parsed to an R
.
Invokes method
on the specified uri
passing as body value
. The response will be parsed to an R
.
Value parameters
- extraHeaders
-
extra headers to be used. The
authToken
header is always added. - method
-
the method to use, eg: GET, POST, etc.
- uri
-
the uri to which the request will be made.
- value
-
the value to send in the body. This value will be json encoded using
wrapped
. - wrappedAt
-
whether to encode
B
and decodeR
at the Json root, or at the fieldat
.
Attributes
- Source
- Service.scala
Invokes method
on the specified uri
without any body. The response will be parsed to an R
.
Invokes method
on the specified uri
without any body. The response will be parsed to an R
.
Value parameters
- extraHeaders
-
extra headers to be used. The
authToken
header is always added. - method
-
the method to use, eg: GET, POST, etc.
- uri
-
the uri to which the request will be made.
- wrappedAt
-
whether to decode
R
at the Json root, or at the fieldat
.
Attributes
- Source
- Service.scala
Invokes method
on the specified uri
passing as body value
. The response will be parsed to an Option[R]
.
Invokes method
on the specified uri
passing as body value
. The response will be parsed to an Option[R]
.
Value parameters
- extraHeaders
-
extra headers to be used. The
authToken
header is always added. - method
-
the method to use, eg: GET, POST, etc.
- uri
-
the uri to which the request will be made.
- value
-
the value to send in the body. This value will be json encoded using
wrapped
. - wrappedAt
-
whether to encode
B
and decodeR
at the Json root, or at the fieldat
.
Attributes
- Source
- Service.scala
Invokes method
on the specified uri
without any body. The response will be parsed to an Option[R]
.
Invokes method
on the specified uri
without any body. The response will be parsed to an Option[R]
.
Value parameters
- extraHeaders
-
extra headers to be used. The
authToken
header is always added. - method
-
the method to use, eg: GET, POST, etc.
- uri
-
the uri to which the request will be made.
- wrappedAt
-
whether to decode
R
at the Json root, or at the fieldat
.
Attributes
- Source
- Service.scala
Submits request
and decodes the response to a Option[R]
on success.
Submits request
and decodes the response to a Option[R]
on success.
Value parameters
- request
-
the request to execute.
- wrappedAt
-
whether to decode
R
at the Json root, or at the fieldat
.
Attributes
- Source
- Service.scala
Submits request
and decodes the response to a R
on success.
Submits request
and decodes the response to a R
on success.
Value parameters
- request
-
the request to execute.
- wrappedAt
-
whether to decode
R
at the Json root, or at the fieldat
.
Attributes
- Source
- Service.scala
Attributes
- Source
- Service.scala
Attributes
- Source
- Service.scala
Invokes a GET request on the specified uri
, expecting to receive a list of elements. If the response is paginated all elements will be returned, be careful as this might take a lot of time and memory.
Invokes a GET request on the specified uri
, expecting to receive a list of elements. If the response is paginated all elements will be returned, be careful as this might take a lot of time and memory.
Type parameters
- R
-
the type of the elements returned.
Value parameters
- extraHeaders
-
extra headers to be used. The
authToken
header is always added. - uri
-
the uri to which the request will be made. Query params related with pagination will be overwritten after the first request.
- wrappedAt
-
the Json object field where
R
will be decoded from.
Attributes
- Source
- Service.scala
Attributes
- Source
- Service.scala
Attributes
- Source
- Service.scala
Attributes
- Source
- Service.scala
Attributes
- Source
- Service.scala
Attributes
- Source
- Service.scala
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.
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.
Type parameters
- R
-
the type of the elements returned.
Value parameters
- extraHeaders
-
extra headers to be used. The
authToken
header is always added. - uri
-
the uri to which the request will be made. Query params related with pagination will be overwritten after the first request.
- wrappedAt
-
the Json object field where
R
will be decoded from.
Attributes
- Source
- Service.scala
Creates a Decoder
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:
Creates a Decoder
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
}
}
Value parameters
- at
-
whether to decode
R
at the Json root, or at the fieldat
. - decoder
-
the circe decoder capable of converting Json to an R.
Attributes
- Source
- Service.scala
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:
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
}
}
Value parameters
- at
-
whether to encode
R
at the Json root, or at the fieldat
. - encoder
-
the circe encoder capable of converting an R to Json.
Attributes
- Source
- Service.scala
Concrete fields
Attributes
- Source
- Service.scala
Attributes
- Source
- Service.scala
Attributes
- Source
- Service.scala
Attributes
- Source
- Service.scala
Attributes
- Source
- Service.scala
The baseUri
with the pluraName
appended as an extra path element.
Implicits
Implicits
Attributes
- Source
- Service.scala
Attributes
- Source
- Service.scala
Attributes
- Source
- Service.scala
Attributes
- Source
- Service.scala
Attributes
- Source
- Service.scala