Class: Google::Apis::ServiceuserV1::HttpRule

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

Overview

HttpRule defines the mapping of an RPC method to one or more HTTP REST APIs. 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 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: 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 assumes there is no HTTP 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. It follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion. The syntax*matches zero or more path segments. It follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.3 Reserved Expansion. NOTE: it must be the last segment in the path except the Verb. The syntaxLITERALmatches literal text in the URL path. The syntaxVariablematches the entire path as specified by its template; this nested template must not contain further variables. If a variable matches a single path segment, its template may be omitted, e.g.var is equivalent to`var=`. NOTE: the field paths in variables and in thebodymust not refer to repeated fields or map fields. 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.

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



2022
2023
2024
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 2022

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

Instance Attribute Details

#additional_bindings ⇒ Array<Google::Apis::ServiceuserV1::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:



1953
1954
1955
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1953

def additional_bindings
  @additional_bindings
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) 


2008
2009
2010
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 2008

def body
  @body
end

#custom ⇒ Google::Apis::ServiceuserV1::CustomHttpPattern

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

Returns:



1980
1981
1982
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1980

def custom
  @custom
end

#delete ⇒ String

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

Returns:

  • (String) 


2000
2001
2002
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 2000

def delete
  @delete
end

#get ⇒ String

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

Returns:

  • (String) 


1985
1986
1987
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1985

def get
  @get
end

#media_download ⇒ Google::Apis::ServiceuserV1::MediaDownload

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:



2015
2016
2017
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 2015

def media_download
  @media_download
end

#media_upload ⇒ Google::Apis::ServiceuserV1::MediaUpload

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:



1969
1970
1971
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1969

def media_upload
  @media_upload
end

#patch ⇒ String

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

Returns:

  • (String) 


1990
1991
1992
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1990

def patch
  @patch
end

#post ⇒ String

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

Returns:

  • (String) 


2020
2021
2022
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 2020

def post
  @post
end

#put ⇒ String

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

Returns:

  • (String) 


1995
1996
1997
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1995

def put
  @put
end

#response_body ⇒ String

The name of the response field whose value is mapped to the HTTP body of response. Other response fields are ignored. This field is optional. When not set, the response message will be used as HTTP body of response. NOTE: the referred field must be not a repeated field and must be present at the top-level of response message type. Corresponds to the JSON property responseBody

Returns:

  • (String) 


1962
1963
1964
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1962

def response_body
  @response_body
end

#selector ⇒ String

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

Returns:

  • (String) 


1975
1976
1977
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 1975

def selector
  @selector
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
 
# File 'generated/google/apis/serviceuser_v1/classes.rb', line 2027

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