Skip to main content

Interface: $Properties

Properties of a HttpRule.

Extended by​

Properties​

additionalBindings?​

optional additionalBindings?: $Properties[] | null

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?: string | null

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?: $Properties | null

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?: string | null

Maps to HTTP DELETE. Used for deleting a resource.

get?​

optional get?: string | null

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

patch?​

optional patch?: string | null

Maps to HTTP PATCH. Used for updating a resource.

pattern?​

optional pattern?: "get" | "put" | "post" | "delete" | "patch" | "custom"

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.

post?​

optional post?: string | null

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

put?​

optional put?: string | null

Maps to HTTP PUT. Used for replacing a resource.

responseBody?​

optional responseBody?: string | null

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?: string | null

Selects a method to which this rule applies.

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