Class Schema.Builder (0.47.0)

Version 0.47.0

• 0.49.0 (latest)
• 0.48.0
• 0.47.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.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.v1alpha.Schema

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Schema.Builder

Implements

SchemaOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllFieldConfigs(Iterable<? extends FieldConfig> values)

public Schema.Builder addAllFieldConfigs(Iterable<? extends FieldConfig> values)

Output only. Configurations for fields of the schema.

repeated .google.cloud.discoveryengine.v1alpha.FieldConfig field_configs = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
values	Iterable<? extends com.google.cloud.discoveryengine.v1alpha.FieldConfig>

Returns
Type	Description
Schema.Builder

addFieldConfigs(FieldConfig value)

public Schema.Builder addFieldConfigs(FieldConfig value)

Output only. Configurations for fields of the schema.

repeated .google.cloud.discoveryengine.v1alpha.FieldConfig field_configs = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
value	FieldConfig

Returns
Type	Description
Schema.Builder

addFieldConfigs(FieldConfig.Builder builderForValue)

public Schema.Builder addFieldConfigs(FieldConfig.Builder builderForValue)

Output only. Configurations for fields of the schema.

repeated .google.cloud.discoveryengine.v1alpha.FieldConfig field_configs = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
builderForValue	FieldConfig.Builder

Returns
Type	Description
Schema.Builder

addFieldConfigs(int index, FieldConfig value)

public Schema.Builder addFieldConfigs(int index, FieldConfig value)

Output only. Configurations for fields of the schema.

repeated .google.cloud.discoveryengine.v1alpha.FieldConfig field_configs = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name	Description
index	int
value	FieldConfig

Returns
Type	Description
Schema.Builder

addFieldConfigs(int index, FieldConfig.Builder builderForValue)

public Schema.Builder addFieldConfigs(int index, FieldConfig.Builder builderForValue)

Output only. Configurations for fields of the schema.

repeated .google.cloud.discoveryengine.v1alpha.FieldConfig field_configs = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name	Description
index	int
builderForValue	FieldConfig.Builder

Returns
Type	Description
Schema.Builder

addFieldConfigsBuilder()

public FieldConfig.Builder addFieldConfigsBuilder()

Output only. Configurations for fields of the schema.

repeated .google.cloud.discoveryengine.v1alpha.FieldConfig field_configs = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
FieldConfig.Builder

addFieldConfigsBuilder(int index)

public FieldConfig.Builder addFieldConfigsBuilder(int index)

Output only. Configurations for fields of the schema.

repeated .google.cloud.discoveryengine.v1alpha.FieldConfig field_configs = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
FieldConfig.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Schema.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Schema.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public Schema build()

Returns
Type	Description
Schema

buildPartial()

public Schema buildPartial()

Returns
Type	Description
Schema

clear()

public Schema.Builder clear()

Returns
Type	Description
Schema.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public Schema.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
Schema.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearFieldConfigs()

public Schema.Builder clearFieldConfigs()

Output only. Configurations for fields of the schema.

repeated .google.cloud.discoveryengine.v1alpha.FieldConfig field_configs = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Schema.Builder

clearJsonSchema()

public Schema.Builder clearJsonSchema()

The JSON representation of the schema.

string json_schema = 3;

Returns
Type	Description
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
Type	Description
Schema.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Schema.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
Schema.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearSchema()

public Schema.Builder clearSchema()

Returns
Type	Description
Schema.Builder

clearStructSchema()

public Schema.Builder clearStructSchema()

The structured representation of the schema.

.google.protobuf.Struct struct_schema = 2;

Returns
Type	Description
Schema.Builder

clone()

public Schema.Builder clone()

Returns
Type	Description
Schema.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public Schema getDefaultInstanceForType()

Returns
Type	Description
Schema

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getFieldConfigs(int index)

public FieldConfig getFieldConfigs(int index)

Output only. Configurations for fields of the schema.

repeated .google.cloud.discoveryengine.v1alpha.FieldConfig field_configs = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
FieldConfig

getFieldConfigsBuilder(int index)

public FieldConfig.Builder getFieldConfigsBuilder(int index)

Output only. Configurations for fields of the schema.

repeated .google.cloud.discoveryengine.v1alpha.FieldConfig field_configs = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
FieldConfig.Builder

getFieldConfigsBuilderList()

public List<FieldConfig.Builder> getFieldConfigsBuilderList()

Output only. Configurations for fields of the schema.

repeated .google.cloud.discoveryengine.v1alpha.FieldConfig field_configs = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<Builder>

getFieldConfigsCount()

public int getFieldConfigsCount()

Output only. Configurations for fields of the schema.

repeated .google.cloud.discoveryengine.v1alpha.FieldConfig field_configs = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int

getFieldConfigsList()

public List<FieldConfig> getFieldConfigsList()

Output only. Configurations for fields of the schema.

repeated .google.cloud.discoveryengine.v1alpha.FieldConfig field_configs = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<FieldConfig>

getFieldConfigsOrBuilder(int index)

public FieldConfigOrBuilder getFieldConfigsOrBuilder(int index)

Output only. Configurations for fields of the schema.

repeated .google.cloud.discoveryengine.v1alpha.FieldConfig field_configs = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
FieldConfigOrBuilder

getFieldConfigsOrBuilderList()

public List<? extends FieldConfigOrBuilder> getFieldConfigsOrBuilderList()

Output only. Configurations for fields of the schema.

repeated .google.cloud.discoveryengine.v1alpha.FieldConfig field_configs = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<? extends com.google.cloud.discoveryengine.v1alpha.FieldConfigOrBuilder>

getJsonSchema()

public String getJsonSchema()

The JSON representation of the schema.

string json_schema = 3;

Returns
Type	Description
String	The jsonSchema.

getJsonSchemaBytes()

public ByteString getJsonSchemaBytes()

The JSON representation of the schema.

string json_schema = 3;

Returns
Type	Description
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
Type	Description
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
Type	Description
ByteString	The bytes for name.

getSchemaCase()

public Schema.SchemaCase getSchemaCase()

Returns
Type	Description
Schema.SchemaCase

getStructSchema()

public Struct getStructSchema()

The structured representation of the schema.

.google.protobuf.Struct struct_schema = 2;

Returns
Type	Description
Struct	The structSchema.

getStructSchemaBuilder()

public Struct.Builder getStructSchemaBuilder()

The structured representation of the schema.

.google.protobuf.Struct struct_schema = 2;

Returns
Type	Description
Builder

getStructSchemaOrBuilder()

public StructOrBuilder getStructSchemaOrBuilder()

The structured representation of the schema.

.google.protobuf.Struct struct_schema = 2;

Returns
Type	Description
StructOrBuilder

hasJsonSchema()

public boolean hasJsonSchema()

The JSON representation of the schema.

string json_schema = 3;

Returns
Type	Description
boolean	Whether the jsonSchema field is set.

hasStructSchema()

public boolean hasStructSchema()

The structured representation of the schema.

.google.protobuf.Struct struct_schema = 2;

Returns
Type	Description
boolean	Whether the structSchema field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(Schema other)

public Schema.Builder mergeFrom(Schema other)

Parameter
Name	Description
other	Schema

Returns
Type	Description
Schema.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Schema.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Schema.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public Schema.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
Schema.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeStructSchema(Struct value)

public Schema.Builder mergeStructSchema(Struct value)

The structured representation of the schema.

.google.protobuf.Struct struct_schema = 2;

Parameter
Name	Description
value	Struct

Returns
Type	Description
Schema.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Schema.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Schema.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeFieldConfigs(int index)

public Schema.Builder removeFieldConfigs(int index)

Output only. Configurations for fields of the schema.

repeated .google.cloud.discoveryengine.v1alpha.FieldConfig field_configs = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int

Returns
Type	Description
Schema.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Schema.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Schema.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setFieldConfigs(int index, FieldConfig value)

public Schema.Builder setFieldConfigs(int index, FieldConfig value)

Output only. Configurations for fields of the schema.

repeated .google.cloud.discoveryengine.v1alpha.FieldConfig field_configs = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name	Description
index	int
value	FieldConfig

Returns
Type	Description
Schema.Builder

setFieldConfigs(int index, FieldConfig.Builder builderForValue)

public Schema.Builder setFieldConfigs(int index, FieldConfig.Builder builderForValue)

Output only. Configurations for fields of the schema.

repeated .google.cloud.discoveryengine.v1alpha.FieldConfig field_configs = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name	Description
index	int
builderForValue	FieldConfig.Builder

Returns
Type	Description
Schema.Builder

setJsonSchema(String value)

public Schema.Builder setJsonSchema(String value)

The JSON representation of the schema.

string json_schema = 3;

Parameter
Name	Description
value	String The jsonSchema to set.

Returns
Type	Description
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
Name	Description
value	ByteString The bytes for jsonSchema to set.

Returns
Type	Description
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
Name	Description
value	String The name to set.

Returns
Type	Description
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
Name	Description
value	ByteString The bytes for name to set.

Returns
Type	Description
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
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
Schema.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setStructSchema(Struct value)

public Schema.Builder setStructSchema(Struct value)

The structured representation of the schema.

.google.protobuf.Struct struct_schema = 2;

Parameter
Name	Description
value	Struct

Returns
Type	Description
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
Name	Description
builderForValue	Builder

Returns
Type	Description
Schema.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Schema.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Schema.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)