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

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      boolean containsExtensions​(java.lang.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.
      java.lang.String getDescription()
      A short description for the tag.
      com.google.protobuf.ByteString getDescriptionBytes()
      A short description for the tag.
      java.util.Map<java.lang.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.
      java.util.Map<java.lang.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​(java.lang.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​(java.lang.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.
      Openapiv2.ExternalDocumentation getExternalDocs()
      Additional external documentation for this tag.
      Openapiv2.ExternalDocumentationOrBuilder getExternalDocsOrBuilder()
      Additional external documentation for this tag.
      java.lang.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.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

    • Method Detail

      • getName

        java.lang.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;
        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;
        Returns:
        The bytes for name.

      • getDescription

        java.lang.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;

      • 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;

      • containsExtensions

        boolean containsExtensions​(java.lang.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;

      • getExtensions

        @Deprecated
java.util.Map<java.lang.String,​com.google.protobuf.Value> getExtensions()
        Deprecated.
        Use getExtensionsMap() instead.

      • getExtensionsMap

        java.util.Map<java.lang.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;

      • getExtensionsOrDefault

        com.google.protobuf.Value getExtensionsOrDefault​(java.lang.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;

      • getExtensionsOrThrow

        com.google.protobuf.Value getExtensionsOrThrow​(java.lang.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;