Interface DocumentOrBuilder (0.17.0)

Version 0.17.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 interface DocumentOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getContent()

public abstract 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.v1.Document.Content content = 10;

Returns
Type	Description
Document.Content	The content.

getContentOrBuilder()

public abstract 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.v1.Document.Content content = 10;

Returns
Type	Description
Document.ContentOrBuilder

getDataCase()

public abstract Document.DataCase getDataCase()

Returns
Type	Description
Document.DataCase

getDerivedStructData()

public abstract 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.

getDerivedStructDataOrBuilder()

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

getId()

public abstract 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 abstract 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 abstract String getJsonData()

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

string json_data = 5;

Returns
Type	Description
String	The jsonData.

getJsonDataBytes()

public abstract ByteString getJsonDataBytes()

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

string json_data = 5;

Returns
Type	Description
ByteString	The bytes for jsonData.

getName()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract Struct getStructData()

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

.google.protobuf.Struct struct_data = 4;

Returns
Type	Description
Struct	The structData.

getStructDataOrBuilder()

public abstract StructOrBuilder getStructDataOrBuilder()

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

.google.protobuf.Struct struct_data = 4;

Returns
Type	Description
StructOrBuilder

hasContent()

public abstract 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.v1.Document.Content content = 10;

Returns
Type	Description
boolean	Whether the content field is set.

hasDerivedStructData()

public abstract 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.

hasJsonData()

public abstract boolean hasJsonData()

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

string json_data = 5;

Returns
Type	Description
boolean	Whether the jsonData field is set.

hasStructData()

public abstract boolean hasStructData()

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

.google.protobuf.Struct struct_data = 4;

Returns
Type	Description
boolean	Whether the structData field is set.