Swagger.Builder (nakama-java 2.5.0 API)

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

All Implemented Interfaces:: com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, SwaggerOrBuilder, java.lang.Cloneable

Enclosing class:: Swagger

public static final class Swagger.Builder
extends com.google.protobuf.GeneratedMessage.Builder<Swagger.Builder>
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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Swagger.Builder`	`addAllConsumes(java.lang.Iterable<java.lang.String> values)` A list of MIME types the APIs can consume.
`Swagger.Builder`	`addAllProduces(java.lang.Iterable<java.lang.String> values)` A list of MIME types the APIs can produce.
`Swagger.Builder`	`addAllSchemes(java.lang.Iterable<? extends Scheme> values)` The transfer protocol of the API.
`Swagger.Builder`	`addAllSchemesValue(java.lang.Iterable<java.lang.Integer> values)` The transfer protocol of the API.
`Swagger.Builder`	`addAllSecurity(java.lang.Iterable<? extends SecurityRequirement> values)` A declaration of which security schemes are applied for the API as a whole.
`Swagger.Builder`	`addAllTags(java.lang.Iterable<? extends Tag> values)` A list of tags for API documentation control.
`Swagger.Builder`	`addConsumes(java.lang.String value)` A list of MIME types the APIs can consume.
`Swagger.Builder`	`addConsumesBytes(com.google.protobuf.ByteString value)` A list of MIME types the APIs can consume.
`Swagger.Builder`	`addProduces(java.lang.String value)` A list of MIME types the APIs can produce.
`Swagger.Builder`	`addProducesBytes(com.google.protobuf.ByteString value)` A list of MIME types the APIs can produce.
`Swagger.Builder`	`addSchemes(Scheme value)` The transfer protocol of the API.
`Swagger.Builder`	`addSchemesValue(int value)` The transfer protocol of the API.
`Swagger.Builder`	`addSecurity(int index, SecurityRequirement.Builder builderForValue)` A declaration of which security schemes are applied for the API as a whole.
`Swagger.Builder`	`addSecurity(int index, SecurityRequirement value)` A declaration of which security schemes are applied for the API as a whole.
`Swagger.Builder`	`addSecurity(SecurityRequirement.Builder builderForValue)` A declaration of which security schemes are applied for the API as a whole.
`Swagger.Builder`	`addSecurity(SecurityRequirement value)` A declaration of which security schemes are applied for the API as a whole.
`SecurityRequirement.Builder`	`addSecurityBuilder()` A declaration of which security schemes are applied for the API as a whole.
`SecurityRequirement.Builder`	`addSecurityBuilder(int index)` A declaration of which security schemes are applied for the API as a whole.
`Swagger.Builder`	`addTags(int index, Tag.Builder builderForValue)` A list of tags for API documentation control.
`Swagger.Builder`	`addTags(int index, Tag value)` A list of tags for API documentation control.
`Swagger.Builder`	`addTags(Tag.Builder builderForValue)` A list of tags for API documentation control.
`Swagger.Builder`	`addTags(Tag value)` A list of tags for API documentation control.
`Tag.Builder`	`addTagsBuilder()` A list of tags for API documentation control.
`Tag.Builder`	`addTagsBuilder(int index)` A list of tags for API documentation control.
`Swagger`	`build()`
`Swagger`	`buildPartial()`
`Swagger.Builder`	`clear()`
`Swagger.Builder`	`clearBasePath()` The base path on which the API is served, which is relative to the host.
`Swagger.Builder`	`clearConsumes()` A list of MIME types the APIs can consume.
`Swagger.Builder`	`clearExtensions()`
`Swagger.Builder`	`clearExternalDocs()` Additional external documentation.
`Swagger.Builder`	`clearHost()` The host (name or ip) serving the API.
`Swagger.Builder`	`clearInfo()` Provides metadata about the API.
`Swagger.Builder`	`clearProduces()` A list of MIME types the APIs can produce.
`Swagger.Builder`	`clearResponses()`
`Swagger.Builder`	`clearSchemes()` The transfer protocol of the API.
`Swagger.Builder`	`clearSecurity()` A declaration of which security schemes are applied for the API as a whole.
`Swagger.Builder`	`clearSecurityDefinitions()` Security scheme definitions that can be used across the specification.
`Swagger.Builder`	`clearSwagger()` Specifies the OpenAPI Specification version being used.
`Swagger.Builder`	`clearTags()` A list of tags for API documentation control.
`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.
`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.
`Swagger`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`java.util.Map<java.lang.String,com.google.protobuf.Value>`	`getExtensions()` Deprecated.
`int`	`getExtensionsCount()` 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.
`ExternalDocumentation.Builder`	`getExternalDocsBuilder()` 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.
`Info.Builder`	`getInfoBuilder()` Provides metadata about the API.
`InfoOrBuilder`	`getInfoOrBuilder()` Provides metadata about the API.
`java.util.Map<java.lang.String,com.google.protobuf.Value>`	`getMutableExtensions()` Deprecated.
`java.util.Map<java.lang.String,Response>`	`getMutableResponses()` Deprecated.
`java.lang.String`	`getProduces(int index)` A list of MIME types the APIs can produce.
`com.google.protobuf.ByteString`	`getProducesBytes(int index)` A list of MIME types the APIs can produce.
`int`	`getProducesCount()` A list of MIME types the APIs can produce.
`com.google.protobuf.ProtocolStringList`	`getProducesList()` A list of MIME types the APIs can produce.
`java.util.Map<java.lang.String,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.
`SecurityRequirement.Builder`	`getSecurityBuilder(int index)` A declaration of which security schemes are applied for the API as a whole.
`java.util.List<SecurityRequirement.Builder>`	`getSecurityBuilderList()` A declaration of which security schemes are applied for the API as a whole.
`int`	`getSecurityCount()` A declaration of which security schemes are applied for the API as a whole.
`SecurityDefinitions`	`getSecurityDefinitions()` Security scheme definitions that can be used across the specification.
`SecurityDefinitions.Builder`	`getSecurityDefinitionsBuilder()` 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.
`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.
`Tag.Builder`	`getTagsBuilder(int index)` A list of tags for API documentation control.
`java.util.List<Tag.Builder>`	`getTagsBuilderList()` 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.
`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)`
`protected com.google.protobuf.MapFieldReflectionAccessor`	`internalGetMutableMapFieldReflection(int number)`
`boolean`	`isInitialized()`
`Swagger.Builder`	`mergeExternalDocs(ExternalDocumentation value)` Additional external documentation.
`Swagger.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`Swagger.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`Swagger.Builder`	`mergeFrom(Swagger other)`
`Swagger.Builder`	`mergeInfo(Info value)` Provides metadata about the API.
`Swagger.Builder`	`mergeSecurityDefinitions(SecurityDefinitions value)` Security scheme definitions that can be used across the specification.
`Swagger.Builder`	`putAllExtensions(java.util.Map<java.lang.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.
`Swagger.Builder`	`putAllResponses(java.util.Map<java.lang.String,Response> values)` An object to hold responses that can be used across operations.
`Swagger.Builder`	`putExtensions(java.lang.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`	`putExtensionsBuilderIfAbsent(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.
`Swagger.Builder`	`putResponses(java.lang.String key, Response value)` An object to hold responses that can be used across operations.
`Response.Builder`	`putResponsesBuilderIfAbsent(java.lang.String key)` An object to hold responses that can be used across operations.
`Swagger.Builder`	`removeExtensions(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.
`Swagger.Builder`	`removeResponses(java.lang.String key)` An object to hold responses that can be used across operations.
`Swagger.Builder`	`removeSecurity(int index)` A declaration of which security schemes are applied for the API as a whole.
`Swagger.Builder`	`removeTags(int index)` A list of tags for API documentation control.
`Swagger.Builder`	`setBasePath(java.lang.String value)` The base path on which the API is served, which is relative to the host.
`Swagger.Builder`	`setBasePathBytes(com.google.protobuf.ByteString value)` The base path on which the API is served, which is relative to the host.
`Swagger.Builder`	`setConsumes(int index, java.lang.String value)` A list of MIME types the APIs can consume.
`Swagger.Builder`	`setExternalDocs(ExternalDocumentation.Builder builderForValue)` Additional external documentation.
`Swagger.Builder`	`setExternalDocs(ExternalDocumentation value)` Additional external documentation.
`Swagger.Builder`	`setHost(java.lang.String value)` The host (name or ip) serving the API.
`Swagger.Builder`	`setHostBytes(com.google.protobuf.ByteString value)` The host (name or ip) serving the API.
`Swagger.Builder`	`setInfo(Info.Builder builderForValue)` Provides metadata about the API.
`Swagger.Builder`	`setInfo(Info value)` Provides metadata about the API.
`Swagger.Builder`	`setProduces(int index, java.lang.String value)` A list of MIME types the APIs can produce.
`Swagger.Builder`	`setSchemes(int index, Scheme value)` The transfer protocol of the API.
`Swagger.Builder`	`setSchemesValue(int index, int value)` The transfer protocol of the API.
`Swagger.Builder`	`setSecurity(int index, SecurityRequirement.Builder builderForValue)` A declaration of which security schemes are applied for the API as a whole.
`Swagger.Builder`	`setSecurity(int index, SecurityRequirement value)` A declaration of which security schemes are applied for the API as a whole.
`Swagger.Builder`	`setSecurityDefinitions(SecurityDefinitions.Builder builderForValue)` Security scheme definitions that can be used across the specification.
`Swagger.Builder`	`setSecurityDefinitions(SecurityDefinitions value)` Security scheme definitions that can be used across the specification.
`Swagger.Builder`	`setSwagger(java.lang.String value)` Specifies the OpenAPI Specification version being used.
`Swagger.Builder`	`setSwaggerBytes(com.google.protobuf.ByteString value)` Specifies the OpenAPI Specification version being used.
`Swagger.Builder`	`setTags(int index, Tag.Builder builderForValue)` A list of tags for API documentation control.
`Swagger.Builder`	`setTags(int index, Tag value)` 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, newUninitializedMessageException

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

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

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

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.Builder<Swagger.Builder>

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

internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<Swagger.Builder>

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

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<Swagger.Builder>

clear
```
public Swagger.Builder clear()
```
Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessage.Builder<Swagger.Builder>

getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Swagger.Builder>

getDefaultInstanceForType
```
public Swagger getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build
```
public Swagger build()
```
Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial
```
public Swagger buildPartial()
```
Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom
```
public Swagger.Builder mergeFrom(com.google.protobuf.Message other)
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Swagger.Builder>

mergeFrom

public Swagger.Builder mergeFrom(Swagger other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Swagger.Builder>

mergeFrom
```
public Swagger.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws java.io.IOException
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Swagger.Builder>

Throws:

java.io.IOException

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.

setSwagger

public Swagger.Builder setSwagger(java.lang.String value)

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

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

Parameters:: value - The swagger to set.
Returns:: This builder for chaining.

clearSwagger

public Swagger.Builder clearSwagger()

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

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

Returns:: This builder for chaining.

setSwaggerBytes

public Swagger.Builder setSwaggerBytes(com.google.protobuf.ByteString value)

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

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

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 [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.

setInfo

public Swagger.Builder setInfo(Info value)

 Provides metadata about the API. The metadata can be used by the
 clients if needed.

.grpc.gateway.protoc_gen_openapiv2.options.Info info = 2 [json_name = "info"];

setInfo

public Swagger.Builder setInfo(Info.Builder builderForValue)

 Provides metadata about the API. The metadata can be used by the
 clients if needed.

.grpc.gateway.protoc_gen_openapiv2.options.Info info = 2 [json_name = "info"];

mergeInfo

public Swagger.Builder mergeInfo(Info value)

 Provides metadata about the API. The metadata can be used by the
 clients if needed.

.grpc.gateway.protoc_gen_openapiv2.options.Info info = 2 [json_name = "info"];

clearInfo

public Swagger.Builder clearInfo()

 Provides metadata about the API. The metadata can be used by the
 clients if needed.

.grpc.gateway.protoc_gen_openapiv2.options.Info info = 2 [json_name = "info"];

getInfoBuilder

public Info.Builder getInfoBuilder()

 Provides metadata about the API. The metadata can be used by the
 clients if needed.

.grpc.gateway.protoc_gen_openapiv2.options.Info info = 2 [json_name = "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.

setHost

public Swagger.Builder setHost(java.lang.String value)

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

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

Parameters:: value - The host to set.
Returns:: This builder for chaining.

clearHost

public Swagger.Builder clearHost()

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

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

Returns:: This builder for chaining.

setHostBytes

public Swagger.Builder setHostBytes(com.google.protobuf.ByteString value)

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

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

Parameters:: value - The bytes for host to set.
Returns:: This builder for chaining.

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.

setBasePath

public Swagger.Builder setBasePath(java.lang.String value)

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

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

Parameters:: value - The basePath to set.
Returns:: This builder for chaining.

clearBasePath

public Swagger.Builder clearBasePath()

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

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

Returns:: This builder for chaining.

setBasePathBytes

public Swagger.Builder setBasePathBytes(com.google.protobuf.ByteString value)

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

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

Parameters:: value - The bytes for basePath to set.
Returns:: This builder for chaining.

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.

setSchemes

public Swagger.Builder setSchemes(int index,
                                  Scheme value)

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

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

Parameters:: index - The index to set the value at.; value - The schemes to set.
Returns:: This builder for chaining.

addSchemes

public Swagger.Builder addSchemes(Scheme value)

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

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

Parameters:: value - The schemes to add.
Returns:: This builder for chaining.

addAllSchemes

public Swagger.Builder addAllSchemes(java.lang.Iterable<? extends Scheme> values)

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

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

Parameters:: values - The schemes to add.
Returns:: This builder for chaining.

clearSchemes

public Swagger.Builder clearSchemes()

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

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

Returns:: This builder for chaining.

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.

setSchemesValue

public Swagger.Builder setSchemesValue(int index,
                                       int value)

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

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

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

public Swagger.Builder addSchemesValue(int value)

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

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

Parameters:: value - The enum numeric value on the wire for schemes to add.
Returns:: This builder for chaining.

addAllSchemesValue

public Swagger.Builder addAllSchemesValue(java.lang.Iterable<java.lang.Integer> values)

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

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

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 [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.

setConsumes

public Swagger.Builder setConsumes(int index,
                                   java.lang.String value)

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

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

Parameters:: index - The index to set the value at.; value - The consumes to set.
Returns:: This builder for chaining.

addConsumes

public Swagger.Builder addConsumes(java.lang.String value)

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

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

Parameters:: value - The consumes to add.
Returns:: This builder for chaining.

addAllConsumes

public Swagger.Builder addAllConsumes(java.lang.Iterable<java.lang.String> values)

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

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

Parameters:: values - The consumes to add.
Returns:: This builder for chaining.

clearConsumes

public Swagger.Builder clearConsumes()

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

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

Returns:: This builder for chaining.

addConsumesBytes

public Swagger.Builder addConsumesBytes(com.google.protobuf.ByteString value)

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

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

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 [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.

setProduces

public Swagger.Builder setProduces(int index,
                                   java.lang.String value)

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

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

Parameters:: index - The index to set the value at.; value - The produces to set.
Returns:: This builder for chaining.

addProduces

public Swagger.Builder addProduces(java.lang.String value)

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

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

Parameters:: value - The produces to add.
Returns:: This builder for chaining.

addAllProduces

public Swagger.Builder addAllProduces(java.lang.Iterable<java.lang.String> values)

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

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

Parameters:: values - The produces to add.
Returns:: This builder for chaining.

clearProduces

public Swagger.Builder clearProduces()

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

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

Returns:: This builder for chaining.

addProducesBytes

public Swagger.Builder addProducesBytes(com.google.protobuf.ByteString value)

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

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

Parameters:: value - The bytes of the produces to add.
Returns:: This builder for chaining.

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

clearResponses

public Swagger.Builder clearResponses()

removeResponses

public Swagger.Builder removeResponses(java.lang.String key)

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

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

getMutableResponses

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

Deprecated.

Use alternate mutation accessors instead.

putResponses

public Swagger.Builder putResponses(java.lang.String key,
                                    Response value)

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

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

putAllResponses

public Swagger.Builder putAllResponses(java.util.Map<java.lang.String,Response> values)

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

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

putResponsesBuilderIfAbsent

public Response.Builder putResponsesBuilderIfAbsent(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"];

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.

setSecurityDefinitions

public Swagger.Builder setSecurityDefinitions(SecurityDefinitions value)

 Security scheme definitions that can be used across the specification.

.grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions security_definitions = 11 [json_name = "securityDefinitions"];

setSecurityDefinitions

public Swagger.Builder setSecurityDefinitions(SecurityDefinitions.Builder builderForValue)

 Security scheme definitions that can be used across the specification.

.grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions security_definitions = 11 [json_name = "securityDefinitions"];

mergeSecurityDefinitions

public Swagger.Builder mergeSecurityDefinitions(SecurityDefinitions value)

 Security scheme definitions that can be used across the specification.

.grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions security_definitions = 11 [json_name = "securityDefinitions"];

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

getSecurityDefinitionsBuilder
```
public SecurityDefinitions.Builder getSecurityDefinitionsBuilder()
```
```
 Security scheme definitions that can be used across the specification.
 
```
.grpc.gateway.protoc_gen_openapiv2.options.SecurityDefinitions security_definitions = 11 [json_name = "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