Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/api/http.proto
// Generated files should ignore deprecation warnings
@file:Suppress("DEPRECATION")
package com.google.api;
@kotlin.jvm.JvmName("-initializehttpRule")
public inline fun httpRule(block: com.google.api.HttpRuleKt.Dsl.() -> kotlin.Unit): com.google.api.HttpRule =
com.google.api.HttpRuleKt.Dsl._create(com.google.api.HttpRule.newBuilder()).apply { block() }._build()
/**
* ```
* `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.subfield` is 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.subfield` becomes 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, 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:
*
* 1. The `body` field specifies either `*` or a field path, or is
* omitted. If omitted, it indicates there is no HTTP request body.
* 2. 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.
* 3. URL query parameters found in the HTTP request are mapped to (c) fields.
* 4. 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 `LITERAL` matches literal text in the path.
*
* The syntax `Variable` matches 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](https://tools.ietf.org/html/rfc6570) 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.
* ```
*
* Protobuf type `google.api.HttpRule`
*/
public object HttpRuleKt {
@kotlin.OptIn(com.google.protobuf.kotlin.OnlyForUseByGeneratedProtoCode::class)
@com.google.protobuf.kotlin.ProtoDslMarker
public class Dsl private constructor(
private val _builder: com.google.api.HttpRule.Builder
) {
public companion object {
@kotlin.jvm.JvmSynthetic
@kotlin.PublishedApi
internal fun _create(builder: com.google.api.HttpRule.Builder): Dsl = Dsl(builder)
}
@kotlin.jvm.JvmSynthetic
@kotlin.PublishedApi
internal fun _build(): com.google.api.HttpRule = _builder.build()
/**
* ```
* Selects methods to which this rule applies.
*
* Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
* ```
*
* `string selector = 1;`
*/
public var selector: kotlin.String
@JvmName("getSelector")
get() = _builder.getSelector()
@JvmName("setSelector")
set(value) {
_builder.setSelector(value)
}
/**
* ```
* Selects methods to which this rule applies.
*
* Refer to [selector][google.api.DocumentationRule.selector] for syntax details.
* ```
*
* `string selector = 1;`
*/
public fun clearSelector() {
_builder.clearSelector()
}
/**
* ```
* Used for listing and getting information about resources.
* ```
*
* `string get = 2;`
*/
public var get: kotlin.String
@JvmName("getGet")
get() = _builder.getGet()
@JvmName("setGet")
set(value) {
_builder.setGet(value)
}
/**
* ```
* Used for listing and getting information about resources.
* ```
*
* `string get = 2;`
*/
public fun clearGet() {
_builder.clearGet()
}
/**
* ```
* Used for listing and getting information about resources.
* ```
*
* `string get = 2;`
* @return Whether the get field is set.
*/
public fun hasGet(): kotlin.Boolean {
return _builder.hasGet()
}
/**
* ```
* Used for updating a resource.
* ```
*
* `string put = 3;`
*/
public var put: kotlin.String
@JvmName("getPut")
get() = _builder.getPut()
@JvmName("setPut")
set(value) {
_builder.setPut(value)
}
/**
* ```
* Used for updating a resource.
* ```
*
* `string put = 3;`
*/
public fun clearPut() {
_builder.clearPut()
}
/**
* ```
* Used for updating a resource.
* ```
*
* `string put = 3;`
* @return Whether the put field is set.
*/
public fun hasPut(): kotlin.Boolean {
return _builder.hasPut()
}
/**
* ```
* Used for creating a resource.
* ```
*
* `string post = 4;`
*/
public var post: kotlin.String
@JvmName("getPost")
get() = _builder.getPost()
@JvmName("setPost")
set(value) {
_builder.setPost(value)
}
/**
* ```
* Used for creating a resource.
* ```
*
* `string post = 4;`
*/
public fun clearPost() {
_builder.clearPost()
}
/**
* ```
* Used for creating a resource.
* ```
*
* `string post = 4;`
* @return Whether the post field is set.
*/
public fun hasPost(): kotlin.Boolean {
return _builder.hasPost()
}
/**
* ```
* Used for deleting a resource.
* ```
*
* `string delete = 5;`
*/
public var delete: kotlin.String
@JvmName("getDelete")
get() = _builder.getDelete()
@JvmName("setDelete")
set(value) {
_builder.setDelete(value)
}
/**
* ```
* Used for deleting a resource.
* ```
*
* `string delete = 5;`
*/
public fun clearDelete() {
_builder.clearDelete()
}
/**
* ```
* Used for deleting a resource.
* ```
*
* `string delete = 5;`
* @return Whether the delete field is set.
*/
public fun hasDelete(): kotlin.Boolean {
return _builder.hasDelete()
}
/**
* ```
* Used for updating a resource.
* ```
*
* `string patch = 6;`
*/
public var patch: kotlin.String
@JvmName("getPatch")
get() = _builder.getPatch()
@JvmName("setPatch")
set(value) {
_builder.setPatch(value)
}
/**
* ```
* Used for updating a resource.
* ```
*
* `string patch = 6;`
*/
public fun clearPatch() {
_builder.clearPatch()
}
/**
* ```
* Used for updating a resource.
* ```
*
* `string patch = 6;`
* @return Whether the patch field is set.
*/
public fun hasPatch(): kotlin.Boolean {
return _builder.hasPatch()
}
/**
* ```
* 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.
* ```
*
* `.google.api.CustomHttpPattern custom = 8;`
*/
public var custom: com.google.api.CustomHttpPattern
@JvmName("getCustom")
get() = _builder.getCustom()
@JvmName("setCustom")
set(value) {
_builder.setCustom(value)
}
/**
* ```
* 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.
* ```
*
* `.google.api.CustomHttpPattern custom = 8;`
*/
public fun clearCustom() {
_builder.clearCustom()
}
/**
* ```
* 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.
* ```
*
* `.google.api.CustomHttpPattern custom = 8;`
* @return Whether the custom field is set.
*/
public fun hasCustom(): kotlin.Boolean {
return _builder.hasCustom()
}
/**
* ```
* 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.
* ```
*
* `string body = 7;`
*/
public var body: kotlin.String
@JvmName("getBody")
get() = _builder.getBody()
@JvmName("setBody")
set(value) {
_builder.setBody(value)
}
/**
* ```
* 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.
* ```
*
* `string body = 7;`
*/
public fun clearBody() {
_builder.clearBody()
}
/**
* ```
* Optional. The name of the response field whose value is mapped to the HTTP
* body of response. Other response fields are ignored. When
* not set, the response message will be used as HTTP body of response.
* ```
*
* `string response_body = 12;`
*/
public var responseBody: kotlin.String
@JvmName("getResponseBody")
get() = _builder.getResponseBody()
@JvmName("setResponseBody")
set(value) {
_builder.setResponseBody(value)
}
/**
* ```
* Optional. The name of the response field whose value is mapped to the HTTP
* body of response. Other response fields are ignored. When
* not set, the response message will be used as HTTP body of response.
* ```
*
* `string response_body = 12;`
*/
public fun clearResponseBody() {
_builder.clearResponseBody()
}
/**
* An uninstantiable, behaviorless type to represent the field in
* generics.
*/
@kotlin.OptIn(com.google.protobuf.kotlin.OnlyForUseByGeneratedProtoCode::class)
public class AdditionalBindingsProxy private constructor() : com.google.protobuf.kotlin.DslProxy()
/**
* ```
* 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).
* ```
*
* `repeated .google.api.HttpRule additional_bindings = 11;`
*/
public val additionalBindings: com.google.protobuf.kotlin.DslList
@kotlin.jvm.JvmSynthetic
get() = com.google.protobuf.kotlin.DslList(
_builder.getAdditionalBindingsList()
)
/**
* ```
* 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).
* ```
*
* `repeated .google.api.HttpRule additional_bindings = 11;`
* @param value The additionalBindings to add.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("addAdditionalBindings")
public fun com.google.protobuf.kotlin.DslList.add(value: com.google.api.HttpRule) {
_builder.addAdditionalBindings(value)
}
/**
* ```
* 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).
* ```
*
* `repeated .google.api.HttpRule additional_bindings = 11;`
* @param value The additionalBindings to add.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("plusAssignAdditionalBindings")
@Suppress("NOTHING_TO_INLINE")
public inline operator fun com.google.protobuf.kotlin.DslList.plusAssign(value: com.google.api.HttpRule) {
add(value)
}
/**
* ```
* 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).
* ```
*
* `repeated .google.api.HttpRule additional_bindings = 11;`
* @param values The additionalBindings to add.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("addAllAdditionalBindings")
public fun com.google.protobuf.kotlin.DslList.addAll(values: kotlin.collections.Iterable) {
_builder.addAllAdditionalBindings(values)
}
/**
* ```
* 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).
* ```
*
* `repeated .google.api.HttpRule additional_bindings = 11;`
* @param values The additionalBindings to add.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("plusAssignAllAdditionalBindings")
@Suppress("NOTHING_TO_INLINE")
public inline operator fun com.google.protobuf.kotlin.DslList.plusAssign(values: kotlin.collections.Iterable) {
addAll(values)
}
/**
* ```
* 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).
* ```
*
* `repeated .google.api.HttpRule additional_bindings = 11;`
* @param index The index to set the value at.
* @param value The additionalBindings to set.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("setAdditionalBindings")
public operator fun com.google.protobuf.kotlin.DslList.set(index: kotlin.Int, value: com.google.api.HttpRule) {
_builder.setAdditionalBindings(index, value)
}
/**
* ```
* 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).
* ```
*
* `repeated .google.api.HttpRule additional_bindings = 11;`
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("clearAdditionalBindings")
public fun com.google.protobuf.kotlin.DslList.clear() {
_builder.clearAdditionalBindings()
}
public val patternCase: com.google.api.HttpRule.PatternCase
@JvmName("getPatternCase")
get() = _builder.getPatternCase()
public fun clearPattern() {
_builder.clearPattern()
}
}
}
@kotlin.jvm.JvmSynthetic
public inline fun com.google.api.HttpRule.copy(block: `com.google.api`.HttpRuleKt.Dsl.() -> kotlin.Unit): com.google.api.HttpRule =
`com.google.api`.HttpRuleKt.Dsl._create(this.toBuilder()).apply { block() }._build()
public val com.google.api.HttpRuleOrBuilder.customOrNull: com.google.api.CustomHttpPattern?
get() = if (hasCustom()) getCustom() else null
