Class Document.Builder (0.38.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

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

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

clearContent()

public Document.Builder clearContent()

The unstructured data linked to this document. Content must be set if this document is under a CONTENT_REQUIRED data store.

.google.cloud.discoveryengine.v1beta.Document.Content content = 10;

Returns
Type Description
Document.Builder

clearData()

public Document.Builder clearData()
Returns
Type Description
Document.Builder

clearDerivedStructData()

public Document.Builder clearDerivedStructData()

Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.

.google.protobuf.Struct derived_struct_data = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

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.

clearIndexTime()

public Document.Builder clearIndexTime()

Output only. The last time the document was indexed. If this field is set, the document could be returned in search results.

This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed.

.google.protobuf.Timestamp index_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Document.Builder

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

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

getContent()

public Document.Content getContent()

The unstructured data linked to this document. Content must be set if this document is under a CONTENT_REQUIRED data store.

.google.cloud.discoveryengine.v1beta.Document.Content content = 10;

Returns
Type Description
Document.Content

The content.

getContentBuilder()

public Document.Content.Builder getContentBuilder()

The unstructured data linked to this document. Content must be set if this document is under a CONTENT_REQUIRED data store.

.google.cloud.discoveryengine.v1beta.Document.Content content = 10;

Returns
Type Description
Document.Content.Builder

getContentOrBuilder()

public Document.ContentOrBuilder getContentOrBuilder()

The unstructured data linked to this document. Content must be set if this document is under a CONTENT_REQUIRED data store.

.google.cloud.discoveryengine.v1beta.Document.Content content = 10;

Returns
Type Description
Document.ContentOrBuilder

getDataCase()

public Document.DataCase getDataCase()
Returns
Type Description
Document.DataCase

getDefaultInstanceForType()

public Document getDefaultInstanceForType()
Returns
Type Description
Document

getDerivedStructData()

public Struct getDerivedStructData()

Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.

.google.protobuf.Struct derived_struct_data = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Struct

The derivedStructData.

getDerivedStructDataBuilder()

public Struct.Builder getDerivedStructDataBuilder()

Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.

.google.protobuf.Struct derived_struct_data = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getDerivedStructDataOrBuilder()

public StructOrBuilder getDerivedStructDataOrBuilder()

Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.

.google.protobuf.Struct derived_struct_data = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
StructOrBuilder

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getIndexTime()

public Timestamp getIndexTime()

Output only. The last time the document was indexed. If this field is set, the document could be returned in search results.

This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed.

.google.protobuf.Timestamp index_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The indexTime.

getIndexTimeBuilder()

public Timestamp.Builder getIndexTimeBuilder()

Output only. The last time the document was indexed. If this field is set, the document could be returned in search results.

This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed.

.google.protobuf.Timestamp index_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Builder

getIndexTimeOrBuilder()

public TimestampOrBuilder getIndexTimeOrBuilder()

Output only. The last time the document was indexed. If this field is set, the document could be returned in search results.

This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed.

.google.protobuf.Timestamp index_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

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()

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
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

hasContent()

public boolean hasContent()

The unstructured data linked to this document. Content must be set if this document is under a CONTENT_REQUIRED data store.

.google.cloud.discoveryengine.v1beta.Document.Content content = 10;

Returns
Type Description
boolean

Whether the content field is set.

hasDerivedStructData()

public boolean hasDerivedStructData()

Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.

.google.protobuf.Struct derived_struct_data = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the derivedStructData field is set.

hasIndexTime()

public boolean hasIndexTime()

Output only. The last time the document was indexed. If this field is set, the document could be returned in search results.

This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed.

.google.protobuf.Timestamp index_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the indexTime field is set.

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeContent(Document.Content value)

public Document.Builder mergeContent(Document.Content value)

The unstructured data linked to this document. Content must be set if this document is under a CONTENT_REQUIRED data store.

.google.cloud.discoveryengine.v1beta.Document.Content content = 10;

Parameter
Name Description
value Document.Content
Returns
Type Description
Document.Builder

mergeDerivedStructData(Struct value)

public Document.Builder mergeDerivedStructData(Struct value)

Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.

.google.protobuf.Struct derived_struct_data = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Struct
Returns
Type Description
Document.Builder

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
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Document.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Document.Builder
Overrides

mergeIndexTime(Timestamp value)

public Document.Builder mergeIndexTime(Timestamp value)

Output only. The last time the document was indexed. If this field is set, the document could be returned in search results.

This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed.

.google.protobuf.Timestamp index_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Document.Builder

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

setContent(Document.Content value)

public Document.Builder setContent(Document.Content value)

The unstructured data linked to this document. Content must be set if this document is under a CONTENT_REQUIRED data store.

.google.cloud.discoveryengine.v1beta.Document.Content content = 10;

Parameter
Name Description
value Document.Content
Returns
Type Description
Document.Builder

setContent(Document.Content.Builder builderForValue)

public Document.Builder setContent(Document.Content.Builder builderForValue)

The unstructured data linked to this document. Content must be set if this document is under a CONTENT_REQUIRED data store.

.google.cloud.discoveryengine.v1beta.Document.Content content = 10;

Parameter
Name Description
builderForValue Document.Content.Builder
Returns
Type Description
Document.Builder

setDerivedStructData(Struct value)

public Document.Builder setDerivedStructData(Struct value)

Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.

.google.protobuf.Struct derived_struct_data = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Struct
Returns
Type Description
Document.Builder

setDerivedStructData(Struct.Builder builderForValue)

public Document.Builder setDerivedStructData(Struct.Builder builderForValue)

Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.

.google.protobuf.Struct derived_struct_data = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Document.Builder

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

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.

setIndexTime(Timestamp value)

public Document.Builder setIndexTime(Timestamp value)

Output only. The last time the document was indexed. If this field is set, the document could be returned in search results.

This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed.

.google.protobuf.Timestamp index_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
Document.Builder

setIndexTime(Timestamp.Builder builderForValue)

public Document.Builder setIndexTime(Timestamp.Builder builderForValue)

Output only. The last time the document was indexed. If this field is set, the document could be returned in search results.

This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed.

.google.protobuf.Timestamp index_time = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Document.Builder

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)

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

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)

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

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

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