Class Document.Builder (0.11.0)

public static final class Document.Builder extends GeneratedMessageV3.Builder<Document.Builder> implements DocumentOrBuilder

Document captures all raw metadata information of items to be recommended or searched.

Protobuf type google.cloud.discoveryengine.v1beta.Document

Inheritance

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

Implements

DocumentOrBuilder

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)

GeneratedMessageV3.Builder.internalGetMutableMapField(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

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`Document.Builder`

Overrides

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

build()

public Document build()

Returns
Type	Description
`Document`

buildPartial()

public Document buildPartial()

Returns
Type	Description
`Document`

clear()

public Document.Builder clear()

Returns
Type	Description
`Document.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearData()

public Document.Builder clearData()

Returns
Type	Description
`Document.Builder`

clearField(Descriptors.FieldDescriptor field)

public Document.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`Document.Builder`

Overrides

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

clearId()

public Document.Builder clearId()

Immutable. The identifier of the document. Id should conform to RFC-1034 standard with a length limit of 63 characters.

string id = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
`Document.Builder`	This builder for chaining.

clearJsonData()

public Document.Builder clearJsonData()

The JSON string representation of the document. It should conform to the registered [schema][] or an INVALID_ARGUMENT error is thrown.

string json_data = 5;

Returns
Type	Description
`Document.Builder`	This builder for chaining.

clearName()

public Document.Builder clearName()

Immutable. The full resource name of the document. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}. 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
`Document.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Document.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`Document.Builder`

Overrides

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

clearParentDocumentId()

public Document.Builder clearParentDocumentId()

The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to RFC-1034 standard with a length limit of 63 characters.

string parent_document_id = 7;

Returns
Type	Description
`Document.Builder`	This builder for chaining.

clearSchemaId()

public Document.Builder clearSchemaId()

The identifier of the schema located in the same data store.

string schema_id = 3;

Returns
Type	Description
`Document.Builder`	This builder for chaining.

clearStructData()

public Document.Builder clearStructData()

The structured JSON data for the document. It should conform to the registered [schema][] or an INVALID_ARGUMENT error is thrown.

.google.protobuf.Struct struct_data = 4;

Returns
Type	Description
`Document.Builder`

clone()

public Document.Builder clone()

Returns
Type	Description
`Document.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDataCase()

public Document.DataCase getDataCase()

Returns
Type	Description
`Document.DataCase`

getDefaultInstanceForType()

public Document getDefaultInstanceForType()

Returns
Type	Description
`Document`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getId()

public String getId()

Immutable. The identifier of the document. Id should conform to RFC-1034 standard with a length limit of 63 characters.

string id = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
`String`	The id.

getIdBytes()

public ByteString getIdBytes()

Immutable. The identifier of the document. Id should conform to RFC-1034 standard with a length limit of 63 characters.

string id = 2 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
`ByteString`	The bytes for id.

getJsonData()

public String getJsonData()

The JSON string representation of the document. It should conform to the registered [schema][] or an INVALID_ARGUMENT error is thrown.

string json_data = 5;

Returns
Type	Description
`String`	The jsonData.

getJsonDataBytes()

public ByteString getJsonDataBytes()

The JSON string representation of the document. It should conform to the registered [schema][] or an INVALID_ARGUMENT error is thrown.

string json_data = 5;

Returns
Type	Description
`ByteString`	The bytes for jsonData.

getName()

public String getName()

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

Returns
Type	Description
`String`	The name.

getNameBytes()

public ByteString getNameBytes()

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

Returns
Type	Description
`ByteString`	The bytes for name.

getParentDocumentId()

public String getParentDocumentId()

The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to RFC-1034 standard with a length limit of 63 characters.

string parent_document_id = 7;

Returns
Type	Description
`String`	The parentDocumentId.

getParentDocumentIdBytes()

public ByteString getParentDocumentIdBytes()

The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to RFC-1034 standard with a length limit of 63 characters.

string parent_document_id = 7;

Returns
Type	Description
`ByteString`	The bytes for parentDocumentId.

getSchemaId()

public String getSchemaId()

The identifier of the schema located in the same data store.

string schema_id = 3;

Returns
Type	Description
`String`	The schemaId.

getSchemaIdBytes()

public ByteString getSchemaIdBytes()

The identifier of the schema located in the same data store.

string schema_id = 3;

Returns
Type	Description
`ByteString`	The bytes for schemaId.

getStructData()

public Struct getStructData()

The structured JSON data for the document. It should conform to the registered [schema][] or an INVALID_ARGUMENT error is thrown.

.google.protobuf.Struct struct_data = 4;

Returns
Type	Description
`Struct`	The structData.

getStructDataBuilder()

public Struct.Builder getStructDataBuilder()

The structured JSON data for the document. It should conform to the registered [schema][] or an INVALID_ARGUMENT error is thrown.

.google.protobuf.Struct struct_data = 4;

Returns
Type	Description
`Builder`

getStructDataOrBuilder()

public StructOrBuilder getStructDataOrBuilder()

The structured JSON data for the document. It should conform to the registered [schema][] or an INVALID_ARGUMENT error is thrown.

.google.protobuf.Struct struct_data = 4;

Returns
Type	Description
`StructOrBuilder`

hasJsonData()

public boolean hasJsonData()

The JSON string representation of the document. It should conform to the registered [schema][] or an INVALID_ARGUMENT error is thrown.

string json_data = 5;

Returns
Type	Description
`boolean`	Whether the jsonData field is set.

hasStructData()

public boolean hasStructData()

The structured JSON data for the document. It should conform to the registered [schema][] or an INVALID_ARGUMENT error is thrown.

.google.protobuf.Struct struct_data = 4;

Returns
Type	Description
`boolean`	Whether the structData 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(Document other)

public Document.Builder mergeFrom(Document other)

Parameter
Name	Description
`other`	`Document`

Returns
Type	Description
`Document.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Document.Builder`

Overrides

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

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public Document.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`Document.Builder`

Overrides

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

mergeStructData(Struct value)

public Document.Builder mergeStructData(Struct value)

The structured JSON data for the document. It should conform to the registered [schema][] or an INVALID_ARGUMENT error is thrown.

.google.protobuf.Struct struct_data = 4;

Parameter
Name	Description
`value`	`Struct`

Returns
Type	Description
`Document.Builder`

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Document.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`Document.Builder`

Overrides

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

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`Document.Builder`

Overrides

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

setId(String value)

public Document.Builder setId(String value)

Immutable. The identifier of the document. Id should conform to RFC-1034 standard with a length limit of 63 characters.

string id = 2 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name	Description
`value`	`String` The id to set.

Returns
Type	Description
`Document.Builder`	This builder for chaining.

setIdBytes(ByteString value)

public Document.Builder setIdBytes(ByteString value)

Immutable. The identifier of the document. Id should conform to RFC-1034 standard with a length limit of 63 characters.

string id = 2 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name	Description
`value`	`ByteString` The bytes for id to set.

Returns
Type	Description
`Document.Builder`	This builder for chaining.

setJsonData(String value)

public Document.Builder setJsonData(String value)

The JSON string representation of the document. It should conform to the registered [schema][] or an INVALID_ARGUMENT error is thrown.

string json_data = 5;

Parameter
Name	Description
`value`	`String` The jsonData to set.

Returns
Type	Description
`Document.Builder`	This builder for chaining.

setJsonDataBytes(ByteString value)

public Document.Builder setJsonDataBytes(ByteString value)

The JSON string representation of the document. It should conform to the registered [schema][] or an INVALID_ARGUMENT error is thrown.

string json_data = 5;

Parameter
Name	Description
`value`	`ByteString` The bytes for jsonData to set.

Returns
Type	Description
`Document.Builder`	This builder for chaining.

setName(String value)

public Document.Builder setName(String value)

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

Parameter
Name	Description
`value`	`String` The name to set.

Returns
Type	Description
`Document.Builder`	This builder for chaining.

setNameBytes(ByteString value)

public Document.Builder setNameBytes(ByteString value)

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

Parameter
Name	Description
`value`	`ByteString` The bytes for name to set.

Returns
Type	Description
`Document.Builder`	This builder for chaining.

setParentDocumentId(String value)

public Document.Builder setParentDocumentId(String value)

The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to RFC-1034 standard with a length limit of 63 characters.

string parent_document_id = 7;

Parameter
Name	Description
`value`	`String` The parentDocumentId to set.

Returns
Type	Description
`Document.Builder`	This builder for chaining.

setParentDocumentIdBytes(ByteString value)

public Document.Builder setParentDocumentIdBytes(ByteString value)

The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to RFC-1034 standard with a length limit of 63 characters.

string parent_document_id = 7;

Parameter
Name	Description
`value`	`ByteString` The bytes for parentDocumentId to set.

Returns
Type	Description
`Document.Builder`	This builder for chaining.

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

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

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`Document.Builder`

Overrides

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

setSchemaId(String value)

public Document.Builder setSchemaId(String value)

The identifier of the schema located in the same data store.

string schema_id = 3;

Parameter
Name	Description
`value`	`String` The schemaId to set.

Returns
Type	Description
`Document.Builder`	This builder for chaining.

setSchemaIdBytes(ByteString value)

public Document.Builder setSchemaIdBytes(ByteString value)

The identifier of the schema located in the same data store.

string schema_id = 3;

Parameter
Name	Description
`value`	`ByteString` The bytes for schemaId to set.

Returns
Type	Description
`Document.Builder`	This builder for chaining.

setStructData(Struct value)

public Document.Builder setStructData(Struct value)

The structured JSON data for the document. It should conform to the registered [schema][] or an INVALID_ARGUMENT error is thrown.

.google.protobuf.Struct struct_data = 4;

Parameter
Name	Description
`value`	`Struct`

Returns
Type	Description
`Document.Builder`

setStructData(Struct.Builder builderForValue)

public Document.Builder setStructData(Struct.Builder builderForValue)

The structured JSON data for the document. It should conform to the registered [schema][] or an INVALID_ARGUMENT error is thrown.

.google.protobuf.Struct struct_data = 4;

Parameter
Name	Description
`builderForValue`	`Builder`

Returns
Type	Description
`Document.Builder`

setUnknownFields(UnknownFieldSet unknownFields)

public final Document.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`Document.Builder`

Overrides

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