GetDocumentResult class

Result data returned by getDocument.

Constructors

GetDocumentResult({required GoogleCloudDiscoveryengineV1alphaDocumentContentResponse content, required Map<String, String> derivedStructData, required String jsonData, required String name, required String parentDocumentId, required String schemaId, required Map<String, String> structData})

Creates a new GetDocumentResult. content The unstructured data linked to this document. Content must be set if this document is under a CONTENT_REQUIRED data store. derivedStructData This field is OUTPUT_ONLY. It contains derived data that are not in the original input document. jsonData The JSON string representation of the document. It should conform to the registered Schema or an INVALID_ARGUMENT error is thrown. name 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. parentDocumentId 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. schemaId The identifier of the schema located in the same data store. structData The structured JSON data for the document. It should conform to the registered Schema or an INVALID_ARGUMENT error is thrown.

const

GetDocumentResult.fromMap(Map<String, dynamic> map)

factory

Properties

content → GoogleCloudDiscoveryengineV1alphaDocumentContentResponse

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

final

derivedStructData → Map<String, String>

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

final

hashCode → int

The hash code for this object.

no setter, inherited

jsonData → String

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

final

name → String

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.

final

parentDocumentId → String

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.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

schemaId → String

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

final

structData → Map<String, String>

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

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toMap() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited