Openapiv2.Schema.Builder (pinecone-java-client 0.2.1 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Schema.Builder>
    - - grpc.gateway.protoc_gen_openapiv2.options.Openapiv2.Schema.Builder

All Implemented Interfaces:: com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Openapiv2.SchemaOrBuilder, java.lang.Cloneable

Enclosing class:: Openapiv2.Schema

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Openapiv2.Schema.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)`
`Openapiv2.Schema`	`build()`
`Openapiv2.Schema`	`buildPartial()`
`Openapiv2.Schema.Builder`	`clear()`
`Openapiv2.Schema.Builder`	`clearDiscriminator()` Adds support for polymorphism.
`Openapiv2.Schema.Builder`	`clearExample()` A free-form property to include an example of an instance for this schema in JSON.
`Openapiv2.Schema.Builder`	`clearExternalDocs()` Additional external documentation for this schema.
`Openapiv2.Schema.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`Openapiv2.Schema.Builder`	`clearJsonSchema()` `.grpc.gateway.protoc_gen_openapiv2.options.JSONSchema json_schema = 1;`
`Openapiv2.Schema.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`Openapiv2.Schema.Builder`	`clearReadOnly()` Relevant only for Schema "properties" definitions.
`Openapiv2.Schema.Builder`	`clone()`
`Openapiv2.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.
`Openapiv2.ExternalDocumentation`	`getExternalDocs()` Additional external documentation for this schema.
`Openapiv2.ExternalDocumentation.Builder`	`getExternalDocsBuilder()` 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.JSONSchema.Builder`	`getJsonSchemaBuilder()` `.grpc.gateway.protoc_gen_openapiv2.options.JSONSchema json_schema = 1;`
`Openapiv2.JSONSchemaOrBuilder`	`getJsonSchemaOrBuilder()` `.grpc.gateway.protoc_gen_openapiv2.options.JSONSchema json_schema = 1;`
`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;`
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`Openapiv2.Schema.Builder`	`mergeExternalDocs(Openapiv2.ExternalDocumentation value)` Additional external documentation for this schema.
`Openapiv2.Schema.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`Openapiv2.Schema.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`Openapiv2.Schema.Builder`	`mergeFrom(Openapiv2.Schema other)`
`Openapiv2.Schema.Builder`	`mergeJsonSchema(Openapiv2.JSONSchema value)` `.grpc.gateway.protoc_gen_openapiv2.options.JSONSchema json_schema = 1;`
`Openapiv2.Schema.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`Openapiv2.Schema.Builder`	`setDiscriminator(java.lang.String value)` Adds support for polymorphism.
`Openapiv2.Schema.Builder`	`setDiscriminatorBytes(com.google.protobuf.ByteString value)` Adds support for polymorphism.
`Openapiv2.Schema.Builder`	`setExample(java.lang.String value)` A free-form property to include an example of an instance for this schema in JSON.
`Openapiv2.Schema.Builder`	`setExampleBytes(com.google.protobuf.ByteString value)` A free-form property to include an example of an instance for this schema in JSON.
`Openapiv2.Schema.Builder`	`setExternalDocs(Openapiv2.ExternalDocumentation.Builder builderForValue)` Additional external documentation for this schema.
`Openapiv2.Schema.Builder`	`setExternalDocs(Openapiv2.ExternalDocumentation value)` Additional external documentation for this schema.
`Openapiv2.Schema.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, java.lang.Object value)`
`Openapiv2.Schema.Builder`	`setJsonSchema(Openapiv2.JSONSchema.Builder builderForValue)` `.grpc.gateway.protoc_gen_openapiv2.options.JSONSchema json_schema = 1;`
`Openapiv2.Schema.Builder`	`setJsonSchema(Openapiv2.JSONSchema value)` `.grpc.gateway.protoc_gen_openapiv2.options.JSONSchema json_schema = 1;`
`Openapiv2.Schema.Builder`	`setReadOnly(boolean value)` Relevant only for Schema "properties" definitions.
`Openapiv2.Schema.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, java.lang.Object value)`
`Openapiv2.Schema.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, 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.MessageLite.Builder
mergeFrom

Method Detail

getDescriptor

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

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

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Schema.Builder>

clear
```
public Openapiv2.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.GeneratedMessageV3.Builder<Openapiv2.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.GeneratedMessageV3.Builder<Openapiv2.Schema.Builder>

getDefaultInstanceForType
```
public Openapiv2.Schema getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build
```
public Openapiv2.Schema build()
```
Specified by:

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

Specified by:

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

buildPartial
```
public Openapiv2.Schema buildPartial()
```
Specified by:

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

Specified by:

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

clone
```
public Openapiv2.Schema.Builder clone()
```
Specified by:

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

Specified by:

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

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Schema.Builder>

setField
```
public Openapiv2.Schema.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                         java.lang.Object value)
```
Specified by:

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

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Schema.Builder>

clearField
```
public Openapiv2.Schema.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
Specified by:

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

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Schema.Builder>

clearOneof
```
public Openapiv2.Schema.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
Specified by:

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

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Schema.Builder>

setRepeatedField

public Openapiv2.Schema.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                 int index,
                                                 java.lang.Object value)

Specified by:: setRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Schema.Builder>

addRepeatedField
```
public Openapiv2.Schema.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                 java.lang.Object value)
```
Specified by:

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

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Schema.Builder>

mergeFrom
```
public Openapiv2.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<Openapiv2.Schema.Builder>

mergeFrom

public Openapiv2.Schema.Builder mergeFrom(Openapiv2.Schema other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Openapiv2.Schema.Builder>

mergeFrom
```
public Openapiv2.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<Openapiv2.Schema.Builder>

Throws:

java.io.IOException

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.

setJsonSchema
```
public Openapiv2.Schema.Builder setJsonSchema(Openapiv2.JSONSchema value)
```
.grpc.gateway.protoc_gen_openapiv2.options.JSONSchema json_schema = 1;

setJsonSchema

public Openapiv2.Schema.Builder setJsonSchema(Openapiv2.JSONSchema.Builder builderForValue)

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

mergeJsonSchema
```
public Openapiv2.Schema.Builder mergeJsonSchema(Openapiv2.JSONSchema value)
```
.grpc.gateway.protoc_gen_openapiv2.options.JSONSchema json_schema = 1;

clearJsonSchema
```
public Openapiv2.Schema.Builder clearJsonSchema()
```
.grpc.gateway.protoc_gen_openapiv2.options.JSONSchema json_schema = 1;

getJsonSchemaBuilder
```
public Openapiv2.JSONSchema.Builder getJsonSchemaBuilder()
```
.grpc.gateway.protoc_gen_openapiv2.options.JSONSchema json_schema = 1;

getJsonSchemaOrBuilder
```
public Openapiv2.JSONSchemaOrBuilder getJsonSchemaOrBuilder()
```
.grpc.gateway.protoc_gen_openapiv2.options.JSONSchema json_schema = 1;

Specified by:

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

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.

setDiscriminator

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

Parameters:: value - The discriminator to set.
Returns:: This builder for chaining.

clearDiscriminator

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

Returns:: This builder for chaining.

setDiscriminatorBytes

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

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;

Specified by:: getReadOnly in interface Openapiv2.SchemaOrBuilder
Returns:: The readOnly.

setReadOnly

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

Parameters:: value - The readOnly to set.
Returns:: This builder for chaining.

clearReadOnly

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

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