public static final class Tag.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Tag.Builder> implements TagOrBuilder
`Tag` is a representation of OpenAPI v2 specification's Tag object. See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#tagObjectProtobuf type
grpc.gateway.protoc_gen_openapiv2.options.Tag| Modifier and Type | Method and Description |
|---|---|
Tag.Builder |
addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Tag |
build() |
Tag |
buildPartial() |
Tag.Builder |
clear() |
Tag.Builder |
clearDescription()
A short description for the tag.
|
Tag.Builder |
clearExtensions() |
Tag.Builder |
clearExternalDocs()
Additional external documentation for this tag.
|
Tag.Builder |
clearField(com.google.protobuf.Descriptors.FieldDescriptor field) |
Tag.Builder |
clearName()
The name of the tag.
|
Tag.Builder |
clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) |
Tag.Builder |
clone() |
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.
|
Tag |
getDefaultInstanceForType() |
String |
getDescription()
A short description for the tag.
|
com.google.protobuf.ByteString |
getDescriptionBytes()
A short description for the tag.
|
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
com.google.protobuf.Descriptors.Descriptor |
getDescriptorForType() |
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.
|
ExternalDocumentation.Builder |
getExternalDocsBuilder()
Additional external documentation for this tag.
|
ExternalDocumentationOrBuilder |
getExternalDocsOrBuilder()
Additional external documentation for this tag.
|
Map<String,com.google.protobuf.Value> |
getMutableExtensions()
Deprecated.
|
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.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapField |
internalGetMapField(int number) |
protected com.google.protobuf.MapField |
internalGetMutableMapField(int number) |
boolean |
isInitialized() |
Tag.Builder |
mergeExternalDocs(ExternalDocumentation value)
Additional external documentation for this tag.
|
Tag.Builder |
mergeFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
Tag.Builder |
mergeFrom(com.google.protobuf.Message other) |
Tag.Builder |
mergeFrom(Tag other) |
Tag.Builder |
mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
Tag.Builder |
putAllExtensions(Map<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.
|
Tag.Builder |
putExtensions(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.
|
Tag.Builder |
removeExtensions(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.
|
Tag.Builder |
setDescription(String value)
A short description for the tag.
|
Tag.Builder |
setDescriptionBytes(com.google.protobuf.ByteString value)
A short description for the tag.
|
Tag.Builder |
setExternalDocs(ExternalDocumentation.Builder builderForValue)
Additional external documentation for this tag.
|
Tag.Builder |
setExternalDocs(ExternalDocumentation value)
Additional external documentation for this tag.
|
Tag.Builder |
setField(com.google.protobuf.Descriptors.FieldDescriptor field,
Object value) |
Tag.Builder |
setName(String value)
The name of the tag.
|
Tag.Builder |
setNameBytes(com.google.protobuf.ByteString value)
The name of the tag.
|
Tag.Builder |
setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
int index,
Object value) |
Tag.Builder |
setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) |
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringaddAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionequals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitfindInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneofpublic static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapField internalGetMapField(int number)
internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<Tag.Builder>protected com.google.protobuf.MapField internalGetMutableMapField(int number)
internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<Tag.Builder>protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Tag.Builder>public Tag.Builder clear()
clear in interface com.google.protobuf.Message.Builderclear in interface com.google.protobuf.MessageLite.Builderclear in class com.google.protobuf.GeneratedMessageV3.Builder<Tag.Builder>public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
getDescriptorForType in interface com.google.protobuf.Message.BuildergetDescriptorForType in interface com.google.protobuf.MessageOrBuildergetDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Tag.Builder>public Tag getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderpublic Tag build()
build in interface com.google.protobuf.Message.Builderbuild in interface com.google.protobuf.MessageLite.Builderpublic Tag buildPartial()
buildPartial in interface com.google.protobuf.Message.BuilderbuildPartial in interface com.google.protobuf.MessageLite.Builderpublic Tag.Builder clone()
clone in interface com.google.protobuf.Message.Builderclone in interface com.google.protobuf.MessageLite.Builderclone in class com.google.protobuf.GeneratedMessageV3.Builder<Tag.Builder>public Tag.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
setField in interface com.google.protobuf.Message.BuildersetField in class com.google.protobuf.GeneratedMessageV3.Builder<Tag.Builder>public Tag.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
clearField in interface com.google.protobuf.Message.BuilderclearField in class com.google.protobuf.GeneratedMessageV3.Builder<Tag.Builder>public Tag.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
clearOneof in interface com.google.protobuf.Message.BuilderclearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Tag.Builder>public Tag.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
setRepeatedField in interface com.google.protobuf.Message.BuildersetRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Tag.Builder>public Tag.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
addRepeatedField in interface com.google.protobuf.Message.BuilderaddRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Tag.Builder>public Tag.Builder mergeFrom(com.google.protobuf.Message other)
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Tag.Builder>public Tag.Builder mergeFrom(Tag other)
public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Tag.Builder>public Tag.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
mergeFrom in interface com.google.protobuf.Message.BuildermergeFrom in interface com.google.protobuf.MessageLite.BuildermergeFrom in class com.google.protobuf.AbstractMessage.Builder<Tag.Builder>IOExceptionpublic 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"];getName in interface TagOrBuilderpublic 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"];getNameBytes in interface TagOrBuilderpublic Tag.Builder setName(String value)
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"];value - The name to set.public Tag.Builder clearName()
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"];public Tag.Builder setNameBytes(com.google.protobuf.ByteString value)
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"];value - The bytes for name to set.public String getDescription()
A short description for the tag. GFM syntax can be used for rich text representation.
string description = 2 [json_name = "description"];getDescription in interface TagOrBuilderpublic 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"];getDescriptionBytes in interface TagOrBuilderpublic Tag.Builder setDescription(String value)
A short description for the tag. GFM syntax can be used for rich text representation.
string description = 2 [json_name = "description"];value - The description to set.public Tag.Builder clearDescription()
A short description for the tag. GFM syntax can be used for rich text representation.
string description = 2 [json_name = "description"];public Tag.Builder setDescriptionBytes(com.google.protobuf.ByteString value)
A short description for the tag. GFM syntax can be used for rich text representation.
string description = 2 [json_name = "description"];value - The bytes for description to set.public boolean hasExternalDocs()
Additional external documentation for this tag.
.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 3 [json_name = "externalDocs"];hasExternalDocs in interface TagOrBuilderpublic ExternalDocumentation getExternalDocs()
Additional external documentation for this tag.
.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 3 [json_name = "externalDocs"];getExternalDocs in interface TagOrBuilderpublic Tag.Builder setExternalDocs(ExternalDocumentation value)
Additional external documentation for this tag.
.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 3 [json_name = "externalDocs"];public Tag.Builder setExternalDocs(ExternalDocumentation.Builder builderForValue)
Additional external documentation for this tag.
.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 3 [json_name = "externalDocs"];public Tag.Builder mergeExternalDocs(ExternalDocumentation value)
Additional external documentation for this tag.
.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 3 [json_name = "externalDocs"];public Tag.Builder clearExternalDocs()
Additional external documentation for this tag.
.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 3 [json_name = "externalDocs"];public ExternalDocumentation.Builder getExternalDocsBuilder()
Additional external documentation for this tag.
.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 3 [json_name = "externalDocs"];public ExternalDocumentationOrBuilder getExternalDocsOrBuilder()
Additional external documentation for this tag.
.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 3 [json_name = "externalDocs"];getExternalDocsOrBuilder in interface TagOrBuilderpublic int getExtensionsCount()
TagOrBuilderCustom 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"];getExtensionsCount in interface TagOrBuilderpublic 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"];containsExtensions in interface TagOrBuilder@Deprecated public Map<String,com.google.protobuf.Value> getExtensions()
getExtensionsMap() instead.getExtensions in interface TagOrBuilderpublic 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"];getExtensionsMap in interface TagOrBuilderpublic 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"];getExtensionsOrDefault in interface TagOrBuilderpublic 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"];getExtensionsOrThrow in interface TagOrBuilderpublic Tag.Builder clearExtensions()
public Tag.Builder removeExtensions(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"];@Deprecated public Map<String,com.google.protobuf.Value> getMutableExtensions()
public Tag.Builder putExtensions(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. See: https://swagger.io/docs/specification/2-0/swagger-extensions/
map<string, .google.protobuf.Value> extensions = 4 [json_name = "extensions"];public Tag.Builder putAllExtensions(Map<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. See: https://swagger.io/docs/specification/2-0/swagger-extensions/
map<string, .google.protobuf.Value> extensions = 4 [json_name = "extensions"];public final Tag.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
setUnknownFields in interface com.google.protobuf.Message.BuildersetUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Tag.Builder>public final Tag.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
mergeUnknownFields in interface com.google.protobuf.Message.BuildermergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Tag.Builder>Copyright © 2023. All rights reserved.