Package grpc.gateway.protoc_gen_openapiv2.options

Class Openapiv2.Tag.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<Openapiv2.Tag.Builder>
grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.Tag.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Openapiv2.TagOrBuilder, Cloneable
Enclosing class:
Openapiv2.Tag
public static final class Openapiv2.Tag.Builder extends com.google.protobuf.GeneratedMessage.Builder<Openapiv2.Tag.Builder> implements Openapiv2.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#tagObject
Protobuf type grpc.gateway.protoc_gen_openapiv2.options.Tag

  • Method Details

    • 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<Openapiv2.Tag.Builder>

    • internalGetMutableMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
      Overrides:
      internalGetMutableMapFieldReflection in class com.google.protobuf.GeneratedMessage.Builder<Openapiv2.Tag.Builder>

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<Openapiv2.Tag.Builder>

    • clear

      public Openapiv2.Tag.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<Openapiv2.Tag.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<Openapiv2.Tag.Builder>

    • getDefaultInstanceForType

      public Openapiv2.Tag getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

    • build

      public Openapiv2.Tag build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder

    • buildPartial

      public Openapiv2.Tag buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder

    • mergeFrom

      public Openapiv2.Tag.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<Openapiv2.Tag.Builder>

    • mergeFrom

      public Openapiv2.Tag.Builder mergeFrom(Openapiv2.Tag other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Openapiv2.Tag.Builder>

    • mergeFrom

      public Openapiv2.Tag.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws 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<Openapiv2.Tag.Builder>
      Throws:
      IOException

    • getName

      public 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;
      Specified by:
      getName in interface Openapiv2.TagOrBuilder
      Returns:
      The name.

    • getNameBytes

      public 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;
      Specified by:
      getNameBytes in interface Openapiv2.TagOrBuilder
      Returns:
      The bytes for name.

    • setName

      public Openapiv2.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;
      Parameters:
      value - The name to set.
      Returns:
      This builder for chaining.

    • clearName

      public Openapiv2.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;
      Returns:
      This builder for chaining.

    • setNameBytes

      public Openapiv2.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;
      Parameters:
      value - The bytes for name to set.
      Returns:
      This builder for chaining.

    • getDescription

      public String getDescription()
       A short description for the tag. GFM syntax can be used for rich text
 representation.
      string description = 2;
      Specified by:
      getDescription in interface Openapiv2.TagOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       A short description for the tag. GFM syntax can be used for rich text
 representation.
      string description = 2;
      Specified by:
      getDescriptionBytes in interface Openapiv2.TagOrBuilder
      Returns:
      The bytes for description.

    • setDescription

      public Openapiv2.Tag.Builder setDescription(String value)
       A short description for the tag. GFM syntax can be used for rich text
 representation.
      string description = 2;
      Parameters:
      value - The description to set.
      Returns:
      This builder for chaining.

    • clearDescription

      public Openapiv2.Tag.Builder clearDescription()
       A short description for the tag. GFM syntax can be used for rich text
 representation.
      string description = 2;
      Returns:
      This builder for chaining.

    • setDescriptionBytes

      public Openapiv2.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;
      Parameters:
      value - The bytes for description to set.
      Returns:
      This builder for chaining.

    • hasExternalDocs

      public boolean hasExternalDocs()
       Additional external documentation for this tag.
      .grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 3;
      Specified by:
      hasExternalDocs in interface Openapiv2.TagOrBuilder
      Returns:
      Whether the externalDocs field is set.

    • getExternalDocs

      public Openapiv2.ExternalDocumentation getExternalDocs()
       Additional external documentation for this tag.
      .grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 3;
      Specified by:
      getExternalDocs in interface Openapiv2.TagOrBuilder
      Returns:
      The externalDocs.

    • setExternalDocs

      public Openapiv2.Tag.Builder setExternalDocs(Openapiv2.ExternalDocumentation value)
       Additional external documentation for this tag.
      .grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 3;

    • setExternalDocs

      public Openapiv2.Tag.Builder setExternalDocs(Openapiv2.ExternalDocumentation.Builder builderForValue)
       Additional external documentation for this tag.
      .grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 3;

    • mergeExternalDocs

      public Openapiv2.Tag.Builder mergeExternalDocs(Openapiv2.ExternalDocumentation value)
       Additional external documentation for this tag.
      .grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 3;

    • clearExternalDocs

      public Openapiv2.Tag.Builder clearExternalDocs()
       Additional external documentation for this tag.
      .grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 3;

    • getExternalDocsBuilder

      public Openapiv2.ExternalDocumentation.Builder getExternalDocsBuilder()
       Additional external documentation for this tag.
      .grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 3;

    • getExternalDocsOrBuilder

      public Openapiv2.ExternalDocumentationOrBuilder getExternalDocsOrBuilder()
       Additional external documentation for this tag.
      .grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 3;
      Specified by:
      getExternalDocsOrBuilder in interface Openapiv2.TagOrBuilder

    • getExtensionsCount

      public int getExtensionsCount()
      Description copied from interface: Openapiv2.TagOrBuilder
       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;
      Specified by:
      getExtensionsCount in interface Openapiv2.TagOrBuilder

    • containsExtensions

      public 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;
      Specified by:
      containsExtensions in interface Openapiv2.TagOrBuilder

    • getExtensions

      @Deprecated public Map<String,com.google.protobuf.Value> getExtensions()
      Deprecated.
      Use getExtensionsMap() instead.
      Specified by:
      getExtensions in interface Openapiv2.TagOrBuilder

    • getExtensionsMap

      public 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;
      Specified by:
      getExtensionsMap in interface Openapiv2.TagOrBuilder

    • getExtensionsOrDefault

      public 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;
      Specified by:
      getExtensionsOrDefault in interface Openapiv2.TagOrBuilder

    • getExtensionsOrThrow

      public 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;
      Specified by:
      getExtensionsOrThrow in interface Openapiv2.TagOrBuilder

    • clearExtensions

      public Openapiv2.Tag.Builder clearExtensions()

    • removeExtensions

      public Openapiv2.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;

    • getMutableExtensions

      @Deprecated public Map<String,com.google.protobuf.Value> getMutableExtensions()
      Deprecated.
      Use alternate mutation accessors instead.

    • putExtensions

      public Openapiv2.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;

    • putAllExtensions

      public Openapiv2.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;

    • putExtensionsBuilderIfAbsent

      public com.google.protobuf.Value.Builder putExtensionsBuilderIfAbsent(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;