Packages

case class ApiRequest[U](executor: ApiRequestExecutor, operationId: String, method: HttpMethod, path: String, contentType: String, accept: String, apiConfig: ApiConfiguration, metricName: MetricName = MetricName(BaseClientMetricsScala.prefix), 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]
Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ApiRequest
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ApiRequest(executor: ApiRequestExecutor, operationId: String, method: HttpMethod, path: String, contentType: String, accept: String, apiConfig: ApiConfiguration, metricName: MetricName = MetricName(BaseClientMetricsScala.prefix), 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

  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. val accept: String
  5. val accessType: AccessType
  6. val apiConfig: ApiConfiguration
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. val baseURL: Option[String]
  9. val bodyParam: Option[DataPublisher]
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  11. val contentType: String
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. val errorDefaultResponse: ClassTag[_]
  14. val errorResponseCodes: Map[Int, ClassTag[_]]
  15. def execute(): Future[HttpResponse]
  16. def executeAndHandle[T](handler: PartialFunction[ResponseStatusHandler, Future[T]]): Future[T]
  17. 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

  18. def executeToBytes(): Future[Array[Byte]]
  19. 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._

  20. def executeToInputStream(): Future[InputStream]
  21. def executeToStatusCode(): Future[Int]
  22. val executor: ApiRequestExecutor
  23. val formParams: Map[String, Any]
  24. val fullURL: Option[String]
  25. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  26. def handle[T](handler: PartialFunction[ResponseStatusHandler, Future[T]]): T
  27. val headerParams: Map[String, Any]
  28. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  29. val method: HttpMethod
  30. val metricName: MetricName
  31. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  33. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  34. val operationId: String
  35. val path: String
  36. val pathParams: Map[String, Any]
  37. def productElementNames: Iterator[String]
    Definition Classes
    Product
  38. val queryParams: Map[String, Any]
  39. val successResponseCodes: Map[Int, ClassTag[_]]
  40. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  41. 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

  42. def toBytes: Array[Byte]
  43. 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._

  44. def toHttpRequest: HttpRequest
  45. def toInputStream: InputStream
  46. def toResponse: HttpResponse
  47. def toStatusCode: Int
  48. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  49. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  50. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  51. def withAccessType(accessType: AccessType): ApiRequest[U]
  52. 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._

  53. def withBodyData(dataPublisher: DataPublisher): ApiRequest[U]
  54. def withConfig(apiConfiguration: ApiConfiguration): ApiRequest[U]
  55. def withContentType(value: String): ApiRequest[U]
  56. def withDefaultErrorResponse[T]()(implicit m: ClassTag[T]): ApiRequest[U]
  57. def withErrorResponse[T](code: Int)(implicit m: ClassTag[T]): ApiRequest[U]
  58. def withFormParam(name: String, value: Any): ApiRequest[U]
  59. def withHeaderParam(name: String, value: Any): ApiRequest[U]
  60. def withMethodName(methodName: String): ApiRequest[U]
  61. def withPathParam(name: String, value: Any): ApiRequest[U]
  62. def withQueryParam(obj: Any): ApiRequest[U]
  63. def withQueryParam(params: Map[String, String]): ApiRequest[U]
  64. def withQueryParam(name: String, value: Any): ApiRequest[U]
  65. def withSuccessResponse[T](code: Int)(implicit m: ClassTag[T]): ApiRequest[U]
  66. def withoutBody(): ApiRequest[U]

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped