Skip to main content

Interface: IHttpRule

google.api.IHttpRule

Properties of a HttpRule.

Implemented by

Properties

additionalBindings

Optional additionalBindings: null | IHttpRule[]

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).


body

Optional body: null | string

The name of the request field whose value is mapped to the HTTP request body, or * for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for not having any HTTP request body.

NOTE: the referred field must be present at the top-level of the request message type.


custom

Optional custom: null | ICustomHttpPattern

The custom pattern is used for specifying an HTTP method that is not included in the pattern field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The wild-card rule is useful for services that provide content to Web (HTML) clients.


delete

Optional delete: null | string

Maps to HTTP DELETE. Used for deleting a resource.


get

Optional get: null | string

Maps to HTTP GET. Used for listing and getting information about resources.


patch

Optional patch: null | string

Maps to HTTP PATCH. Used for updating a resource.


post

Optional post: null | string

Maps to HTTP POST. Used for creating a resource or performing an action.


put

Optional put: null | string

Maps to HTTP PUT. Used for replacing a resource.


responseBody

Optional responseBody: null | string

Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body.

NOTE: The referred field must be present at the top-level of the response message type.


selector

Optional selector: null | string

Selects a method to which this rule applies.

Refer to [selector][google.api.DocumentationRule.selector] for syntax details.