com.grpc.gateway.protoc_gen_openapiv2.options

Interface SwaggerOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Swagger, Swagger.Builder

public interface SwaggerOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

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.
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.
java.util.List<java.lang.String>	getConsumesList() A list of MIME types the APIs can consume.
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.
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.
java.util.List<java.lang.String>	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.
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.
boolean	hasInfo() Provides metadata about the API.
boolean	hasSecurityDefinitions() Security scheme definitions that can be used across the specification.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getSwagger

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"];

Returns:

The swagger.

getSwaggerBytes

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"];

Returns:

The bytes for swagger.

hasInfo

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"];

Returns:

Whether the info field is set.

getInfo

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"];

Returns:

The info.

getInfoOrBuilder

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"];

getHost

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"];

Returns:

The host.

getHostBytes

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"];

Returns:

The bytes for host.

getBasePath

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"];

Returns:

The basePath.

getBasePathBytes

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"];

Returns:

The bytes for basePath.

getSchemesList

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"];

Returns:

A list containing the schemes.

getSchemesCount

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"];

Returns:

The count of schemes.

getSchemes

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"];

Parameters:

index - The index of the element to return.

Returns:

The schemes at the given index.

getSchemesValueList

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"];

Returns:

A list containing the enum numeric values on the wire for schemes.

getSchemesValue

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"];

Parameters:

index - The index of the value to return.

Returns:

The enum numeric value on the wire of schemes at the given index.

getConsumesList

java.util.List<java.lang.String> 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"];

Returns:

A list containing the consumes.

getConsumesCount

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"];

Returns:

The count of consumes.

getConsumes

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"];

Parameters:

index - The index of the element to return.

Returns:

The consumes at the given index.

getConsumesBytes

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"];

Parameters:

index - The index of the value to return.

Returns:

The bytes of the consumes at the given index.

getProducesList

java.util.List<java.lang.String> 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"];

Returns:

A list containing the produces.

getProducesCount

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"];

Returns:

The count of produces.

getProduces

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"];

Parameters:

index - The index of the element to return.

Returns:

The produces at the given index.

getProducesBytes

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"];

Parameters:

index - The index of the value to return.

Returns:

The bytes of the produces at the given index.

getResponsesCount

int getResponsesCount()

 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"];

containsResponses

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"];

getResponses

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

Deprecated.

Use getResponsesMap() instead.

getResponsesMap

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"];

getResponsesOrDefault

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"];

getResponsesOrThrow

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"];

hasSecurityDefinitions

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"];

Returns:

Whether the securityDefinitions field is set.

getSecurityDefinitions

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"];

Returns:

The securityDefinitions.

getSecurityDefinitionsOrBuilder

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"];

getSecurityList

java.util.List<SecurityRequirement> getSecurityList()

 A declaration of which security schemes are applied for the API as a whole.
 The list of values describes alternative security schemes that can be used
 (that is, there is a logical OR between the security requirements).
 Individual operations can override this definition.
 

repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12 [json_name = "security"];

getSecurity

SecurityRequirement getSecurity(int index)

 A declaration of which security schemes are applied for the API as a whole.
 The list of values describes alternative security schemes that can be used
 (that is, there is a logical OR between the security requirements).
 Individual operations can override this definition.
 

repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12 [json_name = "security"];

getSecurityCount

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 [json_name = "security"];

getSecurityOrBuilderList

java.util.List<? extends SecurityRequirementOrBuilder> getSecurityOrBuilderList()

 A declaration of which security schemes are applied for the API as a whole.
 The list of values describes alternative security schemes that can be used
 (that is, there is a logical OR between the security requirements).
 Individual operations can override this definition.
 

repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12 [json_name = "security"];

getSecurityOrBuilder

SecurityRequirementOrBuilder getSecurityOrBuilder(int index)

 A declaration of which security schemes are applied for the API as a whole.
 The list of values describes alternative security schemes that can be used
 (that is, there is a logical OR between the security requirements).
 Individual operations can override this definition.
 

repeated .grpc.gateway.protoc_gen_openapiv2.options.SecurityRequirement security = 12 [json_name = "security"];

getTagsList

java.util.List<Tag> 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 [json_name = "tags"];

getTags

Tag getTags(int index)

 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 [json_name = "tags"];

getTagsCount

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 [json_name = "tags"];

getTagsOrBuilderList

java.util.List<? extends TagOrBuilder> 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 [json_name = "tags"];

getTagsOrBuilder

TagOrBuilder getTagsOrBuilder(int index)

 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 [json_name = "tags"];

hasExternalDocs

boolean hasExternalDocs()

 Additional external documentation.
 

.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 14 [json_name = "externalDocs"];

Returns:

Whether the externalDocs field is set.

getExternalDocs

ExternalDocumentation getExternalDocs()

 Additional external documentation.
 

.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 14 [json_name = "externalDocs"];

Returns:

The externalDocs.

getExternalDocsOrBuilder

ExternalDocumentationOrBuilder getExternalDocsOrBuilder()

 Additional external documentation.
 

.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 14 [json_name = "externalDocs"];

getExtensionsCount

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.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
 

map<string, .google.protobuf.Value> extensions = 15 [json_name = "extensions"];

containsExtensions

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.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
 

map<string, .google.protobuf.Value> extensions = 15 [json_name = "extensions"];

getExtensions

@Deprecated
java.util.Map<java.lang.String,com.google.protobuf.Value> getExtensions()

Deprecated.

Use getExtensionsMap() instead.

getExtensionsMap

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.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
 

map<string, .google.protobuf.Value> extensions = 15 [json_name = "extensions"];

getExtensionsOrDefault

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.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
 

map<string, .google.protobuf.Value> extensions = 15 [json_name = "extensions"];

getExtensionsOrThrow

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.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
 

map<string, .google.protobuf.Value> extensions = 15 [json_name = "extensions"];