grpc.gateway.protoc_gen_openapiv2.options.ResponseKt.kt Maven / Gradle / Ivy
The newest version!
//Generated by the protocol buffer compiler. DO NOT EDIT!
// source: protoc-gen-openapiv2/options/openapiv2.proto
package grpc.gateway.protoc_gen_openapiv2.options;
@kotlin.jvm.JvmName("-initializeresponse")
public inline fun response(block: grpc.gateway.protoc_gen_openapiv2.options.ResponseKt.Dsl.() -> kotlin.Unit): grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.Response =
grpc.gateway.protoc_gen_openapiv2.options.ResponseKt.Dsl._create(grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.Response.newBuilder()).apply { block() }._build()
public object ResponseKt {
@kotlin.OptIn(com.google.protobuf.kotlin.OnlyForUseByGeneratedProtoCode::class)
@com.google.protobuf.kotlin.ProtoDslMarker
public class Dsl private constructor(
private val _builder: grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.Response.Builder
) {
public companion object {
@kotlin.jvm.JvmSynthetic
@kotlin.PublishedApi
internal fun _create(builder: grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.Response.Builder): Dsl = Dsl(builder)
}
@kotlin.jvm.JvmSynthetic
@kotlin.PublishedApi
internal fun _build(): grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.Response = _builder.build()
/**
*
* `Description` is a short description of the response.
* GFM syntax can be used for rich text representation.
*
*
* string description = 1;
*/
public var description: kotlin.String
@JvmName("getDescription")
get() = _builder.getDescription()
@JvmName("setDescription")
set(value) {
_builder.setDescription(value)
}
/**
*
* `Description` is a short description of the response.
* GFM syntax can be used for rich text representation.
*
*
* string description = 1;
*/
public fun clearDescription() {
_builder.clearDescription()
}
/**
*
* `Schema` optionally defines the structure of the response.
* If `Schema` is not provided, it means there is no content to the response.
*
*
* .grpc.gateway.protoc_gen_openapiv2.options.Schema schema = 2;
*/
public var schema: grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.Schema
@JvmName("getSchema")
get() = _builder.getSchema()
@JvmName("setSchema")
set(value) {
_builder.setSchema(value)
}
/**
*
* `Schema` optionally defines the structure of the response.
* If `Schema` is not provided, it means there is no content to the response.
*
*
* .grpc.gateway.protoc_gen_openapiv2.options.Schema schema = 2;
*/
public fun clearSchema() {
_builder.clearSchema()
}
/**
*
* `Schema` optionally defines the structure of the response.
* If `Schema` is not provided, it means there is no content to the response.
*
*
* .grpc.gateway.protoc_gen_openapiv2.options.Schema schema = 2;
* @return Whether the schema field is set.
*/
public fun hasSchema(): kotlin.Boolean {
return _builder.hasSchema()
}
/**
* An uninstantiable, behaviorless type to represent the field in
* generics.
*/
@kotlin.OptIn(com.google.protobuf.kotlin.OnlyForUseByGeneratedProtoCode::class)
public class HeadersProxy private constructor() : com.google.protobuf.kotlin.DslProxy()
/**
*
* `Headers` A list of headers that are sent with the response.
* `Header` name is expected to be a string in the canonical format of the MIME header key
* See: https://golang.org/pkg/net/textproto/#CanonicalMIMEHeaderKey
*
*
* map<string, .grpc.gateway.protoc_gen_openapiv2.options.Header> headers = 3;
*/
public val headers: com.google.protobuf.kotlin.DslMap
@kotlin.jvm.JvmSynthetic
@JvmName("getHeadersMap")
get() = com.google.protobuf.kotlin.DslMap(
_builder.getHeadersMap()
)
/**
*
* `Headers` A list of headers that are sent with the response.
* `Header` name is expected to be a string in the canonical format of the MIME header key
* See: https://golang.org/pkg/net/textproto/#CanonicalMIMEHeaderKey
*
*
* map<string, .grpc.gateway.protoc_gen_openapiv2.options.Header> headers = 3;
*/
@JvmName("putHeaders")
public fun com.google.protobuf.kotlin.DslMap
.put(key: kotlin.String, value: grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.Header) {
_builder.putHeaders(key, value)
}
/**
*
* `Headers` A list of headers that are sent with the response.
* `Header` name is expected to be a string in the canonical format of the MIME header key
* See: https://golang.org/pkg/net/textproto/#CanonicalMIMEHeaderKey
*
*
* map<string, .grpc.gateway.protoc_gen_openapiv2.options.Header> headers = 3;
*/
@kotlin.jvm.JvmSynthetic
@JvmName("setHeaders")
@Suppress("NOTHING_TO_INLINE")
public inline operator fun com.google.protobuf.kotlin.DslMap
.set(key: kotlin.String, value: grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.Header) {
put(key, value)
}
/**
*
* `Headers` A list of headers that are sent with the response.
* `Header` name is expected to be a string in the canonical format of the MIME header key
* See: https://golang.org/pkg/net/textproto/#CanonicalMIMEHeaderKey
*
*
* map<string, .grpc.gateway.protoc_gen_openapiv2.options.Header> headers = 3;
*/
@kotlin.jvm.JvmSynthetic
@JvmName("removeHeaders")
public fun com.google.protobuf.kotlin.DslMap
.remove(key: kotlin.String) {
_builder.removeHeaders(key)
}
/**
*
* `Headers` A list of headers that are sent with the response.
* `Header` name is expected to be a string in the canonical format of the MIME header key
* See: https://golang.org/pkg/net/textproto/#CanonicalMIMEHeaderKey
*
*
* map<string, .grpc.gateway.protoc_gen_openapiv2.options.Header> headers = 3;
*/
@kotlin.jvm.JvmSynthetic
@JvmName("putAllHeaders")
public fun com.google.protobuf.kotlin.DslMap
.putAll(map: kotlin.collections.Map) {
_builder.putAllHeaders(map)
}
/**
*
* `Headers` A list of headers that are sent with the response.
* `Header` name is expected to be a string in the canonical format of the MIME header key
* See: https://golang.org/pkg/net/textproto/#CanonicalMIMEHeaderKey
*
*
* map<string, .grpc.gateway.protoc_gen_openapiv2.options.Header> headers = 3;
*/
@kotlin.jvm.JvmSynthetic
@JvmName("clearHeaders")
public fun com.google.protobuf.kotlin.DslMap
.clear() {
_builder.clearHeaders()
}
/**
* An uninstantiable, behaviorless type to represent the field in
* generics.
*/
@kotlin.OptIn(com.google.protobuf.kotlin.OnlyForUseByGeneratedProtoCode::class)
public class ExamplesProxy private constructor() : com.google.protobuf.kotlin.DslProxy()
/**
*
* `Examples` gives per-mimetype response examples.
* See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#example-object
*
*
* map<string, string> examples = 4;
*/
public val examples: com.google.protobuf.kotlin.DslMap
@kotlin.jvm.JvmSynthetic
@JvmName("getExamplesMap")
get() = com.google.protobuf.kotlin.DslMap(
_builder.getExamplesMap()
)
/**
*
* `Examples` gives per-mimetype response examples.
* See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#example-object
*
*
* map<string, string> examples = 4;
*/
@JvmName("putExamples")
public fun com.google.protobuf.kotlin.DslMap
.put(key: kotlin.String, value: kotlin.String) {
_builder.putExamples(key, value)
}
/**
*
* `Examples` gives per-mimetype response examples.
* See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#example-object
*
*
* map<string, string> examples = 4;
*/
@kotlin.jvm.JvmSynthetic
@JvmName("setExamples")
@Suppress("NOTHING_TO_INLINE")
public inline operator fun com.google.protobuf.kotlin.DslMap
.set(key: kotlin.String, value: kotlin.String) {
put(key, value)
}
/**
*
* `Examples` gives per-mimetype response examples.
* See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#example-object
*
*
* map<string, string> examples = 4;
*/
@kotlin.jvm.JvmSynthetic
@JvmName("removeExamples")
public fun com.google.protobuf.kotlin.DslMap
.remove(key: kotlin.String) {
_builder.removeExamples(key)
}
/**
*
* `Examples` gives per-mimetype response examples.
* See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#example-object
*
*
* map<string, string> examples = 4;
*/
@kotlin.jvm.JvmSynthetic
@JvmName("putAllExamples")
public fun com.google.protobuf.kotlin.DslMap
.putAll(map: kotlin.collections.Map) {
_builder.putAllExamples(map)
}
/**
*
* `Examples` gives per-mimetype response examples.
* See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#example-object
*
*
* map<string, string> examples = 4;
*/
@kotlin.jvm.JvmSynthetic
@JvmName("clearExamples")
public fun com.google.protobuf.kotlin.DslMap
.clear() {
_builder.clearExamples()
}
/**
* An uninstantiable, behaviorless type to represent the field in
* generics.
*/
@kotlin.OptIn(com.google.protobuf.kotlin.OnlyForUseByGeneratedProtoCode::class)
public class ExtensionsProxy private constructor() : com.google.protobuf.kotlin.DslProxy()
/**
*
* Custom properties that start with "x-" such as "x-foo" used to describe
* extra functionality that is not covered by the standard OpenAPI Specification.
* See: https://swagger.io/docs/specification/2-0/swagger-extensions/
*
*
* map<string, .google.protobuf.Value> extensions = 5;
*/
public val extensions: com.google.protobuf.kotlin.DslMap
@kotlin.jvm.JvmSynthetic
@JvmName("getExtensionsMap")
get() = com.google.protobuf.kotlin.DslMap(
_builder.getExtensionsMap()
)
/**
*
* Custom properties that start with "x-" such as "x-foo" used to describe
* extra functionality that is not covered by the standard OpenAPI Specification.
* See: https://swagger.io/docs/specification/2-0/swagger-extensions/
*
*
* map<string, .google.protobuf.Value> extensions = 5;
*/
@JvmName("putExtensions")
public fun com.google.protobuf.kotlin.DslMap
.put(key: kotlin.String, value: com.google.protobuf.Value) {
_builder.putExtensions(key, value)
}
/**
*
* Custom properties that start with "x-" such as "x-foo" used to describe
* extra functionality that is not covered by the standard OpenAPI Specification.
* See: https://swagger.io/docs/specification/2-0/swagger-extensions/
*
*
* map<string, .google.protobuf.Value> extensions = 5;
*/
@kotlin.jvm.JvmSynthetic
@JvmName("setExtensions")
@Suppress("NOTHING_TO_INLINE")
public inline operator fun com.google.protobuf.kotlin.DslMap
.set(key: kotlin.String, value: com.google.protobuf.Value) {
put(key, value)
}
/**
*
* Custom properties that start with "x-" such as "x-foo" used to describe
* extra functionality that is not covered by the standard OpenAPI Specification.
* See: https://swagger.io/docs/specification/2-0/swagger-extensions/
*
*
* map<string, .google.protobuf.Value> extensions = 5;
*/
@kotlin.jvm.JvmSynthetic
@JvmName("removeExtensions")
public fun com.google.protobuf.kotlin.DslMap
.remove(key: kotlin.String) {
_builder.removeExtensions(key)
}
/**
*
* Custom properties that start with "x-" such as "x-foo" used to describe
* extra functionality that is not covered by the standard OpenAPI Specification.
* See: https://swagger.io/docs/specification/2-0/swagger-extensions/
*
*
* map<string, .google.protobuf.Value> extensions = 5;
*/
@kotlin.jvm.JvmSynthetic
@JvmName("putAllExtensions")
public fun com.google.protobuf.kotlin.DslMap
.putAll(map: kotlin.collections.Map) {
_builder.putAllExtensions(map)
}
/**
*
* Custom properties that start with "x-" such as "x-foo" used to describe
* extra functionality that is not covered by the standard OpenAPI Specification.
* See: https://swagger.io/docs/specification/2-0/swagger-extensions/
*
*
* map<string, .google.protobuf.Value> extensions = 5;
*/
@kotlin.jvm.JvmSynthetic
@JvmName("clearExtensions")
public fun com.google.protobuf.kotlin.DslMap
.clear() {
_builder.clearExtensions()
}
}
}
@kotlin.jvm.JvmSynthetic
public inline fun grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.Response.copy(block: grpc.gateway.protoc_gen_openapiv2.options.ResponseKt.Dsl.() -> kotlin.Unit): grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.Response =
grpc.gateway.protoc_gen_openapiv2.options.ResponseKt.Dsl._create(this.toBuilder()).apply { block() }._build()
public val grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.ResponseOrBuilder.schemaOrNull: grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.Schema?
get() = if (hasSchema()) getSchema() else null
© 2015 - 2025 Weber Informatics LLC | Privacy Policy