java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - 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, java.io.Serializable

Enclosing class:: Openapiv2

public static final class Openapiv2.EnumSchema
extends com.google.protobuf.GeneratedMessageV3
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:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static 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.GeneratedMessageV3
  com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
- Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
  com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`DEFAULT_FIELD_NUMBER`
`static int`	`DESCRIPTION_FIELD_NUMBER`
`static int`	`EXAMPLE_FIELD_NUMBER`
`static int`	`EXTENSIONS_FIELD_NUMBER`
`static int`	`EXTERNAL_DOCS_FIELD_NUMBER`
`static int`	`READ_ONLY_FIELD_NUMBER`
`static int`	`REF_FIELD_NUMBER`
`static int`	`REQUIRED_FIELD_NUMBER`
`static int`	`TITLE_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete 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.
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getDefault()`	`string default = 2;`
`com.google.protobuf.ByteString`	`getDefaultBytes()`	`string default = 2;`
`static Openapiv2.EnumSchema`	`getDefaultInstance()`
`Openapiv2.EnumSchema`	`getDefaultInstanceForType()`
`java.lang.String`	`getDescription()`	A short description of the schema.
`com.google.protobuf.ByteString`	`getDescriptionBytes()`	A short description of the schema.
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`java.lang.String`	`getExample()`	`string example = 7;`
`com.google.protobuf.ByteString`	`getExampleBytes()`	`string example = 7;`
`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 schema.
`Openapiv2.ExternalDocumentationOrBuilder`	`getExternalDocsOrBuilder()`	Additional external documentation for this schema.
`com.google.protobuf.Parser<Openapiv2.EnumSchema>`	`getParserForType()`
`boolean`	`getReadOnly()`	`bool read_only = 5;`
`java.lang.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()`
`java.lang.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.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapFieldReflectionAccessor`	`internalGetMapFieldReflection(int number)`
`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.GeneratedMessageV3.BuilderParent parent)`
`protected java.lang.Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static Openapiv2.EnumSchema`	`parseDelimitedFrom(java.io.InputStream input)`
`static Openapiv2.EnumSchema`	`parseDelimitedFrom(java.io.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(java.io.InputStream input)`
`static Openapiv2.EnumSchema`	`parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Openapiv2.EnumSchema`	`parseFrom(java.nio.ByteBuffer data)`
`static Openapiv2.EnumSchema`	`parseFrom(java.nio.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.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, 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 Detail
- DESCRIPTION_FIELD_NUMBER
```
public static final int DESCRIPTION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DEFAULT_FIELD_NUMBER
```
public static final int DEFAULT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- TITLE_FIELD_NUMBER
```
public static final int TITLE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- REQUIRED_FIELD_NUMBER
```
public static final int REQUIRED_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- READ_ONLY_FIELD_NUMBER
```
public static final int READ_ONLY_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- EXTERNAL_DOCS_FIELD_NUMBER
```
public static final int EXTERNAL_DOCS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- EXAMPLE_FIELD_NUMBER
```
public static final int EXAMPLE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- REF_FIELD_NUMBER
```
public static final int REF_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- EXTENSIONS_FIELD_NUMBER
```
public static final int EXTENSIONS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected java.lang.Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

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

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

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getDescription
```
public java.lang.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 java.lang.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 java.lang.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 java.lang.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 java.lang.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.