case class ApiRequest[U](executor: ApiRequestExecutor, operationId: String, method: HttpMethod, path: String, contentType: String, accept: String, apiConfig: ApiConfiguration, metricName: MetricName = ..., fullURL: Option[String] = None, baseURL: Option[String] = None, accessType: AccessType = AccessType.Unauthenticated, successResponseCodes: Map[Int, ClassTag[_]] = Map.empty, errorResponseCodes: Map[Int, ClassTag[_]] = Map.empty, errorDefaultResponse: ClassTag[_] = ClassTag.Null, bodyParam: Option[DataPublisher] = None, formParams: Map[String, Any] = Map.empty, pathParams: Map[String, Any] = Map.empty, queryParams: Map[String, Any] = Map.empty, headerParams: Map[String, Any] = Map.empty) extends Product with Serializable
- Self Type
- ApiRequest[U]
- Alphabetic
- By Inheritance
- ApiRequest
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new ApiRequest(executor: ApiRequestExecutor, operationId: String, method: HttpMethod, path: String, contentType: String, accept: String, apiConfig: ApiConfiguration, metricName: MetricName = ..., fullURL: Option[String] = None, baseURL: Option[String] = None, accessType: AccessType = AccessType.Unauthenticated, successResponseCodes: Map[Int, ClassTag[_]] = Map.empty, errorResponseCodes: Map[Int, ClassTag[_]] = Map.empty, errorDefaultResponse: ClassTag[_] = ClassTag.Null, bodyParam: Option[DataPublisher] = None, formParams: Map[String, Any] = Map.empty, pathParams: Map[String, Any] = Map.empty, queryParams: Map[String, Any] = Map.empty, headerParams: Map[String, Any] = Map.empty)
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
- val accept: String
- val accessType: AccessType
- val apiConfig: ApiConfiguration
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- val baseURL: Option[String]
- val bodyParam: Option[DataPublisher]
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
- val contentType: String
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val errorDefaultResponse: ClassTag[_]
- val errorResponseCodes: Map[Int, ClassTag[_]]
- def execute(): Future[HttpResponse]
- def executeAndHandle[T](handler: PartialFunction[ResponseStatusHandler, Future[T]]): Future[T]
-
def
executeTo[T]()(implicit deserializer: BodyDeserializer[T]): Future[T]
Execute request and deserialize response to the specified type
Execute request and deserialize response to the specified type
- T
The custom type which the response will be deserialized to
- deserializer
Deserializer for predefined response type. For custom types implement your own deserializer. To deserialize to the predefined types please use
executeToEntity
- def executeToBytes(): Future[Array[Byte]]
-
def
executeToEntity()(implicit deserializer: BodyDeserializer[U]): Future[U]
Execute request and deserialize response to the predefined response type
Execute request and deserialize response to the predefined response type
- deserializer
Deserializer for predefined response type. To provide this implicit, add next import to your file:
import com.here.platform.data.client.base.generated.codecs.JsonSupport._
- def executeToInputStream(): Future[InputStream]
- def executeToStatusCode(): Future[Int]
- val executor: ApiRequestExecutor
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
- val formParams: Map[String, Any]
- val fullURL: Option[String]
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def handle[T](handler: PartialFunction[ResponseStatusHandler, Future[T]]): T
- val headerParams: Map[String, Any]
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val method: HttpMethod
- val metricName: MetricName
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val operationId: String
- val path: String
- val pathParams: Map[String, Any]
- val queryParams: Map[String, Any]
- val successResponseCodes: Map[Int, ClassTag[_]]
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
to[T]()(implicit deserializer: BodyDeserializer[T]): T
Execute request and deserialize response to the specified type
Execute request and deserialize response to the specified type
- T
The custom type which the response will be deserialized to
- deserializer
Deserializer for predefined response type. For custom types implement your own deserializer. To deserialize to the predefined types please use
toEntity
- def toBytes: Array[Byte]
-
def
toEntity()(implicit deserializer: BodyDeserializer[U]): U
Execute request and deserialize response to the predefined response type
Execute request and deserialize response to the predefined response type
- deserializer
Deserializer for predefined response type. To provide this implicit, add next import to your file:
import com.here.platform.data.client.base.generated.codecs.JsonSupport._
- def toHttpRequest: HttpRequest
- def toInputStream: InputStream
- def toResponse: HttpResponse
- def toStatusCode: Int
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
- def withAccessType(accessType: AccessType): ApiRequest[U]
-
def
withBody[B](body: B)(implicit serializer: BodySerializer[B]): ApiRequest[U]
Add body to the request
Add body to the request
- body
Entity, which should be used as request body
- serializer
Serializer for request type. To provide this implicit, add next import to your file:
import com.here.platform.data.client.base.generated.codecs.JsonSupport._
- def withBodyData(dataPublisher: DataPublisher): ApiRequest[U]
- def withConfig(apiConfiguration: ApiConfiguration): ApiRequest[U]
- def withDefaultErrorResponse[T]()(implicit m: ClassTag[T]): ApiRequest[U]
- def withErrorResponse[T](code: Int)(implicit m: ClassTag[T]): ApiRequest[U]
- def withFormParam(name: String, value: Any): ApiRequest[U]
- def withHeaderParam(name: String, value: Any): ApiRequest[U]
- def withMethodName(methodName: String): ApiRequest[U]
- def withPathParam(name: String, value: Any): ApiRequest[U]
- def withQueryParam(obj: Any): ApiRequest[U]
- def withQueryParam(params: Map[String, String]): ApiRequest[U]
- def withQueryParam(name: String, value: Any): ApiRequest[U]
- def withSuccessResponse[T](code: Int)(implicit m: ClassTag[T]): ApiRequest[U]
- def withoutBody(): ApiRequest[U]