DocumentDiscoveryengineV1betaArgs class

The set of arguments for Document. The set of arguments for Document.

Constructors

DocumentDiscoveryengineV1betaArgs({required Input<String> branchId, required Input<String> collectionId, Input<GoogleCloudDiscoveryengineV1betaDocumentContent>? content, required Input<String> dataStoreId, required Input<String> documentId, Input<String>? id, Input<String>? jsonData, Input<String>? location, Input<String>? name, Input<String>? parentDocumentId, Input<String>? project, Input<String>? schemaId, Input<Map<String, String>>? structData})
Creates a new DocumentDiscoveryengineV1betaArgs. branchId Required. collectionId Required. content The unstructured data linked to this document. Content must be set if this document is under a CONTENT_REQUIRED data store. dataStoreId Required. documentId Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. This field must be unique among all Documents with the same parent. Otherwise, an ALREADY_EXISTS error is returned. This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. id Immutable. The identifier of the document. Id should conform to RFC-1034 standard with a length limit of 63 characters. jsonData The JSON string representation of the document. It should conform to the registered Schema or an INVALID_ARGUMENT error is thrown. location Optional. 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. project Optional. 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
DocumentDiscoveryengineV1betaArgs.fromMap(Map<String, dynamic> map)
factory

Properties

branchId → Input<String>
final
collectionId → Input<String>
final
content → Input<GoogleCloudDiscoveryengineV1betaDocumentContent>?
The unstructured data linked to this document. Content must be set if this document is under a CONTENT_REQUIRED data store.
final
dataStoreId → Input<String>
final
documentId → Input<String>
Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. This field must be unique among all Documents with the same parent. Otherwise, an ALREADY_EXISTS error is returned. This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
final
hashCode → int
The hash code for this object.
no setterinherited
id → Input<String>?
Immutable. The identifier of the document. Id should conform to RFC-1034 standard with a length limit of 63 characters.
final
jsonData → Input<String>?
The JSON string representation of the document. It should conform to the registered Schema or an INVALID_ARGUMENT error is thrown.
final
location → Input<String>?
final
name → Input<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 → Input<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
project → Input<String>?
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
schemaId → Input<String>?
The identifier of the schema located in the same data store.
final
structData → Input<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