Packages

final case class HttpBody(contentType: String = "", data: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, extensions: Seq[Any] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty) extends GeneratedMessage with Updatable[HttpBody] with Product with Serializable

Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page.

This message can be used both in streaming and non-streaming API methods in the request as well as the response.

It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body.

Example:

message GetResourceRequest { // A unique request id. string request_id = 1;

// The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; }

service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); }

Example with streaming methods:

service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); }

Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.

contentType

The HTTP Content-Type header value specifying the content type of the body.

data

The HTTP request/response body as raw binary.

extensions

Application specific response metadata. Must be set in the first response for streaming APIs.

Annotations
@SerialVersionUID()
Source
HttpBody.scala
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HttpBody
  2. Updatable
  3. GeneratedMessage
  4. Serializable
  5. Product
  6. Equals
  7. AnyRef
  8. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new HttpBody(contentType: String = "", data: ByteString = _root_.com.google.protobuf.ByteString.EMPTY, extensions: Seq[Any] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = _root_.scalapb.UnknownFieldSet.empty)

    contentType

    The HTTP Content-Type header value specifying the content type of the body.

    data

    The HTTP request/response body as raw binary.

    extensions

    Application specific response metadata. Must be set in the first response for streaming APIs.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from HttpBody toany2stringadd[HttpBody] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (HttpBody, B)
    Implicit
    This member is added by an implicit conversion from HttpBody toArrowAssoc[HttpBody] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def addAllExtensions(__vs: Iterable[Any]): HttpBody
  7. def addExtensions(__vs: Any*): HttpBody
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. def clearExtensions: HttpBody
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  11. def companion: HttpBody.type
    Definition Classes
    HttpBody → GeneratedMessage
  12. val contentType: String
  13. val data: ByteString
  14. def discardUnknownFields: HttpBody
  15. def ensuring(cond: (HttpBody) => Boolean, msg: => Any): HttpBody
    Implicit
    This member is added by an implicit conversion from HttpBody toEnsuring[HttpBody] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. def ensuring(cond: (HttpBody) => Boolean): HttpBody
    Implicit
    This member is added by an implicit conversion from HttpBody toEnsuring[HttpBody] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  17. def ensuring(cond: Boolean, msg: => Any): HttpBody
    Implicit
    This member is added by an implicit conversion from HttpBody toEnsuring[HttpBody] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  18. def ensuring(cond: Boolean): HttpBody
    Implicit
    This member is added by an implicit conversion from HttpBody toEnsuring[HttpBody] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  19. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. val extensions: Seq[Any]
  21. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  22. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    HttpBody → GeneratedMessage
  23. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    HttpBody → GeneratedMessage
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. def productElementNames: Iterator[String]
    Definition Classes
    Product
  29. def serializedSize: Int
    Definition Classes
    HttpBody → GeneratedMessage
  30. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  31. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  32. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  33. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  34. def toProtoString: String
    Definition Classes
    HttpBody → GeneratedMessage
  35. val unknownFields: UnknownFieldSet
  36. def update(ms: (Lens[HttpBody, HttpBody]) => Mutation[HttpBody]*): HttpBody
    Definition Classes
    Updatable
  37. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  38. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  39. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  40. def withContentType(__v: String): HttpBody
  41. def withData(__v: ByteString): HttpBody
  42. def withExtensions(__v: Seq[Any]): HttpBody
  43. def withUnknownFields(__v: UnknownFieldSet): HttpBody
  44. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  45. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    HttpBody → GeneratedMessage
  46. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Deprecated Value Members

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

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from HttpBody toStringFormat[HttpBody] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def [B](y: B): (HttpBody, B)
    Implicit
    This member is added by an implicit conversion from HttpBody toArrowAssoc[HttpBody] 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.

Inherited from Updatable[HttpBody]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromHttpBody to any2stringadd[HttpBody]

Inherited by implicit conversion StringFormat fromHttpBody to StringFormat[HttpBody]

Inherited by implicit conversion Ensuring fromHttpBody to Ensuring[HttpBody]

Inherited by implicit conversion ArrowAssoc fromHttpBody to ArrowAssoc[HttpBody]

Ungrouped