Class Openapiv2.Swagger
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.Swagger
- All Implemented Interfaces:
com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Openapiv2.SwaggerOrBuilder,Serializable
- Enclosing class:
- Openapiv2
public static final class Openapiv2.Swagger
extends com.google.protobuf.GeneratedMessage
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- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class`Swagger` is a representation of OpenAPI v2 specification's Swagger object.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleancontainsExtensions(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.booleancontainsResponses(String key) An object to hold responses that can be used across operations.booleanThe base path on which the API is served, which is relative to the host.com.google.protobuf.ByteStringThe 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.ByteStringgetConsumesBytes(int index) A list of MIME types the APIs can consume.intA list of MIME types the APIs can consume.com.google.protobuf.ProtocolStringListA list of MIME types the APIs can consume.static Openapiv2.Swaggerstatic final com.google.protobuf.Descriptors.DescriptorDeprecated.intCustom 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.ValuegetExtensionsOrDefault(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.ValueCustom 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.getHost()The host (name or ip) serving the API.com.google.protobuf.ByteStringThe host (name or ip) serving the API.getInfo()Provides metadata about the API.Provides metadata about the API.com.google.protobuf.Parser<Openapiv2.Swagger>getProduces(int index) A list of MIME types the APIs can produce.com.google.protobuf.ByteStringgetProducesBytes(int index) A list of MIME types the APIs can produce.intA list of MIME types the APIs can produce.com.google.protobuf.ProtocolStringListA list of MIME types the APIs can produce.Deprecated.intAn 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.intThe transfer protocol of the API.The transfer protocol of the API.intgetSchemesValue(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.intA 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.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.intSpecifies the OpenAPI Specification version being used.com.google.protobuf.ByteStringSpecifies the OpenAPI Specification version being used.getTags(int index) A list of tags for API documentation control.intA 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.booleanAdditional external documentation.inthashCode()booleanhasInfo()Provides metadata about the API.booleanSecurity scheme definitions that can be used across the specification.protected com.google.protobuf.GeneratedMessage.FieldAccessorTableprotected com.google.protobuf.MapFieldReflectionAccessorinternalGetMapFieldReflection(int number) final booleanstatic Openapiv2.Swagger.Builderstatic Openapiv2.Swagger.BuildernewBuilder(Openapiv2.Swagger prototype) protected Openapiv2.Swagger.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) static Openapiv2.SwaggerparseDelimitedFrom(InputStream input) static Openapiv2.SwaggerparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Openapiv2.SwaggerparseFrom(byte[] data) static Openapiv2.SwaggerparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Openapiv2.SwaggerparseFrom(com.google.protobuf.ByteString data) static Openapiv2.SwaggerparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Openapiv2.SwaggerparseFrom(com.google.protobuf.CodedInputStream input) static Openapiv2.SwaggerparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Openapiv2.SwaggerparseFrom(InputStream input) static Openapiv2.SwaggerparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static Openapiv2.SwaggerparseFrom(ByteBuffer data) static Openapiv2.SwaggerparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<Openapiv2.Swagger>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
SWAGGER_FIELD_NUMBER
public static final int SWAGGER_FIELD_NUMBER- See Also:
-
INFO_FIELD_NUMBER
public static final int INFO_FIELD_NUMBER- See Also:
-
HOST_FIELD_NUMBER
public static final int HOST_FIELD_NUMBER- See Also:
-
BASE_PATH_FIELD_NUMBER
public static final int BASE_PATH_FIELD_NUMBER- See Also:
-
SCHEMES_FIELD_NUMBER
public static final int SCHEMES_FIELD_NUMBER- See Also:
-
CONSUMES_FIELD_NUMBER
public static final int CONSUMES_FIELD_NUMBER- See Also:
-
PRODUCES_FIELD_NUMBER
public static final int PRODUCES_FIELD_NUMBER- See Also:
-
RESPONSES_FIELD_NUMBER
public static final int RESPONSES_FIELD_NUMBER- See Also:
-
SECURITY_DEFINITIONS_FIELD_NUMBER
public static final int SECURITY_DEFINITIONS_FIELD_NUMBER- See Also:
-
SECURITY_FIELD_NUMBER
public static final int SECURITY_FIELD_NUMBER- See Also:
-
TAGS_FIELD_NUMBER
public static final int TAGS_FIELD_NUMBER- See Also:
-
EXTERNAL_DOCS_FIELD_NUMBER
public static final int EXTERNAL_DOCS_FIELD_NUMBER- See Also:
-
EXTENSIONS_FIELD_NUMBER
public static final int EXTENSIONS_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetMapFieldReflection
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number) - Overrides:
internalGetMapFieldReflectionin classcom.google.protobuf.GeneratedMessage
-
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
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:
getSwaggerin 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:
getSwaggerBytesin interfaceOpenapiv2.SwaggerOrBuilder- Returns:
- The bytes for swagger.
-
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:
hasInfoin 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:
getInfoin interfaceOpenapiv2.SwaggerOrBuilder- Returns:
- The info.
-
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:
getInfoOrBuilderin 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:
getHostin 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:
getHostBytesin interfaceOpenapiv2.SwaggerOrBuilder- Returns:
- The bytes for host.
-
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:
getBasePathin 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:
getBasePathBytesin interfaceOpenapiv2.SwaggerOrBuilder- Returns:
- The bytes for basePath.
-
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:
getSchemesListin 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:
getSchemesCountin 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:
getSchemesin interfaceOpenapiv2.SwaggerOrBuilder- Parameters:
index- The index of the element to return.- Returns:
- The schemes at the given index.
-
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:
getSchemesValueListin 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:
getSchemesValuein 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.
-
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:
getConsumesListin 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:
getConsumesCountin 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:
getConsumesin 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:
getConsumesBytesin interfaceOpenapiv2.SwaggerOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the consumes at the given index.
-
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:
getProducesListin 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:
getProducesCountin 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:
getProducesin 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:
getProducesBytesin interfaceOpenapiv2.SwaggerOrBuilder- Parameters:
index- The index of the value to return.- Returns:
- The bytes of the produces at the given index.
-
getResponsesCount
public int getResponsesCount()Description copied from interface: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;- Specified by:
getResponsesCountin 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:
containsResponsesin interfaceOpenapiv2.SwaggerOrBuilder
-
getResponses
Deprecated.UsegetResponsesMap()instead.- Specified by:
getResponsesin 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:
getResponsesMapin 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:
getResponsesOrDefaultin 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:
getResponsesOrThrowin interfaceOpenapiv2.SwaggerOrBuilder
-
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:
hasSecurityDefinitionsin 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:
getSecurityDefinitionsin interfaceOpenapiv2.SwaggerOrBuilder- Returns:
- The securityDefinitions.
-
getSecurityDefinitionsOrBuilder
Security scheme definitions that can be used across the specification.
.grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions security_definitions = 11;- Specified by:
getSecurityDefinitionsOrBuilderin 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:
getSecurityListin 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:
getSecurityOrBuilderListin 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:
getSecurityCountin 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:
getSecurityin interfaceOpenapiv2.SwaggerOrBuilder
-
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:
getSecurityOrBuilderin interfaceOpenapiv2.SwaggerOrBuilder
-
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:
getTagsListin 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:
getTagsOrBuilderListin 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:
getTagsCountin 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:
getTagsin interfaceOpenapiv2.SwaggerOrBuilder
-
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:
getTagsOrBuilderin interfaceOpenapiv2.SwaggerOrBuilder
-
hasExternalDocs
public boolean hasExternalDocs()Additional external documentation.
.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 14;- Specified by:
hasExternalDocsin 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:
getExternalDocsin interfaceOpenapiv2.SwaggerOrBuilder- Returns:
- The externalDocs.
-
getExternalDocsOrBuilder
Additional external documentation.
.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 14;- Specified by:
getExternalDocsOrBuilderin interfaceOpenapiv2.SwaggerOrBuilder
-
getExtensionsCount
public int getExtensionsCount()Description copied from interface:Openapiv2.SwaggerOrBuilderCustom 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:
getExtensionsCountin 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:
containsExtensionsin interfaceOpenapiv2.SwaggerOrBuilder
-
getExtensions
Deprecated.UsegetExtensionsMap()instead.- Specified by:
getExtensionsin 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:
getExtensionsMapin 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:
getExtensionsOrDefaultin 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:
getExtensionsOrThrowin interfaceOpenapiv2.SwaggerOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static Openapiv2.Swagger parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Openapiv2.Swagger parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Openapiv2.Swagger parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Openapiv2.Swagger parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Openapiv2.Swagger parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Openapiv2.Swagger parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Openapiv2.Swagger parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static Openapiv2.Swagger parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static Openapiv2.Swagger parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static Openapiv2.Swagger parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected Openapiv2.Swagger.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-