Package grpc.gateway.protoc_gen_openapiv2.options

Interface Openapiv2.TagOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Openapiv2.Tag, Openapiv2.Tag.Builder
Enclosing class:
Openapiv2
public static interface Openapiv2.TagOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription()
    A short description for the tag.
    com.google.protobuf.ByteString
    getDescriptionBytes()
    A short description for the tag.
    Openapiv2.ExternalDocumentation
    getExternalDocs()
    Additional external documentation for this tag.
    Openapiv2.ExternalDocumentationOrBuilder
    getExternalDocsOrBuilder()
    Additional external documentation for this tag.
    boolean
    hasExternalDocs()
    Additional external documentation for this tag.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getDescription

      String getDescription()
       A short description for the tag. GFM syntax can be used for rich text 
 representation.
      string description = 2;
      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;
      Returns:
      The bytes for description.

    • hasExternalDocs

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

    • getExternalDocs

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

    • getExternalDocsOrBuilder

      Openapiv2.ExternalDocumentationOrBuilder getExternalDocsOrBuilder()
       Additional external documentation for this tag.
      .grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 3;