Package grpc.gateway.protoc_gen_swagger.options

Class Openapiv2.Info

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Openapiv2.InfoOrBuilder, Serializable
    Enclosing class:
    Openapiv2
    public static final class Openapiv2.Info
extends com.google.protobuf.GeneratedMessageV3
implements Openapiv2.InfoOrBuilder
     `Info` is a representation of OpenAPI v2 specification's Info object.
 See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#infoObject
 Example:
  option (grpc.gateway.protoc_gen_swagger.options.openapiv2_swagger) = {
    info: {
      title: "Echo API";
      version: "1.0";
      description: ";
      contact: {
        name: "gRPC-Gateway project";
        url: "https://github.com/grpc-ecosystem/grpc-gateway";
        email: "none@example.com";
      };
      license: {
        name: "BSD 3-Clause License";
        url: "https://github.com/grpc-ecosystem/grpc-gateway/blob/master/LICENSE.txt";
      };
    };
    ...
  };
    Protobuf type grpc.gateway.protoc_gen_swagger.options.Info
    See Also:
    Serialized Form

    • Field Detail

      • title_

        private volatile Object title_

      • DESCRIPTION_FIELD_NUMBER

        public static final int DESCRIPTION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • description_

        private volatile Object description_

      • TERMS_OF_SERVICE_FIELD_NUMBER

        public static final int TERMS_OF_SERVICE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • termsOfService_

        private volatile Object termsOfService_

      • version_

        private volatile Object version_

      • EXTENSIONS_FIELD_NUMBER

        public static final int EXTENSIONS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • extensions_

        private com.google.protobuf.MapField<String,​com.google.protobuf.Value> extensions_

      • memoizedIsInitialized

        private byte memoizedIsInitialized

      • DEFAULT_INSTANCE

        private static final Openapiv2.Info DEFAULT_INSTANCE

      • PARSER

        private static final com.google.protobuf.Parser<Openapiv2.Info> PARSER

    • Constructor Detail

      • Info

        private Info​(com.google.protobuf.GeneratedMessageV3.Builder<?> builder)

      • Info

        private Info()

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField in class com.google.protobuf.GeneratedMessageV3

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getTitleBytes

        public com.google.protobuf.ByteString getTitleBytes()
         The title of the application.
        string title = 1;
        Specified by:
        getTitleBytes in interface Openapiv2.InfoOrBuilder
        Returns:
        The bytes for title.

      • getDescription

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

      • getDescriptionBytes

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

      • getTermsOfServiceBytes

        public com.google.protobuf.ByteString getTermsOfServiceBytes()
         The Terms of Service for the API.
        string terms_of_service = 3;
        Specified by:
        getTermsOfServiceBytes in interface Openapiv2.InfoOrBuilder
        Returns:
        The bytes for termsOfService.

      • hasContact

        public boolean hasContact()
         The contact information for the exposed API.
        .grpc.gateway.protoc_gen_swagger.options.Contact contact = 4;
        Specified by:
        hasContact in interface Openapiv2.InfoOrBuilder
        Returns:
        Whether the contact field is set.

      • hasLicense

        public boolean hasLicense()
         The license information for the exposed API.
        .grpc.gateway.protoc_gen_swagger.options.License license = 5;
        Specified by:
        hasLicense in interface Openapiv2.InfoOrBuilder
        Returns:
        Whether the license field is set.

      • getVersion

        public String getVersion()
         Provides the version of the application API (not to be confused
 with the specification version).
        string version = 6;
        Specified by:
        getVersion in interface Openapiv2.InfoOrBuilder
        Returns:
        The version.

      • getVersionBytes

        public com.google.protobuf.ByteString getVersionBytes()
         Provides the version of the application API (not to be confused
 with the specification version).
        string version = 6;
        Specified by:
        getVersionBytes in interface Openapiv2.InfoOrBuilder
        Returns:
        The bytes for version.

      • internalGetExtensions

        private com.google.protobuf.MapField<String,​com.google.protobuf.Value> internalGetExtensions()

      • getExtensionsOrDefault

        public com.google.protobuf.Value getExtensionsOrDefault​(String key,
                                                        com.google.protobuf.Value defaultValue)
        map<string, .google.protobuf.Value> extensions = 7;
        Specified by:
        getExtensionsOrDefault in interface Openapiv2.InfoOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Openapiv2.Info parseFrom​(ByteBuffer data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Openapiv2.Info parseFrom​(ByteBuffer data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Openapiv2.Info parseFrom​(com.google.protobuf.ByteString data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Openapiv2.Info parseFrom​(com.google.protobuf.ByteString data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Openapiv2.Info parseFrom​(byte[] data)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Openapiv2.Info parseFrom​(byte[] data,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Openapiv2.Info parseFrom​(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException
        Throws:
        IOException

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected Openapiv2.Info.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Openapiv2.Info getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Openapiv2.Info> parser()

      • getParserForType

        public com.google.protobuf.Parser<Openapiv2.Info> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

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