grpc.gateway.protoc_gen_openapiv2.options.SwaggerKt.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("-initializeswagger")
public inline fun swagger(block: grpc.gateway.protoc_gen_openapiv2.options.SwaggerKt.Dsl.() -> kotlin.Unit): grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.Swagger =
grpc.gateway.protoc_gen_openapiv2.options.SwaggerKt.Dsl._create(grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.Swagger.newBuilder()).apply { block() }._build()
public object SwaggerKt {
@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.Swagger.Builder
) {
public companion object {
@kotlin.jvm.JvmSynthetic
@kotlin.PublishedApi
internal fun _create(builder: grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.Swagger.Builder): Dsl = Dsl(builder)
}
@kotlin.jvm.JvmSynthetic
@kotlin.PublishedApi
internal fun _build(): grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.Swagger = _builder.build()
/**
*
* Specifies the OpenAPI Specification version being used. It can be
* used by the OpenAPI UI and other clients to interpret the API listing. The
* value MUST be "2.0".
*
*
* string swagger = 1;
*/
public var swagger: kotlin.String
@JvmName("getSwagger")
get() = _builder.getSwagger()
@JvmName("setSwagger")
set(value) {
_builder.setSwagger(value)
}
/**
*
* Specifies the OpenAPI Specification version being used. It can be
* used by the OpenAPI UI and other clients to interpret the API listing. The
* value MUST be "2.0".
*
*
* string swagger = 1;
*/
public fun clearSwagger() {
_builder.clearSwagger()
}
/**
*
* Provides metadata about the API. The metadata can be used by the
* clients if needed.
*
*
* .grpc.gateway.protoc_gen_openapiv2.options.Info info = 2;
*/
public var info: grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.Info
@JvmName("getInfo")
get() = _builder.getInfo()
@JvmName("setInfo")
set(value) {
_builder.setInfo(value)
}
/**
*
* Provides metadata about the API. The metadata can be used by the
* clients if needed.
*
*
* .grpc.gateway.protoc_gen_openapiv2.options.Info info = 2;
*/
public fun clearInfo() {
_builder.clearInfo()
}
/**
*
* Provides metadata about the API. The metadata can be used by the
* clients if needed.
*
*
* .grpc.gateway.protoc_gen_openapiv2.options.Info info = 2;
* @return Whether the info field is set.
*/
public fun hasInfo(): kotlin.Boolean {
return _builder.hasInfo()
}
/**
*
* The host (name or ip) serving the API. This MUST be the host only and does
* not include the scheme nor sub-paths. It MAY include a port. If the host is
* not included, the host serving the documentation is to be used (including
* the port). The host does not support path templating.
*
*
* string host = 3;
*/
public var host: kotlin.String
@JvmName("getHost")
get() = _builder.getHost()
@JvmName("setHost")
set(value) {
_builder.setHost(value)
}
/**
*
* The host (name or ip) serving the API. This MUST be the host only and does
* not include the scheme nor sub-paths. It MAY include a port. If the host is
* not included, the host serving the documentation is to be used (including
* the port). The host does not support path templating.
*
*
* string host = 3;
*/
public fun clearHost() {
_builder.clearHost()
}
/**
*
* The base path on which the API is served, which is relative to the host. If
* it is not included, the API is served directly under the host. The value
* MUST start with a leading slash (/). The basePath does not support path
* templating.
* Note that using `base_path` does not change the endpoint paths that are
* generated in the resulting OpenAPI file. If you wish to use `base_path`
* with relatively generated OpenAPI paths, the `base_path` prefix must be
* manually removed from your `google.api.http` paths and your code changed to
* serve the API from the `base_path`.
*
*
* string base_path = 4;
*/
public var basePath: kotlin.String
@JvmName("getBasePath")
get() = _builder.getBasePath()
@JvmName("setBasePath")
set(value) {
_builder.setBasePath(value)
}
/**
*
* The base path on which the API is served, which is relative to the host. If
* it is not included, the API is served directly under the host. The value
* MUST start with a leading slash (/). The basePath does not support path
* templating.
* Note that using `base_path` does not change the endpoint paths that are
* generated in the resulting OpenAPI file. If you wish to use `base_path`
* with relatively generated OpenAPI paths, the `base_path` prefix must be
* manually removed from your `google.api.http` paths and your code changed to
* serve the API from the `base_path`.
*
*
* string base_path = 4;
*/
public fun clearBasePath() {
_builder.clearBasePath()
}
/**
* An uninstantiable, behaviorless type to represent the field in
* generics.
*/
@kotlin.OptIn(com.google.protobuf.kotlin.OnlyForUseByGeneratedProtoCode::class)
public class SchemesProxy private constructor() : com.google.protobuf.kotlin.DslProxy()
/**
*
* The transfer protocol of the API. Values MUST be from the list: "http",
* "https", "ws", "wss". If the schemes is not included, the default scheme to
* be used is the one used to access the OpenAPI definition itself.
*
*
* repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 5;
*/
public val schemes: com.google.protobuf.kotlin.DslList
@kotlin.jvm.JvmSynthetic
get() = com.google.protobuf.kotlin.DslList(
_builder.getSchemesList()
)
/**
*
* The transfer protocol of the API. Values MUST be from the list: "http",
* "https", "ws", "wss". If the schemes is not included, the default scheme to
* be used is the one used to access the OpenAPI definition itself.
*
*
* repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 5;
* @param value The schemes to add.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("addSchemes")
public fun com.google.protobuf.kotlin.DslList.add(value: grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.Scheme) {
_builder.addSchemes(value)
}/**
*
* The transfer protocol of the API. Values MUST be from the list: "http",
* "https", "ws", "wss". If the schemes is not included, the default scheme to
* be used is the one used to access the OpenAPI definition itself.
*
*
* repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 5;
* @param value The schemes to add.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("plusAssignSchemes")
@Suppress("NOTHING_TO_INLINE")
public inline operator fun com.google.protobuf.kotlin.DslList.plusAssign(value: grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.Scheme) {
add(value)
}/**
*
* The transfer protocol of the API. Values MUST be from the list: "http",
* "https", "ws", "wss". If the schemes is not included, the default scheme to
* be used is the one used to access the OpenAPI definition itself.
*
*
* repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 5;
* @param values The schemes to add.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("addAllSchemes")
public fun com.google.protobuf.kotlin.DslList.addAll(values: kotlin.collections.Iterable) {
_builder.addAllSchemes(values)
}/**
*
* The transfer protocol of the API. Values MUST be from the list: "http",
* "https", "ws", "wss". If the schemes is not included, the default scheme to
* be used is the one used to access the OpenAPI definition itself.
*
*
* repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 5;
* @param values The schemes to add.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("plusAssignAllSchemes")
@Suppress("NOTHING_TO_INLINE")
public inline operator fun com.google.protobuf.kotlin.DslList.plusAssign(values: kotlin.collections.Iterable) {
addAll(values)
}/**
*
* The transfer protocol of the API. Values MUST be from the list: "http",
* "https", "ws", "wss". If the schemes is not included, the default scheme to
* be used is the one used to access the OpenAPI definition itself.
*
*
* repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 5;
* @param index The index to set the value at.
* @param value The schemes to set.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("setSchemes")
public operator fun com.google.protobuf.kotlin.DslList.set(index: kotlin.Int, value: grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.Scheme) {
_builder.setSchemes(index, value)
}/**
*
* The transfer protocol of the API. Values MUST be from the list: "http",
* "https", "ws", "wss". If the schemes is not included, the default scheme to
* be used is the one used to access the OpenAPI definition itself.
*
*
* repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 5;
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("clearSchemes")
public fun com.google.protobuf.kotlin.DslList.clear() {
_builder.clearSchemes()
}
/**
* An uninstantiable, behaviorless type to represent the field in
* generics.
*/
@kotlin.OptIn(com.google.protobuf.kotlin.OnlyForUseByGeneratedProtoCode::class)
public class ConsumesProxy private constructor() : com.google.protobuf.kotlin.DslProxy()
/**
*
* A list of MIME types the APIs can consume. This is global to all APIs but
* can be overridden on specific API calls. Value MUST be as described under
* Mime Types.
*
*
* repeated string consumes = 6;
* @return A list containing the consumes.
*/
public val consumes: com.google.protobuf.kotlin.DslList
@kotlin.jvm.JvmSynthetic
get() = com.google.protobuf.kotlin.DslList(
_builder.getConsumesList()
)
/**
*
* A list of MIME types the APIs can consume. This is global to all APIs but
* can be overridden on specific API calls. Value MUST be as described under
* Mime Types.
*
*
* repeated string consumes = 6;
* @param value The consumes to add.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("addConsumes")
public fun com.google.protobuf.kotlin.DslList.add(value: kotlin.String) {
_builder.addConsumes(value)
}
/**
*
* A list of MIME types the APIs can consume. This is global to all APIs but
* can be overridden on specific API calls. Value MUST be as described under
* Mime Types.
*
*
* repeated string consumes = 6;
* @param value The consumes to add.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("plusAssignConsumes")
@Suppress("NOTHING_TO_INLINE")
public inline operator fun com.google.protobuf.kotlin.DslList.plusAssign(value: kotlin.String) {
add(value)
}
/**
*
* A list of MIME types the APIs can consume. This is global to all APIs but
* can be overridden on specific API calls. Value MUST be as described under
* Mime Types.
*
*
* repeated string consumes = 6;
* @param values The consumes to add.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("addAllConsumes")
public fun com.google.protobuf.kotlin.DslList.addAll(values: kotlin.collections.Iterable) {
_builder.addAllConsumes(values)
}
/**
*
* A list of MIME types the APIs can consume. This is global to all APIs but
* can be overridden on specific API calls. Value MUST be as described under
* Mime Types.
*
*
* repeated string consumes = 6;
* @param values The consumes to add.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("plusAssignAllConsumes")
@Suppress("NOTHING_TO_INLINE")
public inline operator fun com.google.protobuf.kotlin.DslList.plusAssign(values: kotlin.collections.Iterable) {
addAll(values)
}
/**
*
* A list of MIME types the APIs can consume. This is global to all APIs but
* can be overridden on specific API calls. Value MUST be as described under
* Mime Types.
*
*
* repeated string consumes = 6;
* @param index The index to set the value at.
* @param value The consumes to set.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("setConsumes")
public operator fun com.google.protobuf.kotlin.DslList.set(index: kotlin.Int, value: kotlin.String) {
_builder.setConsumes(index, value)
}/**
*
* A list of MIME types the APIs can consume. This is global to all APIs but
* can be overridden on specific API calls. Value MUST be as described under
* Mime Types.
*
*
* repeated string consumes = 6;
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("clearConsumes")
public fun com.google.protobuf.kotlin.DslList.clear() {
_builder.clearConsumes()
}
/**
* An uninstantiable, behaviorless type to represent the field in
* generics.
*/
@kotlin.OptIn(com.google.protobuf.kotlin.OnlyForUseByGeneratedProtoCode::class)
public class ProducesProxy private constructor() : com.google.protobuf.kotlin.DslProxy()
/**
*
* A list of MIME types the APIs can produce. This is global to all APIs but
* can be overridden on specific API calls. Value MUST be as described under
* Mime Types.
*
*
* repeated string produces = 7;
* @return A list containing the produces.
*/
public val produces: com.google.protobuf.kotlin.DslList
@kotlin.jvm.JvmSynthetic
get() = com.google.protobuf.kotlin.DslList(
_builder.getProducesList()
)
/**
*
* A list of MIME types the APIs can produce. This is global to all APIs but
* can be overridden on specific API calls. Value MUST be as described under
* Mime Types.
*
*
* repeated string produces = 7;
* @param value The produces to add.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("addProduces")
public fun com.google.protobuf.kotlin.DslList.add(value: kotlin.String) {
_builder.addProduces(value)
}
/**
*
* A list of MIME types the APIs can produce. This is global to all APIs but
* can be overridden on specific API calls. Value MUST be as described under
* Mime Types.
*
*
* repeated string produces = 7;
* @param value The produces to add.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("plusAssignProduces")
@Suppress("NOTHING_TO_INLINE")
public inline operator fun com.google.protobuf.kotlin.DslList.plusAssign(value: kotlin.String) {
add(value)
}
/**
*
* A list of MIME types the APIs can produce. This is global to all APIs but
* can be overridden on specific API calls. Value MUST be as described under
* Mime Types.
*
*
* repeated string produces = 7;
* @param values The produces to add.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("addAllProduces")
public fun com.google.protobuf.kotlin.DslList.addAll(values: kotlin.collections.Iterable) {
_builder.addAllProduces(values)
}
/**
*
* A list of MIME types the APIs can produce. This is global to all APIs but
* can be overridden on specific API calls. Value MUST be as described under
* Mime Types.
*
*
* repeated string produces = 7;
* @param values The produces to add.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("plusAssignAllProduces")
@Suppress("NOTHING_TO_INLINE")
public inline operator fun com.google.protobuf.kotlin.DslList.plusAssign(values: kotlin.collections.Iterable) {
addAll(values)
}
/**
*
* A list of MIME types the APIs can produce. This is global to all APIs but
* can be overridden on specific API calls. Value MUST be as described under
* Mime Types.
*
*
* repeated string produces = 7;
* @param index The index to set the value at.
* @param value The produces to set.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("setProduces")
public operator fun com.google.protobuf.kotlin.DslList.set(index: kotlin.Int, value: kotlin.String) {
_builder.setProduces(index, value)
}/**
*
* A list of MIME types the APIs can produce. This is global to all APIs but
* can be overridden on specific API calls. Value MUST be as described under
* Mime Types.
*
*
* repeated string produces = 7;
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("clearProduces")
public fun com.google.protobuf.kotlin.DslList.clear() {
_builder.clearProduces()
}
/**
* An uninstantiable, behaviorless type to represent the field in
* generics.
*/
@kotlin.OptIn(com.google.protobuf.kotlin.OnlyForUseByGeneratedProtoCode::class)
public class ResponsesProxy private constructor() : com.google.protobuf.kotlin.DslProxy()
/**
*
* An object to hold responses that can be used across operations. This
* property does not define global responses for all operations.
*
*
* map<string, .grpc.gateway.protoc_gen_openapiv2.options.Response> responses = 10;
*/
public val responses: com.google.protobuf.kotlin.DslMap
@kotlin.jvm.JvmSynthetic
@JvmName("getResponsesMap")
get() = com.google.protobuf.kotlin.DslMap(
_builder.getResponsesMap()
)
/**
*
* An object to hold responses that can be used across operations. This
* property does not define global responses for all operations.
*
*
* map<string, .grpc.gateway.protoc_gen_openapiv2.options.Response> responses = 10;
*/
@JvmName("putResponses")
public fun com.google.protobuf.kotlin.DslMap
.put(key: kotlin.String, value: grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.Response) {
_builder.putResponses(key, value)
}
/**
*
* An object to hold responses that can be used across operations. This
* property does not define global responses for all operations.
*
*
* map<string, .grpc.gateway.protoc_gen_openapiv2.options.Response> responses = 10;
*/
@kotlin.jvm.JvmSynthetic
@JvmName("setResponses")
@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.Response) {
put(key, value)
}
/**
*
* An object to hold responses that can be used across operations. This
* property does not define global responses for all operations.
*
*
* map<string, .grpc.gateway.protoc_gen_openapiv2.options.Response> responses = 10;
*/
@kotlin.jvm.JvmSynthetic
@JvmName("removeResponses")
public fun com.google.protobuf.kotlin.DslMap
.remove(key: kotlin.String) {
_builder.removeResponses(key)
}
/**
*
* An object to hold responses that can be used across operations. This
* property does not define global responses for all operations.
*
*
* map<string, .grpc.gateway.protoc_gen_openapiv2.options.Response> responses = 10;
*/
@kotlin.jvm.JvmSynthetic
@JvmName("putAllResponses")
public fun com.google.protobuf.kotlin.DslMap
.putAll(map: kotlin.collections.Map) {
_builder.putAllResponses(map)
}
/**
*
* An object to hold responses that can be used across operations. This
* property does not define global responses for all operations.
*
*
* map<string, .grpc.gateway.protoc_gen_openapiv2.options.Response> responses = 10;
*/
@kotlin.jvm.JvmSynthetic
@JvmName("clearResponses")
public fun com.google.protobuf.kotlin.DslMap
.clear() {
_builder.clearResponses()
}
/**
*
* Security scheme definitions that can be used across the specification.
*
*
* .grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions security_definitions = 11;
*/
public var securityDefinitions: grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.SecurityDefinitions
@JvmName("getSecurityDefinitions")
get() = _builder.getSecurityDefinitions()
@JvmName("setSecurityDefinitions")
set(value) {
_builder.setSecurityDefinitions(value)
}
/**
*
* Security scheme definitions that can be used across the specification.
*
*
* .grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions security_definitions = 11;
*/
public fun clearSecurityDefinitions() {
_builder.clearSecurityDefinitions()
}
/**
*
* Security scheme definitions that can be used across the specification.
*
*
* .grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions security_definitions = 11;
* @return Whether the securityDefinitions field is set.
*/
public fun hasSecurityDefinitions(): kotlin.Boolean {
return _builder.hasSecurityDefinitions()
}
/**
* An uninstantiable, behaviorless type to represent the field in
* generics.
*/
@kotlin.OptIn(com.google.protobuf.kotlin.OnlyForUseByGeneratedProtoCode::class)
public class SecurityProxy private constructor() : com.google.protobuf.kotlin.DslProxy()
/**
*
* A declaration of which security schemes are applied for the API as a whole.
* The list of values describes alternative security schemes that can be used
* (that is, there is a logical OR between the security requirements).
* Individual operations can override this definition.
*
*
* repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;
*/
public val security: com.google.protobuf.kotlin.DslList
@kotlin.jvm.JvmSynthetic
get() = com.google.protobuf.kotlin.DslList(
_builder.getSecurityList()
)
/**
*
* A declaration of which security schemes are applied for the API as a whole.
* The list of values describes alternative security schemes that can be used
* (that is, there is a logical OR between the security requirements).
* Individual operations can override this definition.
*
*
* repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;
* @param value The security to add.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("addSecurity")
public fun com.google.protobuf.kotlin.DslList.add(value: grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.SecurityRequirement) {
_builder.addSecurity(value)
}
/**
*
* A declaration of which security schemes are applied for the API as a whole.
* The list of values describes alternative security schemes that can be used
* (that is, there is a logical OR between the security requirements).
* Individual operations can override this definition.
*
*
* repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;
* @param value The security to add.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("plusAssignSecurity")
@Suppress("NOTHING_TO_INLINE")
public inline operator fun com.google.protobuf.kotlin.DslList.plusAssign(value: grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.SecurityRequirement) {
add(value)
}
/**
*
* A declaration of which security schemes are applied for the API as a whole.
* The list of values describes alternative security schemes that can be used
* (that is, there is a logical OR between the security requirements).
* Individual operations can override this definition.
*
*
* repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;
* @param values The security to add.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("addAllSecurity")
public fun com.google.protobuf.kotlin.DslList.addAll(values: kotlin.collections.Iterable) {
_builder.addAllSecurity(values)
}
/**
*
* A declaration of which security schemes are applied for the API as a whole.
* The list of values describes alternative security schemes that can be used
* (that is, there is a logical OR between the security requirements).
* Individual operations can override this definition.
*
*
* repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;
* @param values The security to add.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("plusAssignAllSecurity")
@Suppress("NOTHING_TO_INLINE")
public inline operator fun com.google.protobuf.kotlin.DslList.plusAssign(values: kotlin.collections.Iterable) {
addAll(values)
}
/**
*
* A declaration of which security schemes are applied for the API as a whole.
* The list of values describes alternative security schemes that can be used
* (that is, there is a logical OR between the security requirements).
* Individual operations can override this definition.
*
*
* repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;
* @param index The index to set the value at.
* @param value The security to set.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("setSecurity")
public operator fun com.google.protobuf.kotlin.DslList.set(index: kotlin.Int, value: grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.SecurityRequirement) {
_builder.setSecurity(index, value)
}
/**
*
* A declaration of which security schemes are applied for the API as a whole.
* The list of values describes alternative security schemes that can be used
* (that is, there is a logical OR between the security requirements).
* Individual operations can override this definition.
*
*
* repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12;
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("clearSecurity")
public fun com.google.protobuf.kotlin.DslList.clear() {
_builder.clearSecurity()
}
/**
* An uninstantiable, behaviorless type to represent the field in
* generics.
*/
@kotlin.OptIn(com.google.protobuf.kotlin.OnlyForUseByGeneratedProtoCode::class)
public class TagsProxy private constructor() : com.google.protobuf.kotlin.DslProxy()
/**
*
* A list of tags for API documentation control. Tags can be used for logical
* grouping of operations by resources or any other qualifier.
*
*
* repeated .grpc.gateway.protoc_gen_openapiv2.options.Tag tags = 13;
*/
public val tags: com.google.protobuf.kotlin.DslList
@kotlin.jvm.JvmSynthetic
get() = com.google.protobuf.kotlin.DslList(
_builder.getTagsList()
)
/**
*
* A list of tags for API documentation control. Tags can be used for logical
* grouping of operations by resources or any other qualifier.
*
*
* repeated .grpc.gateway.protoc_gen_openapiv2.options.Tag tags = 13;
* @param value The tags to add.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("addTags")
public fun com.google.protobuf.kotlin.DslList.add(value: grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.Tag) {
_builder.addTags(value)
}
/**
*
* A list of tags for API documentation control. Tags can be used for logical
* grouping of operations by resources or any other qualifier.
*
*
* repeated .grpc.gateway.protoc_gen_openapiv2.options.Tag tags = 13;
* @param value The tags to add.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("plusAssignTags")
@Suppress("NOTHING_TO_INLINE")
public inline operator fun com.google.protobuf.kotlin.DslList.plusAssign(value: grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.Tag) {
add(value)
}
/**
*
* A list of tags for API documentation control. Tags can be used for logical
* grouping of operations by resources or any other qualifier.
*
*
* repeated .grpc.gateway.protoc_gen_openapiv2.options.Tag tags = 13;
* @param values The tags to add.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("addAllTags")
public fun com.google.protobuf.kotlin.DslList.addAll(values: kotlin.collections.Iterable) {
_builder.addAllTags(values)
}
/**
*
* A list of tags for API documentation control. Tags can be used for logical
* grouping of operations by resources or any other qualifier.
*
*
* repeated .grpc.gateway.protoc_gen_openapiv2.options.Tag tags = 13;
* @param values The tags to add.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("plusAssignAllTags")
@Suppress("NOTHING_TO_INLINE")
public inline operator fun com.google.protobuf.kotlin.DslList.plusAssign(values: kotlin.collections.Iterable) {
addAll(values)
}
/**
*
* A list of tags for API documentation control. Tags can be used for logical
* grouping of operations by resources or any other qualifier.
*
*
* repeated .grpc.gateway.protoc_gen_openapiv2.options.Tag tags = 13;
* @param index The index to set the value at.
* @param value The tags to set.
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("setTags")
public operator fun com.google.protobuf.kotlin.DslList.set(index: kotlin.Int, value: grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.Tag) {
_builder.setTags(index, value)
}
/**
*
* A list of tags for API documentation control. Tags can be used for logical
* grouping of operations by resources or any other qualifier.
*
*
* repeated .grpc.gateway.protoc_gen_openapiv2.options.Tag tags = 13;
*/
@kotlin.jvm.JvmSynthetic
@kotlin.jvm.JvmName("clearTags")
public fun com.google.protobuf.kotlin.DslList.clear() {
_builder.clearTags()
}
/**
*
* Additional external documentation.
*
*
* .grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 14;
*/
public var externalDocs: grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.ExternalDocumentation
@JvmName("getExternalDocs")
get() = _builder.getExternalDocs()
@JvmName("setExternalDocs")
set(value) {
_builder.setExternalDocs(value)
}
/**
*
* Additional external documentation.
*
*
* .grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 14;
*/
public fun clearExternalDocs() {
_builder.clearExternalDocs()
}
/**
*
* Additional external documentation.
*
*
* .grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 14;
* @return Whether the externalDocs field is set.
*/
public fun hasExternalDocs(): kotlin.Boolean {
return _builder.hasExternalDocs()
}
/**
* 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 = 15;
*/
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 = 15;
*/
@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 = 15;
*/
@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 = 15;
*/
@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 = 15;
*/
@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 = 15;
*/
@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.Swagger.copy(block: grpc.gateway.protoc_gen_openapiv2.options.SwaggerKt.Dsl.() -> kotlin.Unit): grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.Swagger =
grpc.gateway.protoc_gen_openapiv2.options.SwaggerKt.Dsl._create(this.toBuilder()).apply { block() }._build()
public val grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.SwaggerOrBuilder.infoOrNull: grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.Info?
get() = if (hasInfo()) getInfo() else null
public val grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.SwaggerOrBuilder.securityDefinitionsOrNull: grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.SecurityDefinitions?
get() = if (hasSecurityDefinitions()) getSecurityDefinitions() else null
public val grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.SwaggerOrBuilder.externalDocsOrNull: grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.ExternalDocumentation?
get() = if (hasExternalDocs()) getExternalDocs() else null
© 2015 - 2025 Weber Informatics LLC | Privacy Policy