google_api

Documentation

Overview

Package google_api is a generated protocol buffer package.

It is generated from these files:

google/api/annotations.proto
google/api/http.proto

It has these top-level messages:

HttpRule
CustomHttpPattern

Index

• Variables
• type CustomHttpPattern
  • func (*CustomHttpPattern) Descriptor() ([]byte, []int)
  • func (*CustomHttpPattern) ProtoMessage()
  • func (m *CustomHttpPattern) Reset()
  • func (m *CustomHttpPattern) String() string
• type HttpRule
  • func (*HttpRule) Descriptor() ([]byte, []int)
  • func (m *HttpRule) GetAdditionalBindings() []*HttpRule
  • func (m *HttpRule) GetCustom() *CustomHttpPattern
  • func (m *HttpRule) GetDelete() string
  • func (m *HttpRule) GetGet() string
  • func (m *HttpRule) GetPatch() string
  • func (m *HttpRule) GetPattern() isHttpRule_Pattern
  • func (m *HttpRule) GetPost() string
  • func (m *HttpRule) GetPut() string
  • func (*HttpRule) ProtoMessage()
  • func (m *HttpRule) Reset()
  • func (m *HttpRule) String() string
  • func (*HttpRule) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, ...)
• type HttpRule_Custom
• type HttpRule_Delete
• type HttpRule_Get
• type HttpRule_Patch
• type HttpRule_Post
• type HttpRule_Put

Variables

var E_Http = &proto.ExtensionDesc{
	ExtendedType:  (*google_protobuf.MethodOptions)(nil),
	ExtensionType: (*HttpRule)(nil),
	Field:         72295728,
	Name:          "google.api.http",
	Tag:           "bytes,72295728,opt,name=http",
}

Types

type CustomHttpPattern

type CustomHttpPattern struct {
	// The name of this custom HTTP verb.
	Kind string `protobuf:"bytes,1,opt,name=kind" json:"kind,omitempty"`
	// The path matched by this custom verb.
	Path string `protobuf:"bytes,2,opt,name=path" json:"path,omitempty"`
}

A custom pattern is used for defining custom HTTP verb.

func (*CustomHttpPattern) Descriptor

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

func (*CustomHttpPattern) ProtoMessage

func (*CustomHttpPattern) ProtoMessage()

func (*CustomHttpPattern) Reset

func (m *CustomHttpPattern) Reset()

func (*CustomHttpPattern) String

func (m *CustomHttpPattern) String() string

type HttpRule

type HttpRule struct {
	// Determines the URL pattern is matched by this rules. This pattern can be
	// used with any of the {get|put|post|delete|patch} methods. A custom method
	// can be defined using the 'custom' field.
	//
	// Types that are valid to be assigned to Pattern:
	//	*HttpRule_Get
	//	*HttpRule_Put
	//	*HttpRule_Post
	//	*HttpRule_Delete
	//	*HttpRule_Patch
	//	*HttpRule_Custom
	Pattern isHttpRule_Pattern `protobuf_oneof:"pattern"`
	// The name of the request field whose value is mapped to the HTTP body, or
	// `*` for mapping all fields not captured by the path pattern to the HTTP
	// body.
	Body string `protobuf:"bytes,7,opt,name=body" json:"body,omitempty"`
	// Additional HTTP bindings for the selector. Nested bindings must not
	// specify a selector and must not contain additional bindings.
	AdditionalBindings []*HttpRule `protobuf:"bytes,11,rep,name=additional_bindings,json=additionalBindings" json:"additional_bindings,omitempty"`
}

`HttpRule` defines the mapping of an RPC method to one or more HTTP REST API methods. The mapping determines what portions of the request message are populated from the path, query parameters, or body of the HTTP request. The mapping is typically specified as an `google.api.http` annotation, see "google/api/annotations.proto" for details.

The mapping consists of a mandatory field specifying a path template and an optional `body` field specifying what data is represented in the HTTP request body. The field name for the path indicates the HTTP method. Example:

``` package google.storage.v2;

import "google/api/annotations.proto";

service Storage {
  rpc CreateObject(CreateObjectRequest) returns (Object) {
    option (google.api.http) {
      post: "/v2/{bucket_name=buckets/*}/objects"
      body: "object"
    };
  };
}

```

Here `bucket_name` and `object` bind to fields of the request message `CreateObjectRequest`.

The rules for mapping HTTP path, query parameters, and body fields to the request message are as follows:

1. The `body` field specifies either `*` or a field path, or is omitted. If omitted, it assumes there is no HTTP body.
2. Leaf fields (recursive expansion of nested messages in the request) can be classified into three types: (a) Matched in the URL template. (b) Covered by body (if body is `*`, everything except (a) fields; else everything under the body field) (c) All other fields.
3. URL query parameters found in the HTTP request are mapped to (c) fields.
4. Any body sent with an HTTP request can contain only (b) fields.

The syntax of the path template is as follows:

Template = "/" Segments [ Verb ] ;
Segments = Segment { "/" Segment } ;
Segment  = "*" | "**" | LITERAL | Variable ;
Variable = "{" FieldPath [ "=" Segments ] "}" ;
FieldPath = IDENT { "." IDENT } ;
Verb     = ":" LITERAL ;

`*` matches a single path component, `**` zero or more path components, and `LITERAL` a constant. A `Variable` can match an entire path as specified again by a template; this nested template must not contain further variables. If no template is given with a variable, it matches a single path component. The notation `{var}` is henceforth equivalent to `{var=*}`.

Use CustomHttpPattern to specify any HTTP method that is not included in the pattern field, such as HEAD, or "*" to leave the HTTP method unspecified for a given URL path rule. The wild-card rule is useful for services that provide content to Web (HTML) clients.

func (*HttpRule) Descriptor

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

func (*HttpRule) GetAdditionalBindings

func (m *HttpRule) GetAdditionalBindings() []*HttpRule

func (*HttpRule) GetCustom

func (m *HttpRule) GetCustom() *CustomHttpPattern

func (*HttpRule) GetDelete

func (m *HttpRule) GetDelete() string

func (*HttpRule) GetGet

func (m *HttpRule) GetGet() string

func (*HttpRule) GetPatch

func (m *HttpRule) GetPatch() string

func (*HttpRule) GetPattern

func (m *HttpRule) GetPattern() isHttpRule_Pattern

func (*HttpRule) GetPost

func (m *HttpRule) GetPost() string

func (*HttpRule) GetPut

func (m *HttpRule) GetPut() string

func (*HttpRule) ProtoMessage

func (*HttpRule) ProtoMessage()

func (*HttpRule) Reset

func (m *HttpRule) Reset()

func (*HttpRule) String

func (m *HttpRule) String() string

func (*HttpRule) XXX_OneofFuncs

func (*HttpRule) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

type HttpRule_Custom

type HttpRule_Custom struct {
	Custom *CustomHttpPattern `protobuf:"bytes,8,opt,name=custom,oneof"`
}

type HttpRule_Delete

type HttpRule_Delete struct {
	Delete string `protobuf:"bytes,5,opt,name=delete,oneof"`
}

type HttpRule_Get

type HttpRule_Get struct {
	Get string `protobuf:"bytes,2,opt,name=get,oneof"`
}

type HttpRule_Patch

type HttpRule_Patch struct {
	Patch string `protobuf:"bytes,6,opt,name=patch,oneof"`
}

type HttpRule_Post

type HttpRule_Post struct {
	Post string `protobuf:"bytes,4,opt,name=post,oneof"`
}

type HttpRule_Put

type HttpRule_Put struct {
	Put string `protobuf:"bytes,3,opt,name=put,oneof"`
}