public final class Tag extends com.google.protobuf.GeneratedMessageV3 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 | Class and Description |
|---|---|
static class |
Tag.Builder
`Tag` is a representation of OpenAPI v2 specification's Tag object.
|
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
DESCRIPTION_FIELD_NUMBER |
static int |
EXTENSIONS_FIELD_NUMBER |
static int |
EXTERNAL_DOCS_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
| 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.
|
boolean |
equals(Object obj) |
static Tag |
getDefaultInstance() |
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() |
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.
|
com.google.protobuf.Parser<Tag> |
getParserForType() |
int |
getSerializedSize() |
boolean |
hasExternalDocs()
Additional external documentation for this tag.
|
int |
hashCode() |
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
protected com.google.protobuf.MapFieldReflectionAccessor |
internalGetMapFieldReflection(int number) |
boolean |
isInitialized() |
static Tag.Builder |
newBuilder() |
static Tag.Builder |
newBuilder(Tag prototype) |
Tag.Builder |
newBuilderForType() |
protected Tag.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static Tag |
parseDelimitedFrom(InputStream input) |
static Tag |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Tag |
parseFrom(byte[] data) |
static Tag |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Tag |
parseFrom(ByteBuffer data) |
static Tag |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Tag |
parseFrom(com.google.protobuf.ByteString data) |
static Tag |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Tag |
parseFrom(com.google.protobuf.CodedInputStream input) |
static Tag |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static Tag |
parseFrom(InputStream input) |
static Tag |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<Tag> |
parser() |
Tag.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int NAME_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
public static final int EXTERNAL_DOCS_FIELD_NUMBER
public static final int EXTENSIONS_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public 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 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 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 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 final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static Tag parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Tag parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Tag parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Tag parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Tag parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Tag parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Tag parseFrom(InputStream input) throws IOException
IOExceptionpublic static Tag parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Tag parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static Tag parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Tag parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static Tag parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic Tag.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static Tag.Builder newBuilder()
public static Tag.Builder newBuilder(Tag prototype)
public Tag.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected Tag.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static Tag getDefaultInstance()
public static com.google.protobuf.Parser<Tag> parser()
public com.google.protobuf.Parser<Tag> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public Tag getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2024. All rights reserved.