Class: Google::Apis::ServiceusageV1::HttpRule
- Inherits:
-
Object
- Object
- Google::Apis::ServiceusageV1::HttpRule
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/serviceusage_v1/classes.rb,
generated/google/apis/serviceusage_v1/representations.rb,
generated/google/apis/serviceusage_v1/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 Messagingrpc GetMessage(GetMessageRequest) returns (Message)
option (google.api.http).get = "/v1/messages/message_id
";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¶m=B
. For HTTP method kinds which allow a request body, thebody
field specifies the mapping. Consider a REST update method on the message resource collection: service Messagingrpc UpdateMessage(UpdateMessageRequest) returns (Message)
option (google.api.http) =put: "/v1/messages/
message_id" body: "message"
;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 theadditional_bindings
option. Example: service Messagingrpc GetMessage(GetMessageRequest) returns (Message)
option (google.api.http) =get: "/v1/messages/
message_id" additional_bindings
get: "/v1/users/user_id
/messages/message_id
"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 syntax
matches zero or more path segments, which must be the last part of the path except the
Verb. The syntax
LITERALmatches literal text in the path. The syntax
Variablematches 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 to
var=*
. 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 as
var
. 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 thebody
must not refer to repeated fields or map fields.
Instance Attribute Summary collapse
-
#additional_bindings ⇒ Array<Google::Apis::ServiceusageV1::HttpRule>
Additional HTTP bindings for the selector.
-
#authorizations ⇒ Array<Google::Apis::ServiceusageV1::AuthorizationRule>
Specifies the permission(s) required for an API element for the overall API request to succeed.
-
#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. -
#custom ⇒ Google::Apis::ServiceusageV1::CustomHttpPattern
A custom pattern is used for defining custom HTTP verb.
-
#delete ⇒ String
Used for deleting a resource.
-
#get ⇒ String
Used for listing and getting information about resources.
-
#media_download ⇒ Google::Apis::ServiceusageV1::MediaDownload
Defines the Media configuration for a service in case of a download.
-
#media_upload ⇒ Google::Apis::ServiceusageV1::MediaUpload
Defines the Media configuration for a service in case of an upload.
-
#patch ⇒ String
Used for updating a resource.
-
#post ⇒ String
Used for creating a resource.
-
#put ⇒ String
Used for updating a resource.
-
#rest_collection ⇒ String
DO NOT USE.
-
#rest_method_name ⇒ String
DO NOT USE.
-
#selector ⇒ String
Selects methods to which this rule applies.
Instance Method Summary collapse
-
#initialize(**args) ⇒ HttpRule
constructor
A new instance of HttpRule.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ HttpRule
Returns a new instance of HttpRule
2298 2299 2300 |
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 2298 def initialize(**args) update!(**args) end |
Instance Attribute Details
#additional_bindings ⇒ Array<Google::Apis::ServiceusageV1::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
2190 2191 2192 |
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 2190 def additional_bindings @additional_bindings end |
#authorizations ⇒ Array<Google::Apis::ServiceusageV1::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
2198 2199 2200 |
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 2198 def @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
2206 2207 2208 |
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 2206 def body @body end |
#custom ⇒ Google::Apis::ServiceusageV1::CustomHttpPattern
A custom pattern is used for defining custom HTTP verb.
Corresponds to the JSON property custom
2211 2212 2213 |
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 2211 def custom @custom end |
#delete ⇒ String
Used for deleting a resource.
Corresponds to the JSON property delete
2216 2217 2218 |
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 2216 def delete @delete end |
#get ⇒ String
Used for listing and getting information about resources.
Corresponds to the JSON property get
2221 2222 2223 |
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 2221 def get @get end |
#media_download ⇒ Google::Apis::ServiceusageV1::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
2229 2230 2231 |
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 2229 def media_download @media_download end |
#media_upload ⇒ Google::Apis::ServiceusageV1::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
2237 2238 2239 |
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 2237 def media_upload @media_upload end |
#patch ⇒ String
Used for updating a resource.
Corresponds to the JSON property patch
2242 2243 2244 |
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 2242 def patch @patch end |
#post ⇒ String
Used for creating a resource.
Corresponds to the JSON property post
2247 2248 2249 |
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 2247 def post @post end |
#put ⇒ String
Used for updating a resource.
Corresponds to the JSON property put
2252 2253 2254 |
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 2252 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
2271 2272 2273 |
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 2271 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
2290 2291 2292 |
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 2290 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
2296 2297 2298 |
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 2296 def selector @selector end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 |
# File 'generated/google/apis/serviceusage_v1/classes.rb', line 2303 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 |