httpbody

type HttpBody ¶

type HttpBody struct {

	// The HTTP Content-Type header value specifying the content type of the body.
	ContentType string `protobuf:"bytes,1,opt,name=content_type,json=contentType,proto3" json:"content_type,omitempty"`
	// The HTTP request/response body as raw binary.
	Data []byte `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
	// Application specific response metadata. Must be set in the first response
	// for streaming APIs.
	Extensions []*anypb.Any `protobuf:"bytes,3,rep,name=extensions,proto3" json:"extensions,omitempty"`
	// contains filtered or unexported fields
}

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.

func (*HttpBody) Descriptor() ([]byte, []int)

func (x *HttpBody) GetContentType() string

func (x *HttpBody) GetData() []byte

func (x *HttpBody) GetExtensions() []*anypb.Any

func (*HttpBody) ProtoMessage()

func (x *HttpBody) ProtoReflect() protoreflect.Message

func (x *HttpBody) Reset()

func (x *HttpBody) String() string

func (m *HttpBody) Validate() error

func (m *HttpBody) ValidateAll() error

type HttpBodyMultiError ¶

type HttpBodyMultiError []error

HttpBodyMultiError is an error wrapping multiple validation errors returned by HttpBody.ValidateAll() if the designated constraints aren't met.

func (m HttpBodyMultiError) AllErrors() []error

func (m HttpBodyMultiError) Error() string

type HttpBodyValidationError ¶

type HttpBodyValidationError struct {
	// contains filtered or unexported fields
}

HttpBodyValidationError is the validation error returned by HttpBody.Validate if the designated constraints aren't met.

func (e HttpBodyValidationError) Cause() error

func (e HttpBodyValidationError) Error() string

func (e HttpBodyValidationError) ErrorName() string

func (e HttpBodyValidationError) Field() string

func (e HttpBodyValidationError) Key() bool

func (e HttpBodyValidationError) Reason() string