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
- Alphabetic
- By Inheritance
- HttpBody
- Updatable
- GeneratedMessage
- Serializable
- Product
- Equals
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- 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
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (HttpBody, B)
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def addAllExtensions(__vs: Iterable[Any]): HttpBody
- def addExtensions(__vs: Any*): HttpBody
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clearExtensions: HttpBody
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def companion: HttpBody.type
- Definition Classes
- HttpBody → GeneratedMessage
- val contentType: String
- val data: ByteString
- def discardUnknownFields: HttpBody
- def ensuring(cond: (HttpBody) => Boolean, msg: => Any): HttpBody
- def ensuring(cond: (HttpBody) => Boolean): HttpBody
- def ensuring(cond: Boolean, msg: => Any): HttpBody
- def ensuring(cond: Boolean): HttpBody
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val extensions: Seq[Any]
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getField(__field: FieldDescriptor): PValue
- Definition Classes
- HttpBody → GeneratedMessage
- def getFieldByNumber(__fieldNumber: Int): Any
- Definition Classes
- HttpBody → GeneratedMessage
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def serializedSize: Int
- Definition Classes
- HttpBody → GeneratedMessage
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def toByteArray: Array[Byte]
- Definition Classes
- GeneratedMessage
- final def toByteString: ByteString
- Definition Classes
- GeneratedMessage
- final def toPMessage: PMessage
- Definition Classes
- GeneratedMessage
- def toProtoString: String
- Definition Classes
- HttpBody → GeneratedMessage
- val unknownFields: UnknownFieldSet
- def update(ms: (Lens[HttpBody, HttpBody]) => Mutation[HttpBody]*): HttpBody
- Definition Classes
- Updatable
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def withContentType(__v: String): HttpBody
- def withData(__v: ByteString): HttpBody
- def withExtensions(__v: Seq[Any]): HttpBody
- def withUnknownFields(__v: UnknownFieldSet): HttpBody
- final def writeDelimitedTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage
- def writeTo(_output__: CodedOutputStream): Unit
- Definition Classes
- HttpBody → GeneratedMessage
- final def writeTo(output: OutputStream): Unit
- Definition Classes
- GeneratedMessage
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- 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 ofvalue.formatted(formatString)
, or use thef""
string interpolator. In Java 15 and later,formatted
resolves to the new method in String which has reversed parameters.
- 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.