public static final class Openapiv2.Swagger.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Swagger.Builder> implements Openapiv2.SwaggerOrBuilder
`Swagger` is a representation of OpenAPI v2 specification's Swagger object.
See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#swaggerObject
Example:
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_swagger) = {
info: {
title: "Echo API";
version: "1.0";
description: ";
contact: {
name: "gRPC-Gateway project";
url: "https://github.com/grpc-ecosystem/grpc-gateway";
email: "none@example.com";
};
license: {
name: "BSD 3-Clause License";
url: "https://github.com/grpc-ecosystem/grpc-gateway/blob/master/LICENSE.txt";
};
};
schemes: HTTPS;
consumes: "application/json";
produces: "application/json";
};
Protobuf type grpc.gateway.protoc_gen_openapiv2.options.Swagger| Modifier and Type | Method and Description |
|---|---|
Openapiv2.Swagger.Builder |
addAllConsumes(java.lang.Iterable<java.lang.String> values)
A list of MIME types the APIs can consume.
|
Openapiv2.Swagger.Builder |
addAllProduces(java.lang.Iterable<java.lang.String> values)
A list of MIME types the APIs can produce.
|
Openapiv2.Swagger.Builder |
addAllSchemes(java.lang.Iterable<? extends Openapiv2.Scheme> values)
The transfer protocol of the API.
|
Openapiv2.Swagger.Builder |
addAllSchemesValue(java.lang.Iterable<java.lang.Integer> values)
The transfer protocol of the API.
|
Openapiv2.Swagger.Builder |
addAllSecurity(java.lang.Iterable<? extends Openapiv2.SecurityRequirement> values)
A declaration of which security schemes are applied for the API as a whole.
|
Openapiv2.Swagger.Builder |
addConsumes(java.lang.String value)
A list of MIME types the APIs can consume.
|
Openapiv2.Swagger.Builder |
addConsumesBytes(com.google.protobuf.ByteString value)
A list of MIME types the APIs can consume.
|
Openapiv2.Swagger.Builder |
addProduces(java.lang.String value)
A list of MIME types the APIs can produce.
|
Openapiv2.Swagger.Builder |
addProducesBytes(com.google.protobuf.ByteString value)
A list of MIME types the APIs can produce.
|
Openapiv2.Swagger.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
java.lang.Object value) |
Openapiv2.Swagger.Builder |
addSchemes(Openapiv2.Scheme value)
The transfer protocol of the API.
|
Openapiv2.Swagger.Builder |
addSchemesValue(int value)
The transfer protocol of the API.
|
Openapiv2.Swagger.Builder |
addSecurity(int index,
Openapiv2.SecurityRequirement.Builder builderForValue)
A declaration of which security schemes are applied for the API as a whole.
|
Openapiv2.Swagger.Builder |
addSecurity(int index,
Openapiv2.SecurityRequirement value)
A declaration of which security schemes are applied for the API as a whole.
|
Openapiv2.Swagger.Builder |
addSecurity(Openapiv2.SecurityRequirement.Builder builderForValue)
A declaration of which security schemes are applied for the API as a whole.
|
Openapiv2.Swagger.Builder |
addSecurity(Openapiv2.SecurityRequirement value)
A declaration of which security schemes are applied for the API as a whole.
|
Openapiv2.SecurityRequirement.Builder |
addSecurityBuilder()
A declaration of which security schemes are applied for the API as a whole.
|
Openapiv2.SecurityRequirement.Builder |
addSecurityBuilder(int index)
A declaration of which security schemes are applied for the API as a whole.
|
Openapiv2.Swagger |
build() |
Openapiv2.Swagger |
buildPartial() |
Openapiv2.Swagger.Builder |
clear() |
Openapiv2.Swagger.Builder |
clearBasePath()
The base path on which the API is served, which is relative to the host.
|
Openapiv2.Swagger.Builder |
clearConsumes()
A list of MIME types the APIs can consume.
|
Openapiv2.Swagger.Builder |
clearExtensions() |
Openapiv2.Swagger.Builder |
clearExternalDocs()
Additional external documentation.
|
Openapiv2.Swagger.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
Openapiv2.Swagger.Builder |
clearHost()
The host (name or ip) serving the API.
|
Openapiv2.Swagger.Builder |
clearInfo()
Provides metadata about the API.
|
Openapiv2.Swagger.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
Openapiv2.Swagger.Builder |
clearProduces()
A list of MIME types the APIs can produce.
|
Openapiv2.Swagger.Builder |
clearResponses() |
Openapiv2.Swagger.Builder |
clearSchemes()
The transfer protocol of the API.
|
Openapiv2.Swagger.Builder |
clearSecurity()
A declaration of which security schemes are applied for the API as a whole.
|
Openapiv2.Swagger.Builder |
clearSecurityDefinitions()
Security scheme definitions that can be used across the specification.
|
Openapiv2.Swagger.Builder |
clearSwagger()
Specifies the OpenAPI Specification version being used.
|
Openapiv2.Swagger.Builder |
clone() |
boolean |
containsExtensions(java.lang.String key)
map<string, .google.protobuf.Value> extensions = 15; |
boolean |
containsResponses(java.lang.String key)
An object to hold responses that can be used across operations.
|
java.lang.String |
getBasePath()
The base path on which the API is served, which is relative to the host.
|
com.google.protobuf.ByteString |
getBasePathBytes()
The base path on which the API is served, which is relative to the host.
|
java.lang.String |
getConsumes(int index)
A list of MIME types the APIs can consume.
|
com.google.protobuf.ByteString |
getConsumesBytes(int index)
A list of MIME types the APIs can consume.
|
int |
getConsumesCount()
A list of MIME types the APIs can consume.
|
com.google.protobuf.ProtocolStringList |
getConsumesList()
A list of MIME types the APIs can consume.
|
Openapiv2.Swagger |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
java.util.Map<java.lang.String,com.google.protobuf.Value> |
getExtensions()
Deprecated.
|
int |
getExtensionsCount()
map<string, .google.protobuf.Value> extensions = 15; |
java.util.Map<java.lang.String,com.google.protobuf.Value> |
getExtensionsMap()
map<string, .google.protobuf.Value> extensions = 15; |
com.google.protobuf.Value |
getExtensionsOrDefault(java.lang.String key,
com.google.protobuf.Value defaultValue)
map<string, .google.protobuf.Value> extensions = 15; |
com.google.protobuf.Value |
getExtensionsOrThrow(java.lang.String key)
map<string, .google.protobuf.Value> extensions = 15; |
Openapiv2.ExternalDocumentation |
getExternalDocs()
Additional external documentation.
|
Openapiv2.ExternalDocumentation.Builder |
getExternalDocsBuilder()
Additional external documentation.
|
Openapiv2.ExternalDocumentationOrBuilder |
getExternalDocsOrBuilder()
Additional external documentation.
|
java.lang.String |
getHost()
The host (name or ip) serving the API.
|
com.google.protobuf.ByteString |
getHostBytes()
The host (name or ip) serving the API.
|
Openapiv2.Info |
getInfo()
Provides metadata about the API.
|
Openapiv2.Info.Builder |
getInfoBuilder()
Provides metadata about the API.
|
Openapiv2.InfoOrBuilder |
getInfoOrBuilder()
Provides metadata about the API.
|
java.util.Map<java.lang.String,com.google.protobuf.Value> |
getMutableExtensions()
Deprecated.
|
java.util.Map<java.lang.String,Openapiv2.Response> |
getMutableResponses()
Deprecated.
|
java.lang.String |
getProduces(int index)
A list of MIME types the APIs can produce.
|
com.google.protobuf.ByteString |
getProducesBytes(int index)
A list of MIME types the APIs can produce.
|
int |
getProducesCount()
A list of MIME types the APIs can produce.
|
com.google.protobuf.ProtocolStringList |
getProducesList()
A list of MIME types the APIs can produce.
|
java.util.Map<java.lang.String,Openapiv2.Response> |
getResponses()
Deprecated.
|
int |
getResponsesCount()
An object to hold responses that can be used across operations.
|
java.util.Map<java.lang.String,Openapiv2.Response> |
getResponsesMap()
An object to hold responses that can be used across operations.
|
Openapiv2.Response |
getResponsesOrDefault(java.lang.String key,
Openapiv2.Response defaultValue)
An object to hold responses that can be used across operations.
|
Openapiv2.Response |
getResponsesOrThrow(java.lang.String key)
An object to hold responses that can be used across operations.
|
Openapiv2.Scheme |
getSchemes(int index)
The transfer protocol of the API.
|
int |
getSchemesCount()
The transfer protocol of the API.
|
java.util.List<Openapiv2.Scheme> |
getSchemesList()
The transfer protocol of the API.
|
int |
getSchemesValue(int index)
The transfer protocol of the API.
|
java.util.List<java.lang.Integer> |
getSchemesValueList()
The transfer protocol of the API.
|
Openapiv2.SecurityRequirement |
getSecurity(int index)
A declaration of which security schemes are applied for the API as a whole.
|
Openapiv2.SecurityRequirement.Builder |
getSecurityBuilder(int index)
A declaration of which security schemes are applied for the API as a whole.
|
java.util.List<Openapiv2.SecurityRequirement.Builder> |
getSecurityBuilderList()
A declaration of which security schemes are applied for the API as a whole.
|
int |
getSecurityCount()
A declaration of which security schemes are applied for the API as a whole.
|
Openapiv2.SecurityDefinitions |
getSecurityDefinitions()
Security scheme definitions that can be used across the specification.
|
Openapiv2.SecurityDefinitions.Builder |
getSecurityDefinitionsBuilder()
Security scheme definitions that can be used across the specification.
|
Openapiv2.SecurityDefinitionsOrBuilder |
getSecurityDefinitionsOrBuilder()
Security scheme definitions that can be used across the specification.
|
java.util.List<Openapiv2.SecurityRequirement> |
getSecurityList()
A declaration of which security schemes are applied for the API as a whole.
|
Openapiv2.SecurityRequirementOrBuilder |
getSecurityOrBuilder(int index)
A declaration of which security schemes are applied for the API as a whole.
|
java.util.List<? extends Openapiv2.SecurityRequirementOrBuilder> |
getSecurityOrBuilderList()
A declaration of which security schemes are applied for the API as a whole.
|
java.lang.String |
getSwagger()
Specifies the OpenAPI Specification version being used.
|
com.google.protobuf.ByteString |
getSwaggerBytes()
Specifies the OpenAPI Specification version being used.
|
boolean |
hasExternalDocs()
Additional external documentation.
|
boolean |
hasInfo()
Provides metadata about the API.
|
boolean |
hasSecurityDefinitions()
Security scheme definitions that can be used across the specification.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapField |
internalGetMapField(int number) |
protected com.google.protobuf.MapField |
internalGetMutableMapField(int number) |
boolean |
isInitialized() |
Openapiv2.Swagger.Builder |
mergeExternalDocs(Openapiv2.ExternalDocumentation value)
Additional external documentation.
|
Openapiv2.Swagger.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
Openapiv2.Swagger.Builder |
mergeFrom(com.google.protobuf.Message other) |
Openapiv2.Swagger.Builder |
mergeFrom(Openapiv2.Swagger other) |
Openapiv2.Swagger.Builder |
mergeInfo(Openapiv2.Info value)
Provides metadata about the API.
|
Openapiv2.Swagger.Builder |
mergeSecurityDefinitions(Openapiv2.SecurityDefinitions value)
Security scheme definitions that can be used across the specification.
|
Openapiv2.Swagger.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
Openapiv2.Swagger.Builder |
putAllExtensions(java.util.Map<java.lang.String,com.google.protobuf.Value> values)
map<string, .google.protobuf.Value> extensions = 15; |
Openapiv2.Swagger.Builder |
putAllResponses(java.util.Map<java.lang.String,Openapiv2.Response> values)
An object to hold responses that can be used across operations.
|
Openapiv2.Swagger.Builder |
putExtensions(java.lang.String key,
com.google.protobuf.Value value)
map<string, .google.protobuf.Value> extensions = 15; |
Openapiv2.Swagger.Builder |
putResponses(java.lang.String key,
Openapiv2.Response value)
An object to hold responses that can be used across operations.
|
Openapiv2.Swagger.Builder |
removeExtensions(java.lang.String key)
map<string, .google.protobuf.Value> extensions = 15; |
Openapiv2.Swagger.Builder |
removeResponses(java.lang.String key)
An object to hold responses that can be used across operations.
|
Openapiv2.Swagger.Builder |
removeSecurity(int index)
A declaration of which security schemes are applied for the API as a whole.
|
Openapiv2.Swagger.Builder |
setBasePath(java.lang.String value)
The base path on which the API is served, which is relative to the host.
|
Openapiv2.Swagger.Builder |
setBasePathBytes(com.google.protobuf.ByteString value)
The base path on which the API is served, which is relative to the host.
|
Openapiv2.Swagger.Builder |
setConsumes(int index,
java.lang.String value)
A list of MIME types the APIs can consume.
|
Openapiv2.Swagger.Builder |
setExternalDocs(Openapiv2.ExternalDocumentation.Builder builderForValue)
Additional external documentation.
|
Openapiv2.Swagger.Builder |
setExternalDocs(Openapiv2.ExternalDocumentation value)
Additional external documentation.
|
Openapiv2.Swagger.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
java.lang.Object value) |
Openapiv2.Swagger.Builder |
setHost(java.lang.String value)
The host (name or ip) serving the API.
|
Openapiv2.Swagger.Builder |
setHostBytes(com.google.protobuf.ByteString value)
The host (name or ip) serving the API.
|
Openapiv2.Swagger.Builder |
setInfo(Openapiv2.Info.Builder builderForValue)
Provides metadata about the API.
|
Openapiv2.Swagger.Builder |
setInfo(Openapiv2.Info value)
Provides metadata about the API.
|
Openapiv2.Swagger.Builder |
setProduces(int index,
java.lang.String value)
A list of MIME types the APIs can produce.
|
Openapiv2.Swagger.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
java.lang.Object value) |
Openapiv2.Swagger.Builder |
setSchemes(int index,
Openapiv2.Scheme value)
The transfer protocol of the API.
|
Openapiv2.Swagger.Builder |
setSchemesValue(int index,
int value)
The transfer protocol of the API.
|
Openapiv2.Swagger.Builder |
setSecurity(int index,
Openapiv2.SecurityRequirement.Builder builderForValue)
A declaration of which security schemes are applied for the API as a whole.
|
Openapiv2.Swagger.Builder |
setSecurity(int index,
Openapiv2.SecurityRequirement value)
A declaration of which security schemes are applied for the API as a whole.
|
Openapiv2.Swagger.Builder |
setSecurityDefinitions(Openapiv2.SecurityDefinitions.Builder builderForValue)
Security scheme definitions that can be used across the specification.
|
Openapiv2.Swagger.Builder |
setSecurityDefinitions(Openapiv2.SecurityDefinitions value)
Security scheme definitions that can be used across the specification.
|
Openapiv2.Swagger.Builder |
setSwagger(java.lang.String value)
Specifies the OpenAPI Specification version being used.
|
Openapiv2.Swagger.Builder |
setSwaggerBytes(com.google.protobuf.ByteString value)
Specifies the OpenAPI Specification version being used.
|
Openapiv2.Swagger.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapField internalGetMapField(int number)
internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Swagger.Builder>protected com.google.protobuf.MapField internalGetMutableMapField(int number)
internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Swagger.Builder>protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Swagger.Builder>public Openapiv2.Swagger.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Swagger.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Swagger.Builder>public Openapiv2.Swagger getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic Openapiv2.Swagger build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic Openapiv2.Swagger buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic Openapiv2.Swagger.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Swagger.Builder>public Openapiv2.Swagger.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Swagger.Builder>public Openapiv2.Swagger.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Swagger.Builder>public Openapiv2.Swagger.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Swagger.Builder>public Openapiv2.Swagger.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Swagger.Builder>public Openapiv2.Swagger.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Swagger.Builder>public Openapiv2.Swagger.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Openapiv2.Swagger.Builder>public Openapiv2.Swagger.Builder mergeFrom(Openapiv2.Swagger other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Swagger.Builder>public Openapiv2.Swagger.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws java.io.IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Openapiv2.Swagger.Builder>java.io.IOExceptionpublic java.lang.String getSwagger()
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;getSwagger in interface Openapiv2.SwaggerOrBuilderpublic com.google.protobuf.ByteString getSwaggerBytes()
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;getSwaggerBytes in interface Openapiv2.SwaggerOrBuilderpublic Openapiv2.Swagger.Builder setSwagger(java.lang.String 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;value - The swagger to set.public Openapiv2.Swagger.Builder clearSwagger()
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 Openapiv2.Swagger.Builder setSwaggerBytes(com.google.protobuf.ByteString 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;value - The bytes for swagger to set.public boolean hasInfo()
Provides metadata about the API. The metadata can be used by the clients if needed.
.grpc.gateway.protoc_gen_openapiv2.options.Info info = 2;hasInfo in interface Openapiv2.SwaggerOrBuilderpublic Openapiv2.Info getInfo()
Provides metadata about the API. The metadata can be used by the clients if needed.
.grpc.gateway.protoc_gen_openapiv2.options.Info info = 2;getInfo in interface Openapiv2.SwaggerOrBuilderpublic Openapiv2.Swagger.Builder setInfo(Openapiv2.Info 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 Openapiv2.Swagger.Builder setInfo(Openapiv2.Info.Builder builderForValue)
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 Openapiv2.Swagger.Builder mergeInfo(Openapiv2.Info 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 Openapiv2.Swagger.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;public Openapiv2.Info.Builder getInfoBuilder()
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 Openapiv2.InfoOrBuilder getInfoOrBuilder()
Provides metadata about the API. The metadata can be used by the clients if needed.
.grpc.gateway.protoc_gen_openapiv2.options.Info info = 2;getInfoOrBuilder in interface Openapiv2.SwaggerOrBuilderpublic java.lang.String getHost()
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;getHost in interface Openapiv2.SwaggerOrBuilderpublic com.google.protobuf.ByteString getHostBytes()
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;getHostBytes in interface Openapiv2.SwaggerOrBuilderpublic Openapiv2.Swagger.Builder setHost(java.lang.String 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;value - The host to set.public Openapiv2.Swagger.Builder clearHost()
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 Openapiv2.Swagger.Builder setHostBytes(com.google.protobuf.ByteString 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;value - The bytes for host to set.public java.lang.String getBasePath()
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;getBasePath in interface Openapiv2.SwaggerOrBuilderpublic com.google.protobuf.ByteString getBasePathBytes()
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;getBasePathBytes in interface Openapiv2.SwaggerOrBuilderpublic Openapiv2.Swagger.Builder setBasePath(java.lang.String 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;value - The basePath to set.public Openapiv2.Swagger.Builder clearBasePath()
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 Openapiv2.Swagger.Builder setBasePathBytes(com.google.protobuf.ByteString 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;value - The bytes for basePath to set.public java.util.List<Openapiv2.Scheme> 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;getSchemesList in interface Openapiv2.SwaggerOrBuilderpublic int getSchemesCount()
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;getSchemesCount in interface Openapiv2.SwaggerOrBuilderpublic Openapiv2.Scheme getSchemes(int index)
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;getSchemes in interface Openapiv2.SwaggerOrBuilderindex - The index of the element to return.public Openapiv2.Swagger.Builder setSchemes(int index, Openapiv2.Scheme 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;index - The index to set the value at.value - The schemes to set.public Openapiv2.Swagger.Builder addSchemes(Openapiv2.Scheme 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;value - The schemes to add.public Openapiv2.Swagger.Builder addAllSchemes(java.lang.Iterable<? extends Openapiv2.Scheme> 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;values - The schemes to add.public Openapiv2.Swagger.Builder clearSchemes()
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 java.util.List<java.lang.Integer> getSchemesValueList()
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;getSchemesValueList in interface Openapiv2.SwaggerOrBuilderpublic int getSchemesValue(int index)
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;getSchemesValue in interface Openapiv2.SwaggerOrBuilderindex - The index of the value to return.public Openapiv2.Swagger.Builder setSchemesValue(int index, int 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;index - The index of the value to return.public Openapiv2.Swagger.Builder addSchemesValue(int 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;value - The enum numeric value on the wire for schemes to add.public Openapiv2.Swagger.Builder addAllSchemesValue(java.lang.Iterable<java.lang.Integer> 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;values - The enum numeric values on the wire for schemes to add.public com.google.protobuf.ProtocolStringList 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;getConsumesList in interface Openapiv2.SwaggerOrBuilderpublic int getConsumesCount()
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;getConsumesCount in interface Openapiv2.SwaggerOrBuilderpublic java.lang.String getConsumes(int index)
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;getConsumes in interface Openapiv2.SwaggerOrBuilderindex - The index of the element to return.public com.google.protobuf.ByteString getConsumesBytes(int index)
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;getConsumesBytes in interface Openapiv2.SwaggerOrBuilderindex - The index of the value to return.public Openapiv2.Swagger.Builder setConsumes(int index, java.lang.String 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;index - The index to set the value at.value - The consumes to set.public Openapiv2.Swagger.Builder addConsumes(java.lang.String 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;value - The consumes to add.public Openapiv2.Swagger.Builder addAllConsumes(java.lang.Iterable<java.lang.String> 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;values - The consumes to add.public Openapiv2.Swagger.Builder clearConsumes()
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;public Openapiv2.Swagger.Builder addConsumesBytes(com.google.protobuf.ByteString 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;value - The bytes of the consumes to add.public com.google.protobuf.ProtocolStringList 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;getProducesList in interface Openapiv2.SwaggerOrBuilderpublic int getProducesCount()
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;getProducesCount in interface Openapiv2.SwaggerOrBuilderpublic java.lang.String getProduces(int index)
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;getProduces in interface Openapiv2.SwaggerOrBuilderindex - The index of the element to return.public com.google.protobuf.ByteString getProducesBytes(int index)
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;getProducesBytes in interface Openapiv2.SwaggerOrBuilderindex - The index of the value to return.public Openapiv2.Swagger.Builder setProduces(int index, java.lang.String 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;index - The index to set the value at.value - The produces to set.public Openapiv2.Swagger.Builder addProduces(java.lang.String 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;value - The produces to add.public Openapiv2.Swagger.Builder addAllProduces(java.lang.Iterable<java.lang.String> 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;values - The produces to add.public Openapiv2.Swagger.Builder clearProduces()
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;public Openapiv2.Swagger.Builder addProducesBytes(com.google.protobuf.ByteString 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;value - The bytes of the produces to add.public int getResponsesCount()
Openapiv2.SwaggerOrBuilderAn 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;getResponsesCount in interface Openapiv2.SwaggerOrBuilderpublic boolean containsResponses(java.lang.String 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;containsResponses in interface Openapiv2.SwaggerOrBuilder@Deprecated public java.util.Map<java.lang.String,Openapiv2.Response> getResponses()
getResponsesMap() instead.getResponses in interface Openapiv2.SwaggerOrBuilderpublic java.util.Map<java.lang.String,Openapiv2.Response> 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;getResponsesMap in interface Openapiv2.SwaggerOrBuilderpublic Openapiv2.Response getResponsesOrDefault(java.lang.String key, Openapiv2.Response defaultValue)
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;getResponsesOrDefault in interface Openapiv2.SwaggerOrBuilderpublic Openapiv2.Response getResponsesOrThrow(java.lang.String 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;getResponsesOrThrow in interface Openapiv2.SwaggerOrBuilderpublic Openapiv2.Swagger.Builder clearResponses()
public Openapiv2.Swagger.Builder removeResponses(java.lang.String 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;@Deprecated public java.util.Map<java.lang.String,Openapiv2.Response> getMutableResponses()
public Openapiv2.Swagger.Builder putResponses(java.lang.String key, Openapiv2.Response 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;public Openapiv2.Swagger.Builder putAllResponses(java.util.Map<java.lang.String,Openapiv2.Response> values)
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 boolean hasSecurityDefinitions()
Security scheme definitions that can be used across the specification.
.grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions security_definitions = 11;hasSecurityDefinitions in interface Openapiv2.SwaggerOrBuilderpublic Openapiv2.SecurityDefinitions getSecurityDefinitions()
Security scheme definitions that can be used across the specification.
.grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions security_definitions = 11;getSecurityDefinitions in interface Openapiv2.SwaggerOrBuilderpublic Openapiv2.Swagger.Builder setSecurityDefinitions(Openapiv2.SecurityDefinitions value)
Security scheme definitions that can be used across the specification.
.grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions security_definitions = 11;public Openapiv2.Swagger.Builder setSecurityDefinitions(Openapiv2.SecurityDefinitions.Builder builderForValue)
Security scheme definitions that can be used across the specification.
.grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions security_definitions = 11;public Openapiv2.Swagger.Builder mergeSecurityDefinitions(Openapiv2.SecurityDefinitions value)
Security scheme definitions that can be used across the specification.
.grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions security_definitions = 11;public Openapiv2.Swagger.Builder clearSecurityDefinitions()
Security scheme definitions that can be used across the specification.
.grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions security_definitions = 11;public Openapiv2.SecurityDefinitions.Builder getSecurityDefinitionsBuilder()
Security scheme definitions that can be used across the specification.
.grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions security_definitions = 11;public Openapiv2.SecurityDefinitionsOrBuilder getSecurityDefinitionsOrBuilder()
Security scheme definitions that can be used across the specification.
.grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions security_definitions = 11;getSecurityDefinitionsOrBuilder in interface Openapiv2.SwaggerOrBuilderpublic java.util.List<Openapiv2.SecurityRequirement> 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;getSecurityList in interface Openapiv2.SwaggerOrBuilderpublic int getSecurityCount()
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;getSecurityCount in interface Openapiv2.SwaggerOrBuilderpublic Openapiv2.SecurityRequirement getSecurity(int index)
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;getSecurity in interface Openapiv2.SwaggerOrBuilderpublic Openapiv2.Swagger.Builder setSecurity(int index, Openapiv2.SecurityRequirement 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;public Openapiv2.Swagger.Builder setSecurity(int index, Openapiv2.SecurityRequirement.Builder builderForValue)
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 Openapiv2.Swagger.Builder addSecurity(Openapiv2.SecurityRequirement 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;public Openapiv2.Swagger.Builder addSecurity(int index, Openapiv2.SecurityRequirement 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;public Openapiv2.Swagger.Builder addSecurity(Openapiv2.SecurityRequirement.Builder builderForValue)
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 Openapiv2.Swagger.Builder addSecurity(int index, Openapiv2.SecurityRequirement.Builder builderForValue)
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 Openapiv2.Swagger.Builder addAllSecurity(java.lang.Iterable<? extends Openapiv2.SecurityRequirement> 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;public Openapiv2.Swagger.Builder clearSecurity()
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 Openapiv2.Swagger.Builder removeSecurity(int index)
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 Openapiv2.SecurityRequirement.Builder getSecurityBuilder(int index)
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 Openapiv2.SecurityRequirementOrBuilder getSecurityOrBuilder(int index)
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;getSecurityOrBuilder in interface Openapiv2.SwaggerOrBuilderpublic java.util.List<? extends Openapiv2.SecurityRequirementOrBuilder> getSecurityOrBuilderList()
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;getSecurityOrBuilderList in interface Openapiv2.SwaggerOrBuilderpublic Openapiv2.SecurityRequirement.Builder addSecurityBuilder()
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 Openapiv2.SecurityRequirement.Builder addSecurityBuilder(int index)
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 java.util.List<Openapiv2.SecurityRequirement.Builder> getSecurityBuilderList()
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 boolean hasExternalDocs()
Additional external documentation.
.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 14;hasExternalDocs in interface Openapiv2.SwaggerOrBuilderpublic Openapiv2.ExternalDocumentation getExternalDocs()
Additional external documentation.
.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 14;getExternalDocs in interface Openapiv2.SwaggerOrBuilderpublic Openapiv2.Swagger.Builder setExternalDocs(Openapiv2.ExternalDocumentation value)
Additional external documentation.
.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 14;public Openapiv2.Swagger.Builder setExternalDocs(Openapiv2.ExternalDocumentation.Builder builderForValue)
Additional external documentation.
.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 14;public Openapiv2.Swagger.Builder mergeExternalDocs(Openapiv2.ExternalDocumentation value)
Additional external documentation.
.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 14;public Openapiv2.Swagger.Builder clearExternalDocs()
Additional external documentation.
.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 14;public Openapiv2.ExternalDocumentation.Builder getExternalDocsBuilder()
Additional external documentation.
.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 14;public Openapiv2.ExternalDocumentationOrBuilder getExternalDocsOrBuilder()
Additional external documentation.
.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 14;getExternalDocsOrBuilder in interface Openapiv2.SwaggerOrBuilderpublic int getExtensionsCount()
Openapiv2.SwaggerOrBuildermap<string, .google.protobuf.Value> extensions = 15;getExtensionsCount in interface Openapiv2.SwaggerOrBuilderpublic boolean containsExtensions(java.lang.String key)
map<string, .google.protobuf.Value> extensions = 15;containsExtensions in interface Openapiv2.SwaggerOrBuilder@Deprecated public java.util.Map<java.lang.String,com.google.protobuf.Value> getExtensions()
getExtensionsMap() instead.getExtensions in interface Openapiv2.SwaggerOrBuilderpublic java.util.Map<java.lang.String,com.google.protobuf.Value> getExtensionsMap()
map<string, .google.protobuf.Value> extensions = 15;getExtensionsMap in interface Openapiv2.SwaggerOrBuilderpublic com.google.protobuf.Value getExtensionsOrDefault(java.lang.String key,
com.google.protobuf.Value defaultValue)
map<string, .google.protobuf.Value> extensions = 15;getExtensionsOrDefault in interface Openapiv2.SwaggerOrBuilderpublic com.google.protobuf.Value getExtensionsOrThrow(java.lang.String key)
map<string, .google.protobuf.Value> extensions = 15;getExtensionsOrThrow in interface Openapiv2.SwaggerOrBuilderpublic Openapiv2.Swagger.Builder clearExtensions()
public Openapiv2.Swagger.Builder removeExtensions(java.lang.String key)
map<string, .google.protobuf.Value> extensions = 15;@Deprecated public java.util.Map<java.lang.String,com.google.protobuf.Value> getMutableExtensions()
public Openapiv2.Swagger.Builder putExtensions(java.lang.String key, com.google.protobuf.Value value)
map<string, .google.protobuf.Value> extensions = 15;public Openapiv2.Swagger.Builder putAllExtensions(java.util.Map<java.lang.String,com.google.protobuf.Value> values)
map<string, .google.protobuf.Value> extensions = 15;public final Openapiv2.Swagger.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Swagger.Builder>public final Openapiv2.Swagger.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Swagger.Builder>