com.grpc.gateway.protoc_gen_openapiv2.options

Class Schema

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

com.grpc.gateway.protoc_gen_openapiv2.options.Schema

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, SchemaOrBuilder, java.io.Serializable

public final class Schema
extends com.google.protobuf.GeneratedMessage
implements SchemaOrBuilder

 `Schema` is a representation of OpenAPI v2 specification's Schema object.

 See: https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#schemaObject
 

Protobuf type grpc.gateway.protoc_gen_openapiv2.options.Schema

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Schema.Builder `Schema` is a representation of 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>, 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 and Description
static int	DISCRIMINATOR_FIELD_NUMBER
static int	EXAMPLE_FIELD_NUMBER
static int	EXTERNAL_DOCS_FIELD_NUMBER
static int	JSON_SCHEMA_FIELD_NUMBER
static int	READ_ONLY_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 and Description
boolean	equals(java.lang.Object obj)
static Schema	getDefaultInstance()
Schema	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
java.lang.String	getDiscriminator() Adds support for polymorphism.
com.google.protobuf.ByteString	getDiscriminatorBytes() Adds support for polymorphism.
java.lang.String	getExample() A free-form property to include an example of an instance for this schema in JSON.
com.google.protobuf.ByteString	getExampleBytes() A free-form property to include an example of an instance for this schema in JSON.
ExternalDocumentation	getExternalDocs() Additional external documentation for this schema.
ExternalDocumentationOrBuilder	getExternalDocsOrBuilder() Additional external documentation for this schema.
JSONSchema	getJsonSchema() .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema json_schema = 1 [json_name = "jsonSchema"];
JSONSchemaOrBuilder	getJsonSchemaOrBuilder() .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema json_schema = 1 [json_name = "jsonSchema"];
com.google.protobuf.Parser<Schema>	getParserForType()
boolean	getReadOnly() Relevant only for Schema "properties" definitions.
int	getSerializedSize()
boolean	hasExternalDocs() Additional external documentation for this schema.
int	hashCode()
boolean	hasJsonSchema() .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema json_schema = 1 [json_name = "jsonSchema"];
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Schema.Builder	newBuilder()
static Schema.Builder	newBuilder(Schema prototype)
Schema.Builder	newBuilderForType()
protected Schema.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static Schema	parseDelimitedFrom(java.io.InputStream input)
static Schema	parseDelimitedFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Schema	parseFrom(byte[] data)
static Schema	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Schema	parseFrom(java.nio.ByteBuffer data)
static Schema	parseFrom(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Schema	parseFrom(com.google.protobuf.ByteString data)
static Schema	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Schema	parseFrom(com.google.protobuf.CodedInputStream input)
static Schema	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Schema	parseFrom(java.io.InputStream input)
static Schema	parseFrom(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Schema>	parser()
Schema.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, internalGetMapFieldReflection, 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.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

JSON_SCHEMA_FIELD_NUMBER

public static final int JSON_SCHEMA_FIELD_NUMBER

See Also:

Constant Field Values

DISCRIMINATOR_FIELD_NUMBER

public static final int DISCRIMINATOR_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

Method Detail

getDescriptor

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

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

hasJsonSchema

public boolean hasJsonSchema()

.grpc.gateway.protoc_gen_openapiv2.options.JSONSchema json_schema = 1 [json_name = "jsonSchema"];

Specified by:

hasJsonSchema in interface SchemaOrBuilder

Returns:

Whether the jsonSchema field is set.

getJsonSchema

public JSONSchema getJsonSchema()

.grpc.gateway.protoc_gen_openapiv2.options.JSONSchema json_schema = 1 [json_name = "jsonSchema"];

Specified by:

getJsonSchema in interface SchemaOrBuilder

Returns:

The jsonSchema.

getJsonSchemaOrBuilder

public JSONSchemaOrBuilder getJsonSchemaOrBuilder()

.grpc.gateway.protoc_gen_openapiv2.options.JSONSchema json_schema = 1 [json_name = "jsonSchema"];

Specified by:

getJsonSchemaOrBuilder in interface SchemaOrBuilder

getDiscriminator

public java.lang.String getDiscriminator()

 Adds support for polymorphism. The discriminator is the schema property
 name that is used to differentiate between other schema that inherit this
 schema. The property name used MUST be defined at this schema and it MUST
 be in the required property list. When used, the value MUST be the name of
 this schema or any schema that inherits it.
 

string discriminator = 2 [json_name = "discriminator"];

Specified by:

getDiscriminator in interface SchemaOrBuilder

Returns:

The discriminator.

getDiscriminatorBytes

public com.google.protobuf.ByteString getDiscriminatorBytes()

 Adds support for polymorphism. The discriminator is the schema property
 name that is used to differentiate between other schema that inherit this
 schema. The property name used MUST be defined at this schema and it MUST
 be in the required property list. When used, the value MUST be the name of
 this schema or any schema that inherits it.
 

string discriminator = 2 [json_name = "discriminator"];

Specified by:

getDiscriminatorBytes in interface SchemaOrBuilder

Returns:

The bytes for discriminator.

getReadOnly

public boolean getReadOnly()

 Relevant only for Schema "properties" definitions. Declares the property as
 "read only". This means that it MAY be sent as part of a response but MUST
 NOT be sent as part of the request. Properties marked as readOnly being
 true SHOULD NOT be in the required list of the defined schema. Default
 value is false.
 

bool read_only = 3 [json_name = "readOnly"];

Specified by:

getReadOnly in interface SchemaOrBuilder

Returns:

The readOnly.

hasExternalDocs

public boolean hasExternalDocs()

 Additional external documentation for this schema.
 

.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 5 [json_name = "externalDocs"];

Specified by:

hasExternalDocs in interface SchemaOrBuilder

Returns:

Whether the externalDocs field is set.

getExternalDocs

public ExternalDocumentation getExternalDocs()

 Additional external documentation for this schema.
 

.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 5 [json_name = "externalDocs"];

Specified by:

getExternalDocs in interface SchemaOrBuilder

Returns:

The externalDocs.

getExternalDocsOrBuilder

public ExternalDocumentationOrBuilder getExternalDocsOrBuilder()

 Additional external documentation for this schema.
 

.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 5 [json_name = "externalDocs"];

Specified by:

getExternalDocsOrBuilder in interface SchemaOrBuilder

getExample

public java.lang.String getExample()

 A free-form property to include an example of an instance for this schema in JSON.
 This is copied verbatim to the output.
 

string example = 6 [json_name = "example"];

Specified by:

getExample in interface SchemaOrBuilder

Returns:

The example.

getExampleBytes

public com.google.protobuf.ByteString getExampleBytes()

 A free-form property to include an example of an instance for this schema in JSON.
 This is copied verbatim to the output.
 

string example = 6 [json_name = "example"];

Specified by:

getExampleBytes in interface SchemaOrBuilder

Returns:

The bytes for example.

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 java.io.IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessage

Throws:

java.io.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(java.lang.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 Schema parseFrom(java.nio.ByteBuffer data)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Schema parseFrom(java.nio.ByteBuffer data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Schema parseFrom(com.google.protobuf.ByteString data)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Schema parseFrom(com.google.protobuf.ByteString data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Schema parseFrom(byte[] data)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Schema parseFrom(byte[] data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Schema parseFrom(java.io.InputStream input)
                        throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Schema parseFrom(java.io.InputStream input,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static Schema parseDelimitedFrom(java.io.InputStream input)
                                 throws java.io.IOException

Throws:

java.io.IOException

parseDelimitedFrom

public static Schema parseDelimitedFrom(java.io.InputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Schema parseFrom(com.google.protobuf.CodedInputStream input)
                        throws java.io.IOException

Throws:

java.io.IOException

parseFrom

public static Schema parseFrom(com.google.protobuf.CodedInputStream input,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws java.io.IOException

Throws:

java.io.IOException

newBuilderForType

public Schema.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Schema.Builder newBuilder()

newBuilder

public static Schema.Builder newBuilder(Schema prototype)

toBuilder

public Schema.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Schema.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static Schema getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<Schema> 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 Schema getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder