SecurityGroupRules
Attributes
- Source
- SecurityGroupRules.scala
- Graph
-
- Supertypes
Members list
Type members
Inherited types
Attributes
- Inherited from:
- Service
- Source
- Service.scala
Value members
Concrete methods
A sort of idempotent create. If a Conflict is received and the existing rule already has the same settings the existing rule will be returned. Otherwise F
will have an error.
A sort of idempotent create. If a Conflict is received and the existing rule already has the same settings the existing rule will be returned. Otherwise F
will have an error.
Its impossible to implement an idempotent create because the API does not expose an update endpoint.
Value parameters
- create
-
the create settings.
- extraHeaders
-
extra headers to be used. The
authToken
header is always added.
Attributes
- Source
- SecurityGroupRules.scala
Inherited methods
Gets the domainModel with the specified id
, assuming it exists.
Gets the domainModel with the specified id
, assuming it exists.
Value parameters
- extraHeaders
-
extra headers to pass when making the request. The
authToken
header is always added. - id
-
the id of the domainModel to get. Usually a random UUID.
Attributes
- Returns
-
the domainModel with the given
id
. If none exists F will contain an error. - Inherited from:
- ReadOperations
- Source
- ReadOperations.scala
Allows a simpler syntax to create domainModel(s). For example instead of:
Allows a simpler syntax to create domainModel(s). For example instead of:
keystone.projects.create(Project.Create(name, domainId = Some(usersDomain.id)))
We can do:
keystone.projects(Project.Create(name, domainId = Some(usersDomain.id)))
Attributes
- Inherited from:
- CreateNonIdempotentOperations
- Source
- CreateNonIdempotentOperations.scala
Creates a new domainModel with the given create
values.
Creates a new domainModel with the given create
values.
Value parameters
- create
-
the values to use in the create.
- extraHeaders
-
extra headers to pass when making the request. The
authToken
header is always added.
Attributes
- Returns
-
the created domainModel
- Inherited from:
- CreateNonIdempotentOperations
- Source
- CreateNonIdempotentOperations.scala
Attributes
- Inherited from:
- Service
- Source
- Service.scala
Deletes the domainModel with the given id
.
Deletes the domainModel with the given id
.
Value parameters
- extraHeaders
-
extra headers to pass when making the request. The
authToken
header is always added. - id
-
the id of the domainModel to delete. Usually a random UUID.
Attributes
- Inherited from:
- DeleteOperations
- Source
- DeleteOperations.scala
Deletes the given domainModel.
Deletes the given domainModel.
Value parameters
- extraHeaders
-
extra headers to pass when making the request. The
authToken
header is always added. - model
-
the domainModel to delete.
Attributes
- Inherited from:
- DeleteOperations
- Source
- DeleteOperations.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
- Inherited from:
- Service
- 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
- Inherited from:
- Service
- 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
- Inherited from:
- Service
- 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
- Inherited from:
- Service
- 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
- Inherited from:
- Service
- 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
- Inherited from:
- Service
- 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
- Inherited from:
- Service
- Source
- Service.scala
Gets the domainModel with the specified id
.
Gets the domainModel with the specified id
.
Value parameters
- extraHeaders
-
extra headers to pass when making the request. The
authToken
header is always added. - id
-
the id of the domainModel to get. Usually a random UUID.
Attributes
- Returns
-
a Some with the domainModel if it exists. A None otherwise.
- Inherited from:
- ReadOperations
- Source
- ReadOperations.scala
Attributes
- Inherited from:
- Service
- Source
- Service.scala
Attributes
- Inherited from:
- Service
- Source
- Service.scala
Lists all domainModel(s) using the specified query
. If the response is paginated all elements will be returned, be careful as this might take a lot of time and memory.
Lists all domainModel(s) using the specified query
. If the response is paginated all elements will be returned, be careful as this might take a lot of time and memory.
Value parameters
- extraHeaders
-
extra headers to pass when making the request. The
authToken
header is always added. - query
-
the query to use when performing the request.
Attributes
- Inherited from:
- ListOperations
- Source
- ListOperations.scala
Lists all domainModel(s) using the specified pairs
as the query params. If the response is paginated all elements will be returned, be careful as this might take a lot of time and memory.
Lists all domainModel(s) using the specified pairs
as the query params. If the response is paginated all elements will be returned, be careful as this might take a lot of time and memory.
Value parameters
- pairs
-
the pairs of Strings that will be used as the query params.
Attributes
- Inherited from:
- ListOperations
- Source
- ListOperations.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
- Inherited from:
- Service
- Source
- Service.scala
Attributes
- Inherited from:
- Service
- Source
- Service.scala
Attributes
- Inherited from:
- Service
- Source
- Service.scala
Attributes
- Inherited from:
- Service
- Source
- Service.scala
Attributes
- Inherited from:
- Service
- Source
- Service.scala
Attributes
- Inherited from:
- Service
- Source
- Service.scala
Streams domainModel(s) using the specified query
. Automatically fetches more pages if more elements of the stream are consumed.
Streams domainModel(s) using the specified query
. Automatically fetches more pages if more elements of the stream are consumed.
Value parameters
- extraHeaders
-
extra headers to pass when making the request. The
authToken
header is always added. - query
-
the query to use when performing the request.
Attributes
- Inherited from:
- ListOperations
- Source
- ListOperations.scala
Streams domainModel(s) using the specified query
. Automatically fetches more pages if more elements of the stream are consumed.
Streams domainModel(s) using the specified query
. Automatically fetches more pages if more elements of the stream are consumed.
Value parameters
- pairs
-
the pairs of Strings that will be used as the query params.
Attributes
- Inherited from:
- ListOperations
- Source
- ListOperations.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
- Inherited from:
- { valnext:Option[Uri]=links.collectFirst[Uri](((x$1:Link)=>(x$1:@unchecked)match{ caseLink("next",uri)=> (`uri₂`:Uri) })) Tuple2.apply[List[Link],Option[Uri]](links,next) })).flatMap[DecodingFailure,Tuple2[Option[Uri],List[R]]](((`x$1₂`:Tuple2[List[Link],Option[Uri]])=>(`x$1₂`:@unchecked)match{ caseTuple2(links,next)=> c.downField(wrappedAt).as[List[R]](decodeList[R](evidence$24)).map[Tuple2[Option[Uri],List[R]]](((objectList:List[R])=>Tuple2.apply[Option[Uri],List[R]](`next₂`,objectList))) }))) Stream.unfoldChunkEval[F,Option[Uri],R](Some.apply[Uri](uri))(((`x$1₃`:Option[Uri])=>`x$1₃`match{ caseSome(uri)=> toFunctorOps[F,Tuple2[Option[Uri],List[R]]](client.expect[Tuple2[Option[Uri],List[R]]](Service.this.dsl.http4sClientSyntaxMethod(GET).apply(`uri₃`,extraHeaders.+:[ToRaw](Service.this.subjectTokenHeader):_*))(Service.this.jsonDecoder[Tuple2[Option[Uri],List[R]]](paginatedDecoder)))(F).map[Option[Tuple2[Chunk[R],Option[Uri]]]](((`x$1₄`:Tuple2[Option[Uri],List[R]])=>`x$1₄`match{ caseTuple2(next,entries)=> Some.apply[Tuple2[Chunk[R],Option[Uri]]](Tuple2.apply[Chunk[R],Option[Uri]](Chunk.iterable[R](entries),`next₃`)) })) caseNone=> F.pure[Option[Tuple2[Chunk[R],Option[Uri]]]](None) })) }">Service
- 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
- Inherited from:
- Service
- 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
- Inherited from:
- Service
- Source
- Service.scala
Inherited fields
Attributes
- Inherited from:
- Service
- Source
- Service.scala
Attributes
- Inherited from:
- Service
- Source
- Service.scala
Attributes
- Inherited from:
- Service
- Source
- Service.scala
Attributes
- Inherited from:
- Service
- Source
- Service.scala
Attributes
- Inherited from:
- Service
- Source
- Service.scala
The baseUri
with the pluraName
appended as an extra path element.
The baseUri
with the pluraName
appended as an extra path element.
Attributes
- Inherited from:
- Service
- Source
- Service.scala
Givens
Implicits
Inherited implicits
Attributes
- Inherited from:
- Service
- Source
- Service.scala
Attributes
- Inherited from:
- Service
- Source
- Service.scala
Attributes
- Inherited from:
- Service
- Source
- Service.scala
Attributes
- Inherited from:
- Service
- Source
- Service.scala
Attributes
- Inherited from:
- Service
- Source
- Service.scala