Package grpc.gateway.protoc_gen_openapiv2.options

Class Openapiv2.EnumSchema

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.EnumSchema
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Openapiv2.EnumSchemaOrBuilder, Serializable
Enclosing class:
Openapiv2
public static final class Openapiv2.EnumSchema extends com.google.protobuf.GeneratedMessage implements Openapiv2.EnumSchemaOrBuilder
 `EnumSchema` is subset of fields from the OpenAPI v2 specification's Schema object.
 Only fields that are applicable to Enums are included
 See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#schemaObject

 Example:

 option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_enum) = {
 ...
 title: "MyEnum";
 description:"This is my nice enum";
 example: "ZERO";
 required: true;
 ...
 };
Protobuf type grpc.gateway.protoc_gen_openapiv2.options.EnumSchema
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Openapiv2.EnumSchema.Builder
    `EnumSchema` is subset of fields from the OpenAPI v2 specification's Schema 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
    DEFAULT_FIELD_NUMBER
     
    static final int
    DESCRIPTION_FIELD_NUMBER
     
    static final int
    EXAMPLE_FIELD_NUMBER
     
    static final int
    EXTENSIONS_FIELD_NUMBER
     
    static final int
    EXTERNAL_DOCS_FIELD_NUMBER
     
    static final int
    READ_ONLY_FIELD_NUMBER
     
    static final int
    REF_FIELD_NUMBER
     
    static final int
    REQUIRED_FIELD_NUMBER
     
    static final int
    TITLE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, 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)
     
    String
    getDefault()
    string default = 2;
    com.google.protobuf.ByteString
    getDefaultBytes()
    string default = 2;
    static Openapiv2.EnumSchema
    getDefaultInstance()
     
    Openapiv2.EnumSchema
    getDefaultInstanceForType()
     
    String
    getDescription()
    A short description of the schema.
    com.google.protobuf.ByteString
    getDescriptionBytes()
    A short description of the schema.
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getExample()
    string example = 7;
    com.google.protobuf.ByteString
    getExampleBytes()
    string example = 7;
    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.ExternalDocumentation
    getExternalDocs()
    Additional external documentation for this schema.
    Openapiv2.ExternalDocumentationOrBuilder
    getExternalDocsOrBuilder()
    Additional external documentation for this schema.
    com.google.protobuf.Parser<Openapiv2.EnumSchema>
    getParserForType()
     
    boolean
    getReadOnly()
    bool read_only = 5;
    String
    getRef()
    Ref is used to define an external reference to include in the message.
    com.google.protobuf.ByteString
    getRefBytes()
    Ref is used to define an external reference to include in the message.
    boolean
    getRequired()
    bool required = 4;
    int
    getSerializedSize()
     
    String
    getTitle()
    The title of the schema.
    com.google.protobuf.ByteString
    getTitleBytes()
    The title of the schema.
    boolean
    hasExternalDocs()
    Additional external documentation for this schema.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    protected com.google.protobuf.MapFieldReflectionAccessor
    internalGetMapFieldReflection(int number)
     
    final boolean
    isInitialized()
     
    static Openapiv2.EnumSchema.Builder
    newBuilder()
     
    static Openapiv2.EnumSchema.Builder
    newBuilder(Openapiv2.EnumSchema prototype)
     
    Openapiv2.EnumSchema.Builder
    newBuilderForType()
     
    protected Openapiv2.EnumSchema.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Openapiv2.EnumSchema
    parseDelimitedFrom(InputStream input)
     
    static Openapiv2.EnumSchema
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Openapiv2.EnumSchema
    parseFrom(byte[] data)
     
    static Openapiv2.EnumSchema
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Openapiv2.EnumSchema
    parseFrom(com.google.protobuf.ByteString data)
     
    static Openapiv2.EnumSchema
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Openapiv2.EnumSchema
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Openapiv2.EnumSchema
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Openapiv2.EnumSchema
    parseFrom(InputStream input)
     
    static Openapiv2.EnumSchema
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Openapiv2.EnumSchema
    parseFrom(ByteBuffer data)
     
    static Openapiv2.EnumSchema
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Openapiv2.EnumSchema>
    parser()
     
    Openapiv2.EnumSchema.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, 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

    • getDescription

      public String getDescription()
       A short description of the schema.
      string description = 1;
      Specified by:
      getDescription in interface Openapiv2.EnumSchemaOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
       A short description of the schema.
      string description = 1;
      Specified by:
      getDescriptionBytes in interface Openapiv2.EnumSchemaOrBuilder
      Returns:
      The bytes for description.

    • getDefault

      public String getDefault()
      string default = 2;
      Specified by:
      getDefault in interface Openapiv2.EnumSchemaOrBuilder
      Returns:
      The default.

    • getDefaultBytes

      public com.google.protobuf.ByteString getDefaultBytes()
      string default = 2;
      Specified by:
      getDefaultBytes in interface Openapiv2.EnumSchemaOrBuilder
      Returns:
      The bytes for default.

    • getTitle

      public String getTitle()
       The title of the schema.
      string title = 3;
      Specified by:
      getTitle in interface Openapiv2.EnumSchemaOrBuilder
      Returns:
      The title.

    • getTitleBytes

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

    • getRequired

      public boolean getRequired()
      bool required = 4;
      Specified by:
      getRequired in interface Openapiv2.EnumSchemaOrBuilder
      Returns:
      The required.

    • getReadOnly

      public boolean getReadOnly()
      bool read_only = 5;
      Specified by:
      getReadOnly in interface Openapiv2.EnumSchemaOrBuilder
      Returns:
      The readOnly.

    • hasExternalDocs

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

    • getExternalDocs

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

    • getExternalDocsOrBuilder

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

    • getExample

      public String getExample()
      string example = 7;
      Specified by:
      getExample in interface Openapiv2.EnumSchemaOrBuilder
      Returns:
      The example.

    • getExampleBytes

      public com.google.protobuf.ByteString getExampleBytes()
      string example = 7;
      Specified by:
      getExampleBytes in interface Openapiv2.EnumSchemaOrBuilder
      Returns:
      The bytes for example.

    • getRef

      public String getRef()
       Ref is used to define an external reference to include in the message.
 This could be a fully qualified proto message reference, and that type must
 be imported into the protofile. If no message is identified, the Ref will
 be used verbatim in the output.
 For example:
 `ref: ".google.protobuf.Timestamp"`.
      string ref = 8;
      Specified by:
      getRef in interface Openapiv2.EnumSchemaOrBuilder
      Returns:
      The ref.

    • getRefBytes

      public com.google.protobuf.ByteString getRefBytes()
       Ref is used to define an external reference to include in the message.
 This could be a fully qualified proto message reference, and that type must
 be imported into the protofile. If no message is identified, the Ref will
 be used verbatim in the output.
 For example:
 `ref: ".google.protobuf.Timestamp"`.
      string ref = 8;
      Specified by:
      getRefBytes in interface Openapiv2.EnumSchemaOrBuilder
      Returns:
      The bytes for ref.

    • getExtensionsCount

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

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

    • getExtensions

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

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

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

    • 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 = 9;
      Specified by:
      getExtensionsOrThrow in interface Openapiv2.EnumSchemaOrBuilder

    • 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.EnumSchema parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static Openapiv2.EnumSchema 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.EnumSchema parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static Openapiv2.EnumSchema parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Openapiv2.EnumSchema.Builder newBuilder()

    • newBuilder

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

    • toBuilder

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

    • newBuilderForType

      protected Openapiv2.EnumSchema.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Openapiv2.EnumSchema getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<Openapiv2.EnumSchema> 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.EnumSchema getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder