com.grpc.gateway.protoc_gen_openapiv2.options

Interface TagOrBuilder

All Superinterfaces:

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

All Known Implementing Classes:

Tag, Tag.Builder

public interface TagOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsExtensions(String key) Custom properties that start with "x-" such as "x-foo" used to describe extra functionality that is not covered by the standard OpenAPI Specification.
String	getDescription() A short description for the tag.
com.google.protobuf.ByteString	getDescriptionBytes() A short description for the tag.
Map<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.
Map<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(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(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 for this tag.
ExternalDocumentationOrBuilder	getExternalDocsOrBuilder() Additional external documentation for this tag.
String	getName() The name of the tag.
com.google.protobuf.ByteString	getNameBytes() The name of the tag.
boolean	hasExternalDocs() Additional external documentation for this tag.

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

getName

String getName()

 The name of the tag. Use it to allow override of the name of a
 global Tag object, then use that name to reference the tag throughout the
 OpenAPI file.
 

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

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 The name of the tag. Use it to allow override of the name of a
 global Tag object, then use that name to reference the tag throughout the
 OpenAPI file.
 

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

Returns:

The bytes for name.

getDescription

String getDescription()

 A short description for the tag. GFM syntax can be used for rich text
 representation.
 

string description = 2 [json_name = "description"];

Returns:

The description.

getDescriptionBytes

com.google.protobuf.ByteString getDescriptionBytes()

 A short description for the tag. GFM syntax can be used for rich text
 representation.
 

string description = 2 [json_name = "description"];

Returns:

The bytes for description.

hasExternalDocs

boolean hasExternalDocs()

 Additional external documentation for this tag.
 

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

Returns:

Whether the externalDocs field is set.

getExternalDocs

ExternalDocumentation getExternalDocs()

 Additional external documentation for this tag.
 

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

Returns:

The externalDocs.

getExternalDocsOrBuilder

ExternalDocumentationOrBuilder getExternalDocsOrBuilder()

 Additional external documentation for this tag.
 

.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 3 [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 = 4 [json_name = "extensions"];

containsExtensions

boolean containsExtensions(String key)

 Custom properties that start with "x-" such as "x-foo" used to describe
 extra functionality that is not covered by the standard OpenAPI Specification.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
 

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

getExtensions

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

Deprecated.

Use getExtensionsMap() instead.

getExtensionsMap

Map<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 = 4 [json_name = "extensions"];

getExtensionsOrDefault

com.google.protobuf.Value getExtensionsOrDefault(String key,
                                                 com.google.protobuf.Value defaultValue)

 Custom properties that start with "x-" such as "x-foo" used to describe
 extra functionality that is not covered by the standard OpenAPI Specification.
 See: https://swagger.io/docs/specification/2-0/swagger-extensions/
 

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

getExtensionsOrThrow

com.google.protobuf.Value getExtensionsOrThrow(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 = 4 [json_name = "extensions"];