Class Openapiv2.Swagger.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<Openapiv2.Swagger.Builder>
grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.Swagger.Builder
- All Implemented Interfaces:
com.google.protobuf.Message.Builder
,com.google.protobuf.MessageLite.Builder
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,Openapiv2.SwaggerOrBuilder
,Cloneable
- Enclosing class:
- Openapiv2.Swagger
public static final class Openapiv2.Swagger.Builder
extends com.google.protobuf.GeneratedMessage.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/main/LICENSE"; }; }; schemes: HTTPS; consumes: "application/json"; produces: "application/json"; };Protobuf type
grpc.gateway.protoc_gen_openapiv2.options.Swagger
-
Method Summary
Modifier and TypeMethodDescriptionaddAllConsumes
(Iterable<String> values) A list of MIME types the APIs can consume.addAllProduces
(Iterable<String> values) A list of MIME types the APIs can produce.addAllSchemes
(Iterable<? extends Openapiv2.Scheme> values) The transfer protocol of the API.addAllSchemesValue
(Iterable<Integer> values) The transfer protocol of the API.addAllSecurity
(Iterable<? extends Openapiv2.SecurityRequirement> values) A declaration of which security schemes are applied for the API as a whole.addAllTags
(Iterable<? extends Openapiv2.Tag> values) A list of tags for API documentation control.addConsumes
(String value) A list of MIME types the APIs can consume.addConsumesBytes
(com.google.protobuf.ByteString value) A list of MIME types the APIs can consume.addProduces
(String value) A list of MIME types the APIs can produce.addProducesBytes
(com.google.protobuf.ByteString value) A list of MIME types the APIs can produce.addSchemes
(Openapiv2.Scheme value) The transfer protocol of the API.addSchemesValue
(int value) The transfer protocol of the API.addSecurity
(int index, Openapiv2.SecurityRequirement value) A declaration of which security schemes are applied for the API as a whole.addSecurity
(int index, Openapiv2.SecurityRequirement.Builder builderForValue) A declaration of which security schemes are applied for the API as a whole.A declaration of which security schemes are applied for the API as a whole.addSecurity
(Openapiv2.SecurityRequirement.Builder builderForValue) A declaration of which security schemes are applied for the API as a whole.A declaration of which security schemes are applied for the API as a whole.addSecurityBuilder
(int index) A declaration of which security schemes are applied for the API as a whole.addTags
(int index, Openapiv2.Tag value) A list of tags for API documentation control.addTags
(int index, Openapiv2.Tag.Builder builderForValue) A list of tags for API documentation control.addTags
(Openapiv2.Tag value) A list of tags for API documentation control.addTags
(Openapiv2.Tag.Builder builderForValue) A list of tags for API documentation control.A list of tags for API documentation control.addTagsBuilder
(int index) A list of tags for API documentation control.build()
clear()
The base path on which the API is served, which is relative to the host.A list of MIME types the APIs can consume.Additional external documentation.The host (name or ip) serving the API.Provides metadata about the API.A list of MIME types the APIs can produce.The transfer protocol of the API.A declaration of which security schemes are applied for the API as a whole.Security scheme definitions that can be used across the specification.Specifies the OpenAPI Specification version being used.A list of tags for API documentation control.boolean
containsExtensions
(String 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.boolean
containsResponses
(String key) An object to hold responses that can be used across operations.The base path on which the API is served, which is relative to the host.com.google.protobuf.ByteString
The base path on which the API is served, which is relative to the host.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
A list of MIME types the APIs can consume.com.google.protobuf.ProtocolStringList
A list of MIME types the APIs can consume.static final com.google.protobuf.Descriptors.Descriptor
com.google.protobuf.Descriptors.Descriptor
Deprecated.int
Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification.Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification.com.google.protobuf.Value
getExtensionsOrDefault
(String key, com.google.protobuf.Value defaultValue) Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification.com.google.protobuf.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.Additional external documentation.Additional external documentation.Additional external documentation.getHost()
The host (name or ip) serving the API.com.google.protobuf.ByteString
The host (name or ip) serving the API.getInfo()
Provides metadata about the API.Provides metadata about the API.Provides metadata about the API.Deprecated.Deprecated.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
A list of MIME types the APIs can produce.com.google.protobuf.ProtocolStringList
A list of MIME types the APIs can produce.Deprecated.int
An object to hold responses that can be used across operations.An object to hold responses that can be used across operations.getResponsesOrDefault
(String key, Openapiv2.Response defaultValue) An object to hold responses that can be used across operations.An object to hold responses that can be used across operations.getSchemes
(int index) The transfer protocol of the API.int
The transfer protocol of the API.The transfer protocol of the API.int
getSchemesValue
(int index) The transfer protocol of the API.The transfer protocol of the API.getSecurity
(int index) A declaration of which security schemes are applied for the API as a whole.getSecurityBuilder
(int index) A declaration of which security schemes are applied for the API as a whole.A declaration of which security schemes are applied for the API as a whole.int
A declaration of which security schemes are applied for the API as a whole.Security scheme definitions that can be used across the specification.Security scheme definitions that can be used across the specification.Security scheme definitions that can be used across the specification.A declaration of which security schemes are applied for the API as a whole.getSecurityOrBuilder
(int index) A declaration of which security schemes are applied for the API as a whole.List<? extends Openapiv2.SecurityRequirementOrBuilder>
A declaration of which security schemes are applied for the API as a whole.Specifies the OpenAPI Specification version being used.com.google.protobuf.ByteString
Specifies the OpenAPI Specification version being used.getTags
(int index) A list of tags for API documentation control.getTagsBuilder
(int index) A list of tags for API documentation control.A list of tags for API documentation control.int
A list of tags for API documentation control.A list of tags for API documentation control.getTagsOrBuilder
(int index) A list of tags for API documentation control.List<? extends Openapiv2.TagOrBuilder>
A list of tags for API documentation control.boolean
Additional external documentation.boolean
hasInfo()
Provides metadata about the API.boolean
Security scheme definitions that can be used across the specification.protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
protected com.google.protobuf.MapFieldReflectionAccessor
internalGetMapFieldReflection
(int number) protected com.google.protobuf.MapFieldReflectionAccessor
internalGetMutableMapFieldReflection
(int number) final boolean
Additional external documentation.mergeFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom
(com.google.protobuf.Message other) mergeFrom
(Openapiv2.Swagger other) mergeInfo
(Openapiv2.Info value) Provides metadata about the API.Security scheme definitions that can be used across the specification.putAllExtensions
(Map<String, com.google.protobuf.Value> values) Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification.putAllResponses
(Map<String, Openapiv2.Response> values) An object to hold responses that can be used across operations.putExtensions
(String key, com.google.protobuf.Value 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.com.google.protobuf.Value.Builder
Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification.putResponses
(String key, Openapiv2.Response value) An object to hold responses that can be used across operations.An object to hold responses that can be used across operations.removeExtensions
(String 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.removeResponses
(String key) An object to hold responses that can be used across operations.removeSecurity
(int index) A declaration of which security schemes are applied for the API as a whole.removeTags
(int index) A list of tags for API documentation control.setBasePath
(String value) The base path on which the API is served, which is relative to the host.setBasePathBytes
(com.google.protobuf.ByteString value) The base path on which the API is served, which is relative to the host.setConsumes
(int index, String value) A list of MIME types the APIs can consume.Additional external documentation.setExternalDocs
(Openapiv2.ExternalDocumentation.Builder builderForValue) Additional external documentation.The host (name or ip) serving the API.setHostBytes
(com.google.protobuf.ByteString value) The host (name or ip) serving the API.setInfo
(Openapiv2.Info value) Provides metadata about the API.setInfo
(Openapiv2.Info.Builder builderForValue) Provides metadata about the API.setProduces
(int index, String value) A list of MIME types the APIs can produce.setSchemes
(int index, Openapiv2.Scheme value) The transfer protocol of the API.setSchemesValue
(int index, int value) The transfer protocol of the API.setSecurity
(int index, Openapiv2.SecurityRequirement value) A declaration of which security schemes are applied for the API as a whole.setSecurity
(int index, Openapiv2.SecurityRequirement.Builder builderForValue) A declaration of which security schemes are applied for the API as a whole.Security scheme definitions that can be used across the specification.setSecurityDefinitions
(Openapiv2.SecurityDefinitions.Builder builderForValue) Security scheme definitions that can be used across the specification.setSwagger
(String value) Specifies the OpenAPI Specification version being used.setSwaggerBytes
(com.google.protobuf.ByteString value) Specifies the OpenAPI Specification version being used.setTags
(int index, Openapiv2.Tag value) A list of tags for API documentation control.setTags
(int index, Openapiv2.Tag.Builder builderForValue) A list of tags for API documentation control.Methods inherited from class com.google.protobuf.GeneratedMessage.Builder
addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3
Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom
Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetMapFieldReflection
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number) - Overrides:
internalGetMapFieldReflection
in classcom.google.protobuf.GeneratedMessage.Builder<Openapiv2.Swagger.Builder>
-
internalGetMutableMapFieldReflection
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number) - Overrides:
internalGetMutableMapFieldReflection
in classcom.google.protobuf.GeneratedMessage.Builder<Openapiv2.Swagger.Builder>
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessage.Builder<Openapiv2.Swagger.Builder>
-
clear
- Specified by:
clear
in interfacecom.google.protobuf.Message.Builder
- Specified by:
clear
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
clear
in classcom.google.protobuf.GeneratedMessage.Builder<Openapiv2.Swagger.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.Message.Builder
- Specified by:
getDescriptorForType
in interfacecom.google.protobuf.MessageOrBuilder
- Overrides:
getDescriptorForType
in classcom.google.protobuf.GeneratedMessage.Builder<Openapiv2.Swagger.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
build
in interfacecom.google.protobuf.Message.Builder
- Specified by:
build
in interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartial
in interfacecom.google.protobuf.Message.Builder
- Specified by:
buildPartial
in interfacecom.google.protobuf.MessageLite.Builder
-
mergeFrom
- Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<Openapiv2.Swagger.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessage.Builder<Openapiv2.Swagger.Builder>
-
mergeFrom
public Openapiv2.Swagger.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFrom
in interfacecom.google.protobuf.Message.Builder
- Specified by:
mergeFrom
in interfacecom.google.protobuf.MessageLite.Builder
- Overrides:
mergeFrom
in classcom.google.protobuf.AbstractMessage.Builder<Openapiv2.Swagger.Builder>
- Throws:
IOException
-
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;
- Specified by:
getSwagger
in interfaceOpenapiv2.SwaggerOrBuilder
- Returns:
- The swagger.
-
getSwaggerBytes
public 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;
- Specified by:
getSwaggerBytes
in interfaceOpenapiv2.SwaggerOrBuilder
- Returns:
- The bytes for swagger.
-
setSwagger
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;
- Parameters:
value
- The swagger to set.- Returns:
- This builder for chaining.
-
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;
- Returns:
- This builder for chaining.
-
setSwaggerBytes
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;
- Parameters:
value
- The bytes for swagger to set.- Returns:
- This builder for chaining.
-
hasInfo
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;
- Specified by:
hasInfo
in interfaceOpenapiv2.SwaggerOrBuilder
- Returns:
- Whether the info field is set.
-
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;
- Specified by:
getInfo
in interfaceOpenapiv2.SwaggerOrBuilder
- Returns:
- The info.
-
setInfo
Provides metadata about the API. The metadata can be used by the clients if needed.
.grpc.gateway.protoc_gen_openapiv2.options.Info info = 2;
-
setInfo
Provides metadata about the API. The metadata can be used by the clients if needed.
.grpc.gateway.protoc_gen_openapiv2.options.Info info = 2;
-
mergeInfo
Provides metadata about the API. The metadata can be used by the clients if needed.
.grpc.gateway.protoc_gen_openapiv2.options.Info info = 2;
-
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;
-
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;
-
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;
- Specified by:
getInfoOrBuilder
in interfaceOpenapiv2.SwaggerOrBuilder
-
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;
- Specified by:
getHost
in interfaceOpenapiv2.SwaggerOrBuilder
- Returns:
- The host.
-
getHostBytes
public 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;
- Specified by:
getHostBytes
in interfaceOpenapiv2.SwaggerOrBuilder
- Returns:
- The bytes for host.
-
setHost
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;
- Parameters:
value
- The host to set.- Returns:
- This builder for chaining.
-
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;
- Returns:
- This builder for chaining.
-
setHostBytes
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;
- Parameters:
value
- The bytes for host to set.- Returns:
- This builder for chaining.
-
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;
- Specified by:
getBasePath
in interfaceOpenapiv2.SwaggerOrBuilder
- Returns:
- The basePath.
-
getBasePathBytes
public 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;
- Specified by:
getBasePathBytes
in interfaceOpenapiv2.SwaggerOrBuilder
- Returns:
- The bytes for basePath.
-
setBasePath
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;
- Parameters:
value
- The basePath to set.- Returns:
- This builder for chaining.
-
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;
- Returns:
- This builder for chaining.
-
setBasePathBytes
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;
- Parameters:
value
- The bytes for basePath to set.- Returns:
- This builder for chaining.
-
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;
- Specified by:
getSchemesList
in interfaceOpenapiv2.SwaggerOrBuilder
- Returns:
- A list containing the schemes.
-
getSchemesCount
public 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;
- Specified by:
getSchemesCount
in interfaceOpenapiv2.SwaggerOrBuilder
- Returns:
- The count of schemes.
-
getSchemes
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;
- Specified by:
getSchemes
in interfaceOpenapiv2.SwaggerOrBuilder
- Parameters:
index
- The index of the element to return.- Returns:
- The schemes at the given index.
-
setSchemes
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;
- Parameters:
index
- The index to set the value at.value
- The schemes to set.- Returns:
- This builder for chaining.
-
addSchemes
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;
- Parameters:
value
- The schemes to add.- Returns:
- This builder for chaining.
-
addAllSchemes
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;
- Parameters:
values
- The schemes to add.- Returns:
- This builder for chaining.
-
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;
- Returns:
- This builder for chaining.
-
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;
- Specified by:
getSchemesValueList
in interfaceOpenapiv2.SwaggerOrBuilder
- Returns:
- A list containing the enum numeric values on the wire for schemes.
-
getSchemesValue
public 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;
- Specified by:
getSchemesValue
in interfaceOpenapiv2.SwaggerOrBuilder
- Parameters:
index
- The index of the value to return.- Returns:
- The enum numeric value on the wire of schemes at the given index.
-
setSchemesValue
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;
- Parameters:
index
- The index to set the value at.value
- The enum numeric value on the wire for schemes to set.- Returns:
- This builder for chaining.
-
addSchemesValue
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;
- Parameters:
value
- The enum numeric value on the wire for schemes to add.- Returns:
- This builder for chaining.
-
addAllSchemesValue
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;
- Parameters:
values
- The enum numeric values on the wire for schemes to add.- Returns:
- This builder for chaining.
-
getConsumesList
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;
- Specified by:
getConsumesList
in interfaceOpenapiv2.SwaggerOrBuilder
- Returns:
- A list containing the consumes.
-
getConsumesCount
public 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;
- Specified by:
getConsumesCount
in interfaceOpenapiv2.SwaggerOrBuilder
- Returns:
- The count of consumes.
-
getConsumes
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;
- Specified by:
getConsumes
in interfaceOpenapiv2.SwaggerOrBuilder
- Parameters:
index
- The index of the element to return.- Returns:
- The consumes at the given index.
-
getConsumesBytes
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;
- Specified by:
getConsumesBytes
in interfaceOpenapiv2.SwaggerOrBuilder
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the consumes at the given index.
-
setConsumes
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;
- Parameters:
index
- The index to set the value at.value
- The consumes to set.- Returns:
- This builder for chaining.
-
addConsumes
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;
- Parameters:
value
- The consumes to add.- Returns:
- This builder for chaining.
-
addAllConsumes
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;
- Parameters:
values
- The consumes to add.- Returns:
- This builder for chaining.
-
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;
- Returns:
- This builder for chaining.
-
addConsumesBytes
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;
- Parameters:
value
- The bytes of the consumes to add.- Returns:
- This builder for chaining.
-
getProducesList
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;
- Specified by:
getProducesList
in interfaceOpenapiv2.SwaggerOrBuilder
- Returns:
- A list containing the produces.
-
getProducesCount
public 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;
- Specified by:
getProducesCount
in interfaceOpenapiv2.SwaggerOrBuilder
- Returns:
- The count of produces.
-
getProduces
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;
- Specified by:
getProduces
in interfaceOpenapiv2.SwaggerOrBuilder
- Parameters:
index
- The index of the element to return.- Returns:
- The produces at the given index.
-
getProducesBytes
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;
- Specified by:
getProducesBytes
in interfaceOpenapiv2.SwaggerOrBuilder
- Parameters:
index
- The index of the value to return.- Returns:
- The bytes of the produces at the given index.
-
setProduces
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;
- Parameters:
index
- The index to set the value at.value
- The produces to set.- Returns:
- This builder for chaining.
-
addProduces
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;
- Parameters:
value
- The produces to add.- Returns:
- This builder for chaining.
-
addAllProduces
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;
- Parameters:
values
- The produces to add.- Returns:
- This builder for chaining.
-
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;
- Returns:
- This builder for chaining.
-
addProducesBytes
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;
- Parameters:
value
- The bytes of the produces to add.- Returns:
- This builder for chaining.
-
getResponsesCount
public int getResponsesCount()Description copied from interface:Openapiv2.SwaggerOrBuilder
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;
- Specified by:
getResponsesCount
in interfaceOpenapiv2.SwaggerOrBuilder
-
containsResponses
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;
- Specified by:
containsResponses
in interfaceOpenapiv2.SwaggerOrBuilder
-
getResponses
Deprecated.UsegetResponsesMap()
instead.- Specified by:
getResponses
in interfaceOpenapiv2.SwaggerOrBuilder
-
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;
- Specified by:
getResponsesMap
in interfaceOpenapiv2.SwaggerOrBuilder
-
getResponsesOrDefault
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;
- Specified by:
getResponsesOrDefault
in interfaceOpenapiv2.SwaggerOrBuilder
-
getResponsesOrThrow
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;
- Specified by:
getResponsesOrThrow
in interfaceOpenapiv2.SwaggerOrBuilder
-
clearResponses
-
removeResponses
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;
-
getMutableResponses
Deprecated.Use alternate mutation accessors instead. -
putResponses
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;
-
putAllResponses
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;
-
putResponsesBuilderIfAbsent
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;
-
hasSecurityDefinitions
public boolean hasSecurityDefinitions()Security scheme definitions that can be used across the specification.
.grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions security_definitions = 11;
- Specified by:
hasSecurityDefinitions
in interfaceOpenapiv2.SwaggerOrBuilder
- Returns:
- Whether the securityDefinitions field is set.
-
getSecurityDefinitions
Security scheme definitions that can be used across the specification.
.grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions security_definitions = 11;
- Specified by:
getSecurityDefinitions
in interfaceOpenapiv2.SwaggerOrBuilder
- Returns:
- The securityDefinitions.
-
setSecurityDefinitions
Security scheme definitions that can be used across the specification.
.grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions security_definitions = 11;
-
setSecurityDefinitions
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;
-
mergeSecurityDefinitions
Security scheme definitions that can be used across the specification.
.grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions security_definitions = 11;
-
clearSecurityDefinitions
Security scheme definitions that can be used across the specification.
.grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions security_definitions = 11;
-
getSecurityDefinitionsBuilder
Security scheme definitions that can be used across the specification.
.grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions security_definitions = 11;
-
getSecurityDefinitionsOrBuilder
Security scheme definitions that can be used across the specification.
.grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions security_definitions = 11;
- Specified by:
getSecurityDefinitionsOrBuilder
in interfaceOpenapiv2.SwaggerOrBuilder
-
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;
- Specified by:
getSecurityList
in interfaceOpenapiv2.SwaggerOrBuilder
-
getSecurityCount
public 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;
- Specified by:
getSecurityCount
in interfaceOpenapiv2.SwaggerOrBuilder
-
getSecurity
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;
- Specified by:
getSecurity
in interfaceOpenapiv2.SwaggerOrBuilder
-
setSecurity
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;
-
setSecurity
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;
-
addSecurity
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;
-
addSecurity
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;
-
addSecurity
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;
-
addSecurity
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;
-
addAllSecurity
public Openapiv2.Swagger.Builder addAllSecurity(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;
-
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;
-
removeSecurity
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;
-
getSecurityBuilder
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
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;
- Specified by:
getSecurityOrBuilder
in interfaceOpenapiv2.SwaggerOrBuilder
-
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;
- Specified by:
getSecurityOrBuilderList
in interfaceOpenapiv2.SwaggerOrBuilder
-
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;
-
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;
-
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;
-
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;
- Specified by:
getTagsList
in interfaceOpenapiv2.SwaggerOrBuilder
-
getTagsCount
public int getTagsCount()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;
- Specified by:
getTagsCount
in interfaceOpenapiv2.SwaggerOrBuilder
-
getTags
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;
- Specified by:
getTags
in interfaceOpenapiv2.SwaggerOrBuilder
-
setTags
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;
-
setTags
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;
-
addTags
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;
-
addTags
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;
-
addTags
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;
-
addTags
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;
-
addAllTags
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;
-
clearTags
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;
-
removeTags
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;
-
getTagsBuilder
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;
-
getTagsOrBuilder
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;
- Specified by:
getTagsOrBuilder
in interfaceOpenapiv2.SwaggerOrBuilder
-
getTagsOrBuilderList
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;
- Specified by:
getTagsOrBuilderList
in interfaceOpenapiv2.SwaggerOrBuilder
-
addTagsBuilder
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;
-
addTagsBuilder
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;
-
getTagsBuilderList
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;
-
hasExternalDocs
public boolean hasExternalDocs()Additional external documentation.
.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 14;
- Specified by:
hasExternalDocs
in interfaceOpenapiv2.SwaggerOrBuilder
- Returns:
- Whether the externalDocs field is set.
-
getExternalDocs
Additional external documentation.
.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 14;
- Specified by:
getExternalDocs
in interfaceOpenapiv2.SwaggerOrBuilder
- Returns:
- The externalDocs.
-
setExternalDocs
Additional external documentation.
.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 14;
-
setExternalDocs
public Openapiv2.Swagger.Builder setExternalDocs(Openapiv2.ExternalDocumentation.Builder builderForValue) Additional external documentation.
.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 14;
-
mergeExternalDocs
Additional external documentation.
.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 14;
-
clearExternalDocs
Additional external documentation.
.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 14;
-
getExternalDocsBuilder
Additional external documentation.
.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 14;
-
getExternalDocsOrBuilder
Additional external documentation.
.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 14;
- Specified by:
getExternalDocsOrBuilder
in interfaceOpenapiv2.SwaggerOrBuilder
-
getExtensionsCount
public int getExtensionsCount()Description copied from interface:Openapiv2.SwaggerOrBuilder
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;
- Specified by:
getExtensionsCount
in interfaceOpenapiv2.SwaggerOrBuilder
-
containsExtensions
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;
- Specified by:
containsExtensions
in interfaceOpenapiv2.SwaggerOrBuilder
-
getExtensions
Deprecated.UsegetExtensionsMap()
instead.- Specified by:
getExtensions
in interfaceOpenapiv2.SwaggerOrBuilder
-
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;
- Specified by:
getExtensionsMap
in interfaceOpenapiv2.SwaggerOrBuilder
-
getExtensionsOrDefault
public com.google.protobuf.Value getExtensionsOrDefault(String key, com.google.protobuf.Value defaultValue) 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;
- Specified by:
getExtensionsOrDefault
in interfaceOpenapiv2.SwaggerOrBuilder
-
getExtensionsOrThrow
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;
- Specified by:
getExtensionsOrThrow
in interfaceOpenapiv2.SwaggerOrBuilder
-
clearExtensions
-
removeExtensions
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;
-
getMutableExtensions
Deprecated.Use alternate mutation accessors instead. -
putExtensions
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;
-
putAllExtensions
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;
-
putExtensionsBuilderIfAbsent
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;
-