Package grpc.gateway.protoc_gen_openapiv2.options

Class Openapiv2.Info

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
grpc.gateway.protoc_gen_openapiv2.options.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.GeneratedMessage 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_openapiv2.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/main/LICENSE";
 };
 };
 ...
 };
Protobuf type grpc.gateway.protoc_gen_openapiv2.options.Info
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Openapiv2.Info.Builder
    `Info` is a representation of OpenAPI v2 specification's Info object.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CONTACT_FIELD_NUMBER
     
    static final int
    DESCRIPTION_FIELD_NUMBER
     
    static final int
    EXTENSIONS_FIELD_NUMBER
     
    static final int
    LICENSE_FIELD_NUMBER
     
    static final int
    TERMS_OF_SERVICE_FIELD_NUMBER
     
    static final int
    TITLE_FIELD_NUMBER
     
    static final int
    VERSION_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    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)
     
    Openapiv2.Contact
    getContact()
    The contact information for the exposed API.
    Openapiv2.ContactOrBuilder
    getContactOrBuilder()
    The contact information for the exposed API.
    static Openapiv2.Info
    getDefaultInstance()
     
    Openapiv2.Info
    getDefaultInstanceForType()
     
    String
    getDescription()
    A short description of the application.
    com.google.protobuf.ByteString
    getDescriptionBytes()
    A short description of the application.
    static final 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.
    Openapiv2.License
    getLicense()
    The license information for the exposed API.
    Openapiv2.LicenseOrBuilder
    getLicenseOrBuilder()
    The license information for the exposed API.
    com.google.protobuf.Parser<Openapiv2.Info>
    getParserForType()
     
    int
    getSerializedSize()
     
    String
    getTermsOfService()
    The Terms of Service for the API.
    com.google.protobuf.ByteString
    getTermsOfServiceBytes()
    The Terms of Service for the API.
    String
    getTitle()
    The title of the application.
    com.google.protobuf.ByteString
    getTitleBytes()
    The title of the application.
    String
    getVersion()
    Provides the version of the application API (not to be confused with the specification version).
    com.google.protobuf.ByteString
    getVersionBytes()
    Provides the version of the application API (not to be confused with the specification version).
    boolean
    hasContact()
    The contact information for the exposed API.
    int
    hashCode()
     
    boolean
    hasLicense()
    The license information for the exposed API.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    protected com.google.protobuf.MapFieldReflectionAccessor
    internalGetMapFieldReflection(int number)
     
    final boolean
    isInitialized()
     
    static Openapiv2.Info.Builder
    newBuilder()
     
    static Openapiv2.Info.Builder
    newBuilder(Openapiv2.Info prototype)
     
    Openapiv2.Info.Builder
    newBuilderForType()
     
    protected Openapiv2.Info.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Openapiv2.Info
    parseDelimitedFrom(InputStream input)
     
    static Openapiv2.Info
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Openapiv2.Info
    parseFrom(byte[] data)
     
    static Openapiv2.Info
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Openapiv2.Info
    parseFrom(com.google.protobuf.ByteString data)
     
    static Openapiv2.Info
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Openapiv2.Info
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Openapiv2.Info
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Openapiv2.Info
    parseFrom(InputStream input)
     
    static Openapiv2.Info
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Openapiv2.Info
    parseFrom(ByteBuffer data)
     
    static Openapiv2.Info
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Openapiv2.Info>
    parser()
     
    Openapiv2.Info.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

  • 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

    • internalGetFieldAccessorTable

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

    • getTitle

      public String getTitle()
       The title of the application.
      string title = 1;
      Specified by:
      getTitle in interface Openapiv2.InfoOrBuilder
      Returns:
      The title.

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

    • getTermsOfService

      public String getTermsOfService()
       The Terms of Service for the API.
      string terms_of_service = 3;
      Specified by:
      getTermsOfService in interface Openapiv2.InfoOrBuilder
      Returns:
      The termsOfService.

    • 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_openapiv2.options.Contact contact = 4;
      Specified by:
      hasContact in interface Openapiv2.InfoOrBuilder
      Returns:
      Whether the contact field is set.

    • getContact

      public Openapiv2.Contact getContact()
       The contact information for the exposed API.
      .grpc.gateway.protoc_gen_openapiv2.options.Contact contact = 4;
      Specified by:
      getContact in interface Openapiv2.InfoOrBuilder
      Returns:
      The contact.

    • getContactOrBuilder

      public Openapiv2.ContactOrBuilder getContactOrBuilder()
       The contact information for the exposed API.
      .grpc.gateway.protoc_gen_openapiv2.options.Contact contact = 4;
      Specified by:
      getContactOrBuilder in interface Openapiv2.InfoOrBuilder

    • hasLicense

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

    • getLicense

      public Openapiv2.License getLicense()
       The license information for the exposed API.
      .grpc.gateway.protoc_gen_openapiv2.options.License license = 5;
      Specified by:
      getLicense in interface Openapiv2.InfoOrBuilder
      Returns:
      The license.

    • getLicenseOrBuilder

      public Openapiv2.LicenseOrBuilder getLicenseOrBuilder()
       The license information for the exposed API.
      .grpc.gateway.protoc_gen_openapiv2.options.License license = 5;
      Specified by:
      getLicenseOrBuilder in interface Openapiv2.InfoOrBuilder

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

    • getExtensionsCount

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

    • 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 = 7;
      Specified by:
      containsExtensions in interface Openapiv2.InfoOrBuilder

    • getExtensions

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

    • 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 = 7;
      Specified by:
      getExtensionsMap in interface Openapiv2.InfoOrBuilder

    • 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 = 7;
      Specified by:
      getExtensionsOrDefault in interface Openapiv2.InfoOrBuilder

    • 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 = 7;
      Specified by:
      getExtensionsOrThrow 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.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static Openapiv2.Info parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Openapiv2.Info parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • 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

    • newBuilder

      public static Openapiv2.Info.Builder newBuilder()

    • newBuilder

      public static Openapiv2.Info.Builder newBuilder(Openapiv2.Info prototype)

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • 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.GeneratedMessage

    • getDefaultInstanceForType

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