HttpBody

com.google.api.httpbody.HttpBody
See theHttpBody companion object
final case class HttpBody(contentType: String, data: ByteString, extensions: Seq[Any], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[HttpBody]

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.

Value parameters

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.

Attributes

Companion
object
Source
HttpBody.scala
Graph
Supertypes
trait Updatable[HttpBody]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def addAllExtensions(`__vs`: Iterable[Any]): HttpBody

Attributes

Source
HttpBody.scala
def addExtensions(`__vs`: Any*): HttpBody

Attributes

Source
HttpBody.scala

Attributes

Source
HttpBody.scala
def companion: HttpBody.type

Attributes

Source
HttpBody.scala
def getField(`__field`: FieldDescriptor): PValue

Attributes

Source
HttpBody.scala
def getFieldByNumber(`__fieldNumber`: Int): Any

Attributes

Source
HttpBody.scala
override def serializedSize: Int

Attributes

Definition Classes
GeneratedMessage
Source
HttpBody.scala
def toProtoString: String

Returns a human-readable ASCII format representation of this message.

Returns a human-readable ASCII format representation of this message.

The original message can be decoded from this format by using fromAscii on the companion object.

Attributes

Returns

human-readable representation of this message.

Source
HttpBody.scala
def withContentType(`__v`: String): HttpBody

Attributes

Source
HttpBody.scala
def withData(`__v`: ByteString): HttpBody

Attributes

Source
HttpBody.scala
def withExtensions(`__v`: Seq[Any]): HttpBody

Attributes

Source
HttpBody.scala
def withUnknownFields(`__v`: UnknownFieldSet): HttpBody

Attributes

Source
HttpBody.scala
def writeTo(`_output__`: CodedOutputStream): Unit

Serializes the message into the given coded output stream

Serializes the message into the given coded output stream

Attributes

Source
HttpBody.scala

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
final def toByteArray: Array[Byte]

Serializes the message and returns a byte array containing its raw bytes

Serializes the message and returns a byte array containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
final def toByteString: ByteString

Serializes the message and returns a ByteString containing its raw bytes

Serializes the message and returns a ByteString containing its raw bytes

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
final def toPMessage: PMessage

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
def update(ms: Lens[HttpBody, HttpBody] => () => HttpBody*): A

Attributes

Inherited from:
Updatable
Source
Lenses.scala
final def writeDelimitedTo(output: OutputStream): Unit

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala
final def writeTo(output: OutputStream): Unit

Serializes the message into the given output stream

Serializes the message into the given output stream

Attributes

Inherited from:
GeneratedMessage
Source
GeneratedMessageCompanion.scala