Package grpc.gateway.protoc_gen_openapiv2.options

Class Openapiv2.Schema

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessage

grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.Schema

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Openapiv2.SchemaOrBuilder, Serializable

Enclosing class:

Openapiv2

public static final class Openapiv2.Schema
extends com.google.protobuf.GeneratedMessage
implements Openapiv2.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	Description
static final class	Openapiv2.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 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	DISCRIMINATOR_FIELD_NUMBER
static final int	EXAMPLE_FIELD_NUMBER
static final int	EXTERNAL_DOCS_FIELD_NUMBER
static final int	JSON_SCHEMA_FIELD_NUMBER
static final 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	Description
boolean	equals(Object obj)
static Openapiv2.Schema	getDefaultInstance()
Openapiv2.Schema	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getDiscriminator()	Adds support for polymorphism.
com.google.protobuf.ByteString	getDiscriminatorBytes()	Adds support for polymorphism.
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.
Openapiv2.ExternalDocumentation	getExternalDocs()	Additional external documentation for this schema.
Openapiv2.ExternalDocumentationOrBuilder	getExternalDocsOrBuilder()	Additional external documentation for this schema.
Openapiv2.JSONSchema	getJsonSchema()	.grpc.gateway.protoc_gen_openapiv2.options.JSONSchema json_schema = 1;
Openapiv2.JSONSchemaOrBuilder	getJsonSchemaOrBuilder()	.grpc.gateway.protoc_gen_openapiv2.options.JSONSchema json_schema = 1;
com.google.protobuf.Parser<Openapiv2.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;
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static Openapiv2.Schema.Builder	newBuilder()
static Openapiv2.Schema.Builder	newBuilder(Openapiv2.Schema prototype)
Openapiv2.Schema.Builder	newBuilderForType()
protected Openapiv2.Schema.Builder	newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
static Openapiv2.Schema	parseDelimitedFrom(InputStream input)
static Openapiv2.Schema	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Openapiv2.Schema	parseFrom(byte[] data)
static Openapiv2.Schema	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Openapiv2.Schema	parseFrom(com.google.protobuf.ByteString data)
static Openapiv2.Schema	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Openapiv2.Schema	parseFrom(com.google.protobuf.CodedInputStream input)
static Openapiv2.Schema	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Openapiv2.Schema	parseFrom(InputStream input)
static Openapiv2.Schema	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Openapiv2.Schema	parseFrom(ByteBuffer data)
static Openapiv2.Schema	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Openapiv2.Schema>	parser()
Openapiv2.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.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

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 Details

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;

Specified by:

hasJsonSchema in interface Openapiv2.SchemaOrBuilder

Returns:

Whether the jsonSchema field is set.

getJsonSchema

public Openapiv2.JSONSchema getJsonSchema()

.grpc.gateway.protoc_gen_openapiv2.options.JSONSchema json_schema = 1;

Specified by:

getJsonSchema in interface Openapiv2.SchemaOrBuilder

Returns:

The jsonSchema.

getJsonSchemaOrBuilder

public Openapiv2.JSONSchemaOrBuilder getJsonSchemaOrBuilder()

.grpc.gateway.protoc_gen_openapiv2.options.JSONSchema json_schema = 1;

Specified by:

getJsonSchemaOrBuilder in interface Openapiv2.SchemaOrBuilder

getDiscriminator

public 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;

Specified by:

getDiscriminator in interface Openapiv2.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;

Specified by:

getDiscriminatorBytes in interface Openapiv2.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;

Specified by:

getReadOnly in interface Openapiv2.SchemaOrBuilder

Returns:

The readOnly.

hasExternalDocs

public boolean hasExternalDocs()

 Additional external documentation for this schema.
 

.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 5;

Specified by:

hasExternalDocs in interface Openapiv2.SchemaOrBuilder

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 = 5;

Specified by:

getExternalDocs in interface Openapiv2.SchemaOrBuilder

Returns:

The externalDocs.

getExternalDocsOrBuilder

public Openapiv2.ExternalDocumentationOrBuilder getExternalDocsOrBuilder()

 Additional external documentation for this schema.
 

.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 5;

Specified by:

getExternalDocsOrBuilder in interface Openapiv2.SchemaOrBuilder

getExample

public 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;

Specified by:

getExample in interface Openapiv2.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;

Specified by:

getExampleBytes in interface Openapiv2.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 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.Schema parseFrom(ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Openapiv2.Schema parseFrom(InputStream input)
                                  throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static Openapiv2.Schema parseDelimitedFrom(InputStream input)
                                           throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public Openapiv2.Schema.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Openapiv2.Schema.Builder newBuilder()

newBuilder

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

toBuilder

public Openapiv2.Schema.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Overrides:

newBuilderForType in class com.google.protobuf.AbstractMessage

getDefaultInstance

public static Openapiv2.Schema getDefaultInstance()

parser

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

getParserForType

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

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder