final case class HttpBody(contentType: String = "", data: ByteString = ..., extensions: Seq[Any] = _root_.scala.Seq.empty, unknownFields: UnknownFieldSet = ...) 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()
Linear Supertypes
Product, Equals, Updatable[HttpBody], GeneratedMessage, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. HttpBody
  2. Product
  3. Equals
  4. Updatable
  5. GeneratedMessage
  6. Serializable
  7. Serializable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

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

    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. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addAllExtensions(__vs: Iterable[Any]): HttpBody
  5. def addExtensions(__vs: Any*): HttpBody
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clearExtensions: HttpBody
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  9. def companion: HttpBody.type
    Definition Classes
    HttpBody → GeneratedMessage
  10. val contentType: String
  11. val data: ByteString
  12. def discardUnknownFields: HttpBody
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. val extensions: Seq[Any]
  15. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def getField(__field: FieldDescriptor): PValue
    Definition Classes
    HttpBody → GeneratedMessage
  18. def getFieldByNumber(__fieldNumber: Int): Any
    Definition Classes
    HttpBody → GeneratedMessage
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  23. def serializedSize: Int
    Definition Classes
    HttpBody → GeneratedMessage
  24. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  25. final def toByteArray: Array[Byte]
    Definition Classes
    GeneratedMessage
  26. final def toByteString: ByteString
    Definition Classes
    GeneratedMessage
  27. final def toPMessage: PMessage
    Definition Classes
    GeneratedMessage
  28. def toProtoString: String
    Definition Classes
    HttpBody → GeneratedMessage
  29. val unknownFields: UnknownFieldSet
  30. def update(ms: (Lens[HttpBody, HttpBody]) ⇒ Mutation[HttpBody]*): HttpBody
    Definition Classes
    Updatable
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  34. def withContentType(__v: String): HttpBody
  35. def withData(__v: ByteString): HttpBody
  36. def withExtensions(__v: Seq[Any]): HttpBody
  37. def withUnknownFields(__v: UnknownFieldSet): HttpBody
  38. final def writeDelimitedTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage
  39. def writeTo(_output__: CodedOutputStream): Unit
    Definition Classes
    HttpBody → GeneratedMessage
  40. final def writeTo(output: OutputStream): Unit
    Definition Classes
    GeneratedMessage

Inherited from Product

Inherited from Equals

Inherited from Updatable[HttpBody]

Inherited from GeneratedMessage

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped