Class: Google::Apis::ServiceusageV1beta1::HttpRule

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/serviceusage_v1beta1/classes.rb,
generated/google/apis/serviceusage_v1beta1/representations.rb,
generated/google/apis/serviceusage_v1beta1/representations.rb

Overview

HttpRule defines the mapping of an RPC method to one or more HTTP REST API methods. The mapping specifies how different portions of the RPC request message are mapped to URL path, URL query parameters, and HTTP request body. The mapping is typically specified as an google.api.http annotation on the RPC method, see "google/api/annotations.proto" for details. The mapping consists of a field specifying the path template and method kind. The path template can refer to fields in the request message, as in the example below which describes a REST GET operation on a resource collection of messages: service Messaging rpc GetMessage(GetMessageRequest) returns (Message) option (google.api.http).get = "/v1/messages/message_id/sub. subfield"; message GetMessageRequest message SubMessage string subfield = 1; string message_id = 1; // mapped to the URL SubMessage sub = 2; //sub.subfieldis url-mapped message Message string text = 1; // content of the resource The same http annotation can alternatively be expressed inside the GRPC API Configuration YAML file. http: rules:

  • selector: .Messaging.GetMessage get: /v1/messages/message_id/sub.subfield This definition enables an automatic, bidrectional mapping of HTTP JSON to RPC. Example: HTTP | RPC -----|----- GET /v1/messages/123456/foo | GetMessage(message_id: "123456" sub: SubMessage(subfield: "foo")) In general, not only fields but also field paths can be referenced from a path pattern. Fields mapped to the path pattern cannot be repeated and must have a primitive (non-message) type. Any fields in the request message which are not bound by the path pattern automatically become (optional) HTTP query parameters. Assume the following definition of the request message: service Messaging rpc GetMessage(GetMessageRequest) returns (Message) option (google.api.http).get = "/v1/messages/message_id"; message GetMessageRequest message SubMessage string subfield = 1; string message_id = 1; // mapped to the URL int64 revision = 2; // becomes a parameter SubMessage sub = 3; //sub.subfieldbecomes a parameter This enables a HTTP JSON to RPC mapping as below: HTTP | RPC -----|----- GET /v1/messages/123456?revision=2&sub.subfield=foo | GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo")) Note that fields which are mapped to HTTP parameters must have a primitive type or a repeated primitive type. Message types are not allowed. In the case of a repeated type, the parameter can be repeated in the URL, as in ...?param=A&param=B. For HTTP method kinds which allow a request body, the body field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging rpc UpdateMessage(UpdateMessageRequest) returns (Message) option (google.api.http) = put: "/v1/messages/message_id" body: "message" ; message UpdateMessageRequest string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: HTTP | RPC -----|----- PUT /v1/messages/123456 "text": "Hi!" | `UpdateMessage(message_id: " 123456" message ` text: "Hi!" `)` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging ` rpc UpdateMessage(Message) returns (Message) ` option (google.api.http) = ` put: "/v1/messages/`message_id`" body: "*" `; ` ` message Message ` string message_id = 1; string text = 2; ` The following HTTP JSON to RPC mapping is enabled: HTTP | RPC -----|----- `PUT /v1/messages/123456 ` "text": "Hi!" | UpdateMessage(message_id: " 123456" text: "Hi!") Note that when using * in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice of defining REST APIs. The common usage of * is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the additional_bindings option. Example: service Messaging rpc GetMessage(GetMessageRequest) returns (Message) option (google.api.http) = get: "/v1/messages/message_id" additional_bindings get: "/v1/users/user_id/messages/message_id" ; message GetMessageRequest string message_id = 1; string user_id = 2; This enables the following two alternative HTTP JSON to RPC mappings: HTTP | RPC -----|----- GET /v1/messages/123456 | GetMessage(message_id: "123456") GET /v1/users/me/messages/123456 | GetMessage(user_id: "me" message_id: " 123456") # Rules for HTTP mapping The rules for mapping HTTP path, query parameters, and body fields to the request message are as follows:
  • The body field specifies either * or a field path, or is omitted. If omitted, it indicates there is no HTTP request body.
  • 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.
  • URL query parameters found in the HTTP request are mapped to (c) fields.
  • 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 ; The syntax `matches a single path segment. The syntaxmatches zero or more path segments, which must be the last part of the path except the Verb. The syntaxLITERALmatches literal text in the path. The syntaxVariablematches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g.var is equivalent tovar=*. If a variable contains exactly one path segment, such as"var"or "var=*", when such a variable is expanded into a URL path, all characters except[-_.~0-9a-zA-Z]are percent-encoded. Such variables show up in the Discovery Document asvar. If a variable contains one or more path segments, such as"var=foo/*" or"`var=", when such a variable is expanded into a URL path, all characters except [-_.~/0-9a-zA-Z] are percent-encoded. Such variables show up in the Discovery Document as +var. NOTE: While the single segment variable matches the semantics of RFC 6570 Section 3.2.2 Simple String Expansion, the multi segment variable does not match RFC 6570 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like ? and #, which would lead to invalid URLs. NOTE: the field paths in variables and in the body must not refer to repeated fields or map fields.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ HttpRule

Returns a new instance of HttpRule



2274
2275
2276
 
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 2274

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#additional_bindings ⇒ Array<Google::Apis::ServiceusageV1beta1::HttpRule>

Additional HTTP bindings for the selector. Nested bindings must not contain an additional_bindings field themselves (that is, the nesting may only be one level deep). Corresponds to the JSON property additionalBindings

Returns:



2166
2167
2168
 
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 2166

def additional_bindings
  @additional_bindings
end

#authorizations ⇒ Array<Google::Apis::ServiceusageV1beta1::AuthorizationRule>

Specifies the permission(s) required for an API element for the overall API request to succeed. It is typically used to mark request message fields that contain the name of the resource and indicates the permissions that will be checked on that resource. Corresponds to the JSON property authorizations

Returns:



2174
2175
2176
 
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 2174

def authorizations
  @authorizations
end

#body ⇒ String

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. NOTE: the referred field must not be a repeated field and must be present at the top-level of request message type. Corresponds to the JSON property body

Returns:

  • (String) 


2182
2183
2184
 
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 2182

def body
  @body
end

#custom ⇒ Google::Apis::ServiceusageV1beta1::CustomHttpPattern

A custom pattern is used for defining custom HTTP verb. Corresponds to the JSON property custom

Returns:



2187
2188
2189
 
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 2187

def custom
  @custom
end

#delete ⇒ String

Used for deleting a resource. Corresponds to the JSON property delete

Returns:

  • (String) 


2192
2193
2194
 
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 2192

def delete
  @delete
end

#get ⇒ String

Used for listing and getting information about resources. Corresponds to the JSON property get

Returns:

  • (String) 


2197
2198
2199
 
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 2197

def get
  @get
end

#media_download ⇒ Google::Apis::ServiceusageV1beta1::MediaDownload

Defines the Media configuration for a service in case of a download. Use this only for Scotty Requests. Do not use this for media support using Bytestream, add instead [][google.bytestream.RestByteStream] as an API to your configuration for Bytestream methods. Corresponds to the JSON property mediaDownload

Returns:



2205
2206
2207
 
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 2205

def media_download
  @media_download
end

#media_upload ⇒ Google::Apis::ServiceusageV1beta1::MediaUpload

Defines the Media configuration for a service in case of an upload. Use this only for Scotty Requests. Do not use this for media support using Bytestream, add instead [][google.bytestream.RestByteStream] as an API to your configuration for Bytestream methods. Corresponds to the JSON property mediaUpload

Returns:



2213
2214
2215
 
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 2213

def media_upload
  @media_upload
end

#patch ⇒ String

Used for updating a resource. Corresponds to the JSON property patch

Returns:

  • (String) 


2218
2219
2220
 
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 2218

def patch
  @patch
end

#post ⇒ String

Used for creating a resource. Corresponds to the JSON property post

Returns:

  • (String) 


2223
2224
2225
 
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 2223

def post
  @post
end

#put ⇒ String

Used for updating a resource. Corresponds to the JSON property put

Returns:

  • (String) 


2228
2229
2230
 
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 2228

def put
  @put
end

#rest_collection ⇒ String

DO NOT USE. This is an experimental field. Optional. The REST collection name is by default derived from the URL pattern. If specified, this field overrides the default collection name. Example: rpc AddressesAggregatedList(AddressesAggregatedListRequest) returns (AddressesAggregatedListResponse) option (google.api.http) = get: "/v1/projects/project_id/aggregated/addresses" rest_collection: "projects.addresses" ; This method has the automatically derived collection name "projects.aggregated". Because, semantically, this rpc is actually an operation on the "projects.addresses" collection, the rest_collection field is configured to override the derived collection name. Corresponds to the JSON property restCollection

Returns:

  • (String) 


2247
2248
2249
 
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 2247

def rest_collection
  @rest_collection
end

#rest_method_name ⇒ String

DO NOT USE. This is an experimental field. Optional. The rest method name is by default derived from the URL pattern. If specified, this field overrides the default method name. Example: rpc CreateResource(CreateResourceRequest) returns (CreateResourceResponse) option (google.api.http) = post: "/v1/resources", body: "resource", rest_method_name: "insert" ; This method has the automatically derived rest method name "create", but for backwards compatibility with apiary, it is specified as insert. Corresponds to the JSON property restMethodName

Returns:

  • (String) 


2266
2267
2268
 
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 2266

def rest_method_name
  @rest_method_name
end

#selector ⇒ String

Selects methods to which this rule applies. Refer to selector for syntax details. Corresponds to the JSON property selector

Returns:

  • (String) 


2272
2273
2274
 
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 2272

def selector
  @selector
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
 
# File 'generated/google/apis/serviceusage_v1beta1/classes.rb', line 2279

def update!(**args)
  @additional_bindings = args[:additional_bindings] if args.key?(:additional_bindings)
  @authorizations = args[:authorizations] if args.key?(:authorizations)
  @body = args[:body] if args.key?(:body)
  @custom = args[:custom] if args.key?(:custom)
  @delete = args[:delete] if args.key?(:delete)
  @get = args[:get] if args.key?(:get)
  @media_download = args[:media_download] if args.key?(:media_download)
  @media_upload = args[:media_upload] if args.key?(:media_upload)
  @patch = args[:patch] if args.key?(:patch)
  @post = args[:post] if args.key?(:post)
  @put = args[:put] if args.key?(:put)
  @rest_collection = args[:rest_collection] if args.key?(:rest_collection)
  @rest_method_name = args[:rest_method_name] if args.key?(:rest_method_name)
  @selector = args[:selector] if args.key?(:selector)
end