com.grpc.gateway.protoc_gen_openapiv2.options

Class Schema.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessage.Builder<Schema.Builder>

com.grpc.gateway.protoc_gen_openapiv2.options.Schema.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, SchemaOrBuilder, java.lang.Cloneable

Enclosing class:

Schema

public static final class Schema.Builder
extends com.google.protobuf.GeneratedMessage.Builder<Schema.Builder>
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

Method Summary

Modifier and Type	Method and Description
Schema	build()
Schema	buildPartial()
Schema.Builder	clear()
Schema.Builder	clearDiscriminator() Adds support for polymorphism.
Schema.Builder	clearExample() A free-form property to include an example of an instance for this schema in JSON.
Schema.Builder	clearExternalDocs() Additional external documentation for this schema.
Schema.Builder	clearJsonSchema() .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema json_schema = 1 [json_name = "jsonSchema"];
Schema.Builder	clearReadOnly() Relevant only for Schema "properties" definitions.
Schema	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
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.
ExternalDocumentation.Builder	getExternalDocsBuilder() 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"];
JSONSchema.Builder	getJsonSchemaBuilder() .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"];
boolean	getReadOnly() Relevant only for Schema "properties" definitions.
boolean	hasExternalDocs() Additional external documentation for this schema.
boolean	hasJsonSchema() .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema json_schema = 1 [json_name = "jsonSchema"];
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
Schema.Builder	mergeExternalDocs(ExternalDocumentation value) Additional external documentation for this schema.
Schema.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Schema.Builder	mergeFrom(com.google.protobuf.Message other)
Schema.Builder	mergeFrom(Schema other)
Schema.Builder	mergeJsonSchema(JSONSchema value) .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema json_schema = 1 [json_name = "jsonSchema"];
Schema.Builder	setDiscriminator(java.lang.String value) Adds support for polymorphism.
Schema.Builder	setDiscriminatorBytes(com.google.protobuf.ByteString value) Adds support for polymorphism.
Schema.Builder	setExample(java.lang.String value) A free-form property to include an example of an instance for this schema in JSON.
Schema.Builder	setExampleBytes(com.google.protobuf.ByteString value) A free-form property to include an example of an instance for this schema in JSON.
Schema.Builder	setExternalDocs(ExternalDocumentation.Builder builderForValue) Additional external documentation for this schema.
Schema.Builder	setExternalDocs(ExternalDocumentation value) Additional external documentation for this schema.
Schema.Builder	setJsonSchema(JSONSchema.Builder builderForValue) .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema json_schema = 1 [json_name = "jsonSchema"];
Schema.Builder	setJsonSchema(JSONSchema value) .grpc.gateway.protoc_gen_openapiv2.options.JSONSchema json_schema = 1 [json_name = "jsonSchema"];
Schema.Builder	setReadOnly(boolean value) Relevant only for Schema "properties" definitions.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

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.Builder<Schema.Builder>

clear

public Schema.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessage.Builder<Schema.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Schema.Builder>

getDefaultInstanceForType

public Schema getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Schema build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public Schema buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom

public Schema.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Schema.Builder>

mergeFrom

public Schema.Builder mergeFrom(Schema other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Schema.Builder>

mergeFrom

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

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Schema.Builder>

Throws:

java.io.IOException

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.

setJsonSchema

public Schema.Builder setJsonSchema(JSONSchema value)

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

setJsonSchema

public Schema.Builder setJsonSchema(JSONSchema.Builder builderForValue)

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

mergeJsonSchema

public Schema.Builder mergeJsonSchema(JSONSchema value)

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

clearJsonSchema

public Schema.Builder clearJsonSchema()

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

getJsonSchemaBuilder

public JSONSchema.Builder getJsonSchemaBuilder()

.grpc.gateway.protoc_gen_openapiv2.options.JSONSchema json_schema = 1 [json_name = "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.

setDiscriminator

public Schema.Builder setDiscriminator(java.lang.String value)

 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"];

Parameters:

value - The discriminator to set.

Returns:

This builder for chaining.

clearDiscriminator

public Schema.Builder clearDiscriminator()

 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"];

Returns:

This builder for chaining.

setDiscriminatorBytes

public Schema.Builder setDiscriminatorBytes(com.google.protobuf.ByteString value)

 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"];

Parameters:

value - The bytes for discriminator to set.

Returns:

This builder for chaining.

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.

setReadOnly

public Schema.Builder setReadOnly(boolean value)

 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"];

Parameters:

value - The readOnly to set.

Returns:

This builder for chaining.

clearReadOnly

public Schema.Builder clearReadOnly()

 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"];

Returns:

This builder for chaining.

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.

setExternalDocs

public Schema.Builder setExternalDocs(ExternalDocumentation value)

 Additional external documentation for this schema.
 

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

setExternalDocs

public Schema.Builder setExternalDocs(ExternalDocumentation.Builder builderForValue)

 Additional external documentation for this schema.
 

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

mergeExternalDocs

public Schema.Builder mergeExternalDocs(ExternalDocumentation value)

 Additional external documentation for this schema.
 

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

clearExternalDocs

public Schema.Builder clearExternalDocs()

 Additional external documentation for this schema.
 

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

getExternalDocsBuilder

public ExternalDocumentation.Builder getExternalDocsBuilder()

 Additional external documentation for this schema.
 

.grpc.gateway.protoc_gen_openapiv2.options.ExternalDocumentation external_docs = 5 [json_name = "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.

setExample

public Schema.Builder setExample(java.lang.String value)

 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"];

Parameters:

value - The example to set.

Returns:

This builder for chaining.

clearExample

public Schema.Builder clearExample()

 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"];

Returns:

This builder for chaining.

setExampleBytes

public Schema.Builder setExampleBytes(com.google.protobuf.ByteString value)

 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"];

Parameters:

value - The bytes for example to set.

Returns:

This builder for chaining.