Swagger (nakama-java 2.5.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessage
    - - com.grpc.gateway.protoc_gen_openapiv2.options.Swagger

All Implemented Interfaces:: com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, SwaggerOrBuilder, java.io.Serializable

public final class Swagger
extends com.google.protobuf.GeneratedMessage
implements 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:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Swagger.Builder
`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>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter
- Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
  com.google.protobuf.AbstractMessage.BuilderParent
- Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
  com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Nested Classes
Modifier and Type	Class and Description
`static class`	`Swagger.Builder` `Swagger` is a representation of OpenAPI v2 specification's Swagger object.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BASE_PATH_FIELD_NUMBER`
`static int`	`CONSUMES_FIELD_NUMBER`
`static int`	`EXTENSIONS_FIELD_NUMBER`
`static int`	`EXTERNAL_DOCS_FIELD_NUMBER`
`static int`	`HOST_FIELD_NUMBER`
`static int`	`INFO_FIELD_NUMBER`
`static int`	`PRODUCES_FIELD_NUMBER`
`static int`	`RESPONSES_FIELD_NUMBER`
`static int`	`SCHEMES_FIELD_NUMBER`
`static int`	`SECURITY_DEFINITIONS_FIELD_NUMBER`
`static int`	`SECURITY_FIELD_NUMBER`
`static int`	`SWAGGER_FIELD_NUMBER`
`static int`	`TAGS_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsExtensions(java.lang.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(java.lang.String key)` An object to hold responses that can be used across operations.
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getBasePath()` The base path on which the API is served, which is relative to the host.
`com.google.protobuf.ByteString`	`getBasePathBytes()` The base path on which the API is served, which is relative to the host.
`java.lang.String`	`getConsumes(int index)` A list of MIME types the APIs can consume.
`com.google.protobuf.ByteString`	`getConsumesBytes(int index)` A list of MIME types the APIs can consume.
`int`	`getConsumesCount()` A list of MIME types the APIs can consume.
`com.google.protobuf.ProtocolStringList`	`getConsumesList()` A list of MIME types the APIs can consume.
`static Swagger`	`getDefaultInstance()`
`Swagger`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`java.util.Map<java.lang.String,com.google.protobuf.Value>`	`getExtensions()` Deprecated.
`int`	`getExtensionsCount()` Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification.
`java.util.Map<java.lang.String,com.google.protobuf.Value>`	`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.
`com.google.protobuf.Value`	`getExtensionsOrDefault(java.lang.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`	`getExtensionsOrThrow(java.lang.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.
`ExternalDocumentation`	`getExternalDocs()` Additional external documentation.
`ExternalDocumentationOrBuilder`	`getExternalDocsOrBuilder()` Additional external documentation.
`java.lang.String`	`getHost()` The host (name or ip) serving the API.
`com.google.protobuf.ByteString`	`getHostBytes()` The host (name or ip) serving the API.
`Info`	`getInfo()` Provides metadata about the API.
`InfoOrBuilder`	`getInfoOrBuilder()` Provides metadata about the API.
`com.google.protobuf.Parser<Swagger>`	`getParserForType()`
`java.lang.String`	`getProduces(int index)` A list of MIME types the APIs can produce.
`com.google.protobuf.ByteString`	`getProducesBytes(int index)` A list of MIME types the APIs can produce.
`int`	`getProducesCount()` A list of MIME types the APIs can produce.
`com.google.protobuf.ProtocolStringList`	`getProducesList()` A list of MIME types the APIs can produce.
`java.util.Map<java.lang.String,Response>`	`getResponses()` Deprecated.
`int`	`getResponsesCount()` An object to hold responses that can be used across operations.
`java.util.Map<java.lang.String,Response>`	`getResponsesMap()` An object to hold responses that can be used across operations.
`Response`	`getResponsesOrDefault(java.lang.String key, Response defaultValue)` An object to hold responses that can be used across operations.
`Response`	`getResponsesOrThrow(java.lang.String key)` An object to hold responses that can be used across operations.
`Scheme`	`getSchemes(int index)` The transfer protocol of the API.
`int`	`getSchemesCount()` The transfer protocol of the API.
`java.util.List<Scheme>`	`getSchemesList()` The transfer protocol of the API.
`int`	`getSchemesValue(int index)` The transfer protocol of the API.
`java.util.List<java.lang.Integer>`	`getSchemesValueList()` The transfer protocol of the API.
`SecurityRequirement`	`getSecurity(int index)` A declaration of which security schemes are applied for the API as a whole.
`int`	`getSecurityCount()` A declaration of which security schemes are applied for the API as a whole.
`SecurityDefinitions`	`getSecurityDefinitions()` Security scheme definitions that can be used across the specification.
`SecurityDefinitionsOrBuilder`	`getSecurityDefinitionsOrBuilder()` Security scheme definitions that can be used across the specification.
`java.util.List<SecurityRequirement>`	`getSecurityList()` A declaration of which security schemes are applied for the API as a whole.
`SecurityRequirementOrBuilder`	`getSecurityOrBuilder(int index)` A declaration of which security schemes are applied for the API as a whole.
`java.util.List<? extends SecurityRequirementOrBuilder>`	`getSecurityOrBuilderList()` A declaration of which security schemes are applied for the API as a whole.
`int`	`getSerializedSize()`
`java.lang.String`	`getSwagger()` Specifies the OpenAPI Specification version being used.
`com.google.protobuf.ByteString`	`getSwaggerBytes()` Specifies the OpenAPI Specification version being used.
`Tag`	`getTags(int index)` A list of tags for API documentation control.
`int`	`getTagsCount()` A list of tags for API documentation control.
`java.util.List<Tag>`	`getTagsList()` A list of tags for API documentation control.
`TagOrBuilder`	`getTagsOrBuilder(int index)` A list of tags for API documentation control.
`java.util.List<? extends TagOrBuilder>`	`getTagsOrBuilderList()` A list of tags for API documentation control.
`boolean`	`hasExternalDocs()` Additional external documentation.
`int`	`hashCode()`
`boolean`	`hasInfo()` Provides metadata about the API.
`boolean`	`hasSecurityDefinitions()` Security scheme definitions that can be used across the specification.
`protected com.google.protobuf.GeneratedMessage.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapFieldReflectionAccessor`	`internalGetMapFieldReflection(int number)`
`boolean`	`isInitialized()`
`static Swagger.Builder`	`newBuilder()`
`static Swagger.Builder`	`newBuilder(Swagger prototype)`
`Swagger.Builder`	`newBuilderForType()`
`protected Swagger.Builder`	`newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)`
`static Swagger`	`parseDelimitedFrom(java.io.InputStream input)`
`static Swagger`	`parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Swagger`	`parseFrom(byte[] data)`
`static Swagger`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Swagger`	`parseFrom(java.nio.ByteBuffer data)`
`static Swagger`	`parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Swagger`	`parseFrom(com.google.protobuf.ByteString data)`
`static Swagger`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Swagger`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static Swagger`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Swagger`	`parseFrom(java.io.InputStream input)`
`static Swagger`	`parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<Swagger>`	`parser()`
`Swagger.Builder`	`toBuilder()`
`void`	`writeTo(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, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- SWAGGER_FIELD_NUMBER
```
public static final int SWAGGER_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- INFO_FIELD_NUMBER
```
public static final int INFO_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- HOST_FIELD_NUMBER
```
public static final int HOST_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- BASE_PATH_FIELD_NUMBER
```
public static final int BASE_PATH_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SCHEMES_FIELD_NUMBER
```
public static final int SCHEMES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CONSUMES_FIELD_NUMBER
```
public static final int CONSUMES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PRODUCES_FIELD_NUMBER
```
public static final int PRODUCES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- RESPONSES_FIELD_NUMBER
```
public static final int RESPONSES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SECURITY_DEFINITIONS_FIELD_NUMBER
```
public static final int SECURITY_DEFINITIONS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SECURITY_FIELD_NUMBER
```
public static final int SECURITY_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- TAGS_FIELD_NUMBER
```
public static final int TAGS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- EXTERNAL_DOCS_FIELD_NUMBER
```
public static final int EXTERNAL_DOCS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- EXTENSIONS_FIELD_NUMBER
```
public static final int EXTENSIONS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapFieldReflection
```
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
```
Overrides:

internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

getSwagger

public java.lang.String getSwagger()

 Specifies the OpenAPI Specification version being used. It can be
 used by the OpenAPI UI and other clients to interpret the API listing. The
 value MUST be "2.0".

string swagger = 1 [json_name = "swagger"];

Specified by:: getSwagger in interface 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 [json_name = "swagger"];

Specified by:: getSwaggerBytes in interface 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 [json_name = "info"];
Specified by:

hasInfo in interface SwaggerOrBuilder

Returns:

Whether the info field is set.

getInfo
```
public Info getInfo()
```
```
 Provides metadata about the API. The metadata can be used by the
 clients if needed.
 
```
.grpc.gateway.protoc_gen_openapiv2.options.Info info = 2 [json_name = "info"];
Specified by:

getInfo in interface SwaggerOrBuilder

Returns:

The info.

getInfoOrBuilder
```
public InfoOrBuilder getInfoOrBuilder()
```
```
 Provides metadata about the API. The metadata can be used by the
 clients if needed.
 
```
.grpc.gateway.protoc_gen_openapiv2.options.Info info = 2 [json_name = "info"];
Specified by:

getInfoOrBuilder in interface SwaggerOrBuilder

getHost

public java.lang.String getHost()

 The host (name or ip) serving the API. This MUST be the host only and does
 not include the scheme nor sub-paths. It MAY include a port. If the host is
 not included, the host serving the documentation is to be used (including
 the port). The host does not support path templating.

string host = 3 [json_name = "host"];

Specified by:: getHost in interface 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 [json_name = "host"];

Specified by:: getHostBytes in interface SwaggerOrBuilder
Returns:: The bytes for host.

getBasePath

public java.lang.String getBasePath()

 The base path on which the API is served, which is relative to the host. If
 it is not included, the API is served directly under the host. The value
 MUST start with a leading slash (/). The basePath does not support path
 templating.
 Note that using `base_path` does not change the endpoint paths that are
 generated in the resulting OpenAPI file. If you wish to use `base_path`
 with relatively generated OpenAPI paths, the `base_path` prefix must be
 manually removed from your `google.api.http` paths and your code changed to
 serve the API from the `base_path`.

string base_path = 4 [json_name = "basePath"];

Specified by:: getBasePath in interface 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 [json_name = "basePath"];

Specified by:: getBasePathBytes in interface SwaggerOrBuilder
Returns:: The bytes for basePath.

getSchemesList

public java.util.List<Scheme> getSchemesList()

 The transfer protocol of the API. Values MUST be from the list: "http",
 "https", "ws", "wss". If the schemes is not included, the default scheme to
 be used is the one used to access the OpenAPI definition itself.

repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 5 [json_name = "schemes"];

Specified by:: getSchemesList in interface 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 [json_name = "schemes"];

Specified by:: getSchemesCount in interface SwaggerOrBuilder
Returns:: The count of schemes.

getSchemes

public Scheme getSchemes(int index)

 The transfer protocol of the API. Values MUST be from the list: "http",
 "https", "ws", "wss". If the schemes is not included, the default scheme to
 be used is the one used to access the OpenAPI definition itself.

repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 5 [json_name = "schemes"];

Specified by:: getSchemes in interface SwaggerOrBuilder
Parameters:: index - The index of the element to return.
Returns:: The schemes at the given index.

getSchemesValueList

public java.util.List<java.lang.Integer> getSchemesValueList()

 The transfer protocol of the API. Values MUST be from the list: "http",
 "https", "ws", "wss". If the schemes is not included, the default scheme to
 be used is the one used to access the OpenAPI definition itself.

repeated .grpc.gateway.protoc_gen_openapiv2.options.Scheme schemes = 5 [json_name = "schemes"];

Specified by:: getSchemesValueList in interface 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 [json_name = "schemes"];
Specified by:

getSchemesValue in interface 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 [json_name = "consumes"];

Specified by:: getConsumesList in interface 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 [json_name = "consumes"];

Specified by:: getConsumesCount in interface SwaggerOrBuilder
Returns:: The count of consumes.

getConsumes

public java.lang.String getConsumes(int index)

 A list of MIME types the APIs can consume. This is global to all APIs but
 can be overridden on specific API calls. Value MUST be as described under
 Mime Types.

repeated string consumes = 6 [json_name = "consumes"];

Specified by:: getConsumes in interface 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 [json_name = "consumes"];

Specified by:: getConsumesBytes in interface 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 [json_name = "produces"];

Specified by:: getProducesList in interface 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 [json_name = "produces"];

Specified by:: getProducesCount in interface SwaggerOrBuilder
Returns:: The count of produces.

getProduces

public java.lang.String getProduces(int index)

 A list of MIME types the APIs can produce. This is global to all APIs but
 can be overridden on specific API calls. Value MUST be as described under
 Mime Types.

repeated string produces = 7 [json_name = "produces"];

Specified by:: getProduces in interface 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 [json_name = "produces"];

Specified by:: getProducesBytes in interface 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: 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 [json_name = "responses"];
Specified by:

getResponsesCount in interface SwaggerOrBuilder

containsResponses

public boolean containsResponses(java.lang.String key)

 An object to hold responses that can be used across operations. This
 property does not define global responses for all operations.

map<string, .grpc.gateway.protoc_gen_openapiv2.options.Response> responses = 10 [json_name = "responses"];

Specified by:: containsResponses in interface SwaggerOrBuilder

getResponses
```
@Deprecated
public java.util.Map<java.lang.String,Response> getResponses()
```
Deprecated.

Use getResponsesMap() instead.

Specified by:

getResponses in interface SwaggerOrBuilder

getResponsesMap

public java.util.Map<java.lang.String,Response> getResponsesMap()

 An object to hold responses that can be used across operations. This
 property does not define global responses for all operations.

map<string, .grpc.gateway.protoc_gen_openapiv2.options.Response> responses = 10 [json_name = "responses"];

Specified by:: getResponsesMap in interface SwaggerOrBuilder

getResponsesOrDefault

public Response getResponsesOrDefault(java.lang.String key,
                                      Response defaultValue)

 An object to hold responses that can be used across operations. This
 property does not define global responses for all operations.

map<string, .grpc.gateway.protoc_gen_openapiv2.options.Response> responses = 10 [json_name = "responses"];

Specified by:: getResponsesOrDefault in interface SwaggerOrBuilder

getResponsesOrThrow

public Response getResponsesOrThrow(java.lang.String key)

 An object to hold responses that can be used across operations. This
 property does not define global responses for all operations.

map<string, .grpc.gateway.protoc_gen_openapiv2.options.Response> responses = 10 [json_name = "responses"];

Specified by:: getResponsesOrThrow in interface 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 [json_name = "securityDefinitions"];
Specified by:

hasSecurityDefinitions in interface SwaggerOrBuilder

Returns:

Whether the securityDefinitions field is set.

getSecurityDefinitions
```
public SecurityDefinitions getSecurityDefinitions()
```
```
 Security scheme definitions that can be used across the specification.
 
```
.grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions security_definitions = 11 [json_name = "securityDefinitions"];
Specified by:

getSecurityDefinitions in interface SwaggerOrBuilder

Returns:

The securityDefinitions.

getSecurityDefinitionsOrBuilder
```
public SecurityDefinitionsOrBuilder getSecurityDefinitionsOrBuilder()
```
```
 Security scheme definitions that can be used across the specification.
 
```
.grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions security_definitions = 11 [json_name = "securityDefinitions"];
Specified by:

getSecurityDefinitionsOrBuilder in interface SwaggerOrBuilder