Class Schema.Builder (0.27.0)

public static final class Schema.Builder extends GeneratedMessageV3.Builder<Schema.Builder> implements SchemaOrBuilder

Defines the structure and layout of a type of document data.

Protobuf type google.cloud.discoveryengine.v1beta.Schema

Implements

SchemaOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Schema.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Schema.Builder
Overrides

build()

public Schema build()
Returns
TypeDescription
Schema

buildPartial()

public Schema buildPartial()
Returns
TypeDescription
Schema

clear()

public Schema.Builder clear()
Returns
TypeDescription
Schema.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public Schema.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Schema.Builder
Overrides

clearJsonSchema()

public Schema.Builder clearJsonSchema()

The JSON representation of the schema.

string json_schema = 3;

Returns
TypeDescription
Schema.Builder

This builder for chaining.

clearName()

public Schema.Builder clearName()

Immutable. The full resource name of the schema, in the format of projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}.

This field must be a UTF-8 encoded string with a length limit of 1024 characters.

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
Schema.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Schema.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Schema.Builder
Overrides

clearSchema()

public Schema.Builder clearSchema()
Returns
TypeDescription
Schema.Builder

clearStructSchema()

public Schema.Builder clearStructSchema()

The structured representation of the schema.

.google.protobuf.Struct struct_schema = 2;

Returns
TypeDescription
Schema.Builder

clone()

public Schema.Builder clone()
Returns
TypeDescription
Schema.Builder
Overrides

getDefaultInstanceForType()

public Schema getDefaultInstanceForType()
Returns
TypeDescription
Schema

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getJsonSchema()

public String getJsonSchema()

The JSON representation of the schema.

string json_schema = 3;

Returns
TypeDescription
String

The jsonSchema.

getJsonSchemaBytes()

public ByteString getJsonSchemaBytes()

The JSON representation of the schema.

string json_schema = 3;

Returns
TypeDescription
ByteString

The bytes for jsonSchema.

getName()

public String getName()

Immutable. The full resource name of the schema, in the format of projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}.

This field must be a UTF-8 encoded string with a length limit of 1024 characters.

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

Immutable. The full resource name of the schema, in the format of projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}.

This field must be a UTF-8 encoded string with a length limit of 1024 characters.

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
TypeDescription
ByteString

The bytes for name.

getSchemaCase()

public Schema.SchemaCase getSchemaCase()
Returns
TypeDescription
Schema.SchemaCase

getStructSchema()

public Struct getStructSchema()

The structured representation of the schema.

.google.protobuf.Struct struct_schema = 2;

Returns
TypeDescription
Struct

The structSchema.

getStructSchemaBuilder()

public Struct.Builder getStructSchemaBuilder()

The structured representation of the schema.

.google.protobuf.Struct struct_schema = 2;

Returns
TypeDescription
Builder

getStructSchemaOrBuilder()

public StructOrBuilder getStructSchemaOrBuilder()

The structured representation of the schema.

.google.protobuf.Struct struct_schema = 2;

Returns
TypeDescription
StructOrBuilder

hasJsonSchema()

public boolean hasJsonSchema()

The JSON representation of the schema.

string json_schema = 3;

Returns
TypeDescription
boolean

Whether the jsonSchema field is set.

hasStructSchema()

public boolean hasStructSchema()

The structured representation of the schema.

.google.protobuf.Struct struct_schema = 2;

Returns
TypeDescription
boolean

Whether the structSchema field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(Schema other)

public Schema.Builder mergeFrom(Schema other)
Parameter
NameDescription
otherSchema
Returns
TypeDescription
Schema.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Schema.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Schema.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Schema.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Schema.Builder
Overrides

mergeStructSchema(Struct value)

public Schema.Builder mergeStructSchema(Struct value)

The structured representation of the schema.

.google.protobuf.Struct struct_schema = 2;

Parameter
NameDescription
valueStruct
Returns
TypeDescription
Schema.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Schema.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Schema.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public Schema.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Schema.Builder
Overrides

setJsonSchema(String value)

public Schema.Builder setJsonSchema(String value)

The JSON representation of the schema.

string json_schema = 3;

Parameter
NameDescription
valueString

The jsonSchema to set.

Returns
TypeDescription
Schema.Builder

This builder for chaining.

setJsonSchemaBytes(ByteString value)

public Schema.Builder setJsonSchemaBytes(ByteString value)

The JSON representation of the schema.

string json_schema = 3;

Parameter
NameDescription
valueByteString

The bytes for jsonSchema to set.

Returns
TypeDescription
Schema.Builder

This builder for chaining.

setName(String value)

public Schema.Builder setName(String value)

Immutable. The full resource name of the schema, in the format of projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}.

This field must be a UTF-8 encoded string with a length limit of 1024 characters.

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
Schema.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Schema.Builder setNameBytes(ByteString value)

Immutable. The full resource name of the schema, in the format of projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}.

This field must be a UTF-8 encoded string with a length limit of 1024 characters.

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
Schema.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Schema.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Schema.Builder
Overrides

setStructSchema(Struct value)

public Schema.Builder setStructSchema(Struct value)

The structured representation of the schema.

.google.protobuf.Struct struct_schema = 2;

Parameter
NameDescription
valueStruct
Returns
TypeDescription
Schema.Builder

setStructSchema(Struct.Builder builderForValue)

public Schema.Builder setStructSchema(Struct.Builder builderForValue)

The structured representation of the schema.

.google.protobuf.Struct struct_schema = 2;

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
Schema.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Schema.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Schema.Builder
Overrides