http4s-grpc-google-common-protos
2.29.0+0.0.6
API
Generated with
http4s-grpc-google-common-protos/com.google/com.google.api/com.google.api.httpbody

com.google.api.httpbody

package com.google.api.httpbody

Members list

Type members

Classlikes

final case class HttpBody(contentType: String, data: ByteString, extensions: Seq[Any], unknownFields: UnknownFieldSet) extends GeneratedMessage, Updatable[HttpBody]

Message that represents an arbitrary HTTP body.

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
Supertypes
trait Updatable[HttpBody]
trait GeneratedMessage
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object HttpBody extends GeneratedMessageCompanion[HttpBody]

Attributes

Companion
class
Source
HttpBody.scala
Supertypes
trait Product
trait Mirror
trait GeneratedMessageCompanion[HttpBody]
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
HttpBody.type
object HttpbodyProto extends GeneratedFileObject

Attributes

Source
HttpbodyProto.scala
Supertypes
class GeneratedFileObject
class Object
trait Matchable
class Any
Self type
Generated with