public sealed class ImportDocumentsRequest : IMessage<ImportDocumentsRequest>, IEquatable<ImportDocumentsRequest>, IDeepCloneable<ImportDocumentsRequest>, IBufferMessage, IMessageReference documentation and code samples for the Discovery Engine v1 API class ImportDocumentsRequest.
Request message for Import methods.
Implements
IMessageImportDocumentsRequest, IEquatableImportDocumentsRequest, IDeepCloneableImportDocumentsRequest, IBufferMessage, IMessageNamespace
Google.Cloud.DiscoveryEngine.V1Assembly
Google.Cloud.DiscoveryEngine.V1.dll
Constructors
ImportDocumentsRequest()
public ImportDocumentsRequest()ImportDocumentsRequest(ImportDocumentsRequest)
public ImportDocumentsRequest(ImportDocumentsRequest other)| Parameter | |
|---|---|
| Name | Description |
other | ImportDocumentsRequest |
Properties
AutoGenerateIds
public bool AutoGenerateIds { get; set; }Whether to automatically generate IDs for the documents if absent.
If set to true,
[Document.id][google.cloud.discoveryengine.v1.Document.id]s are
automatically generated based on the hash of the payload, where IDs may not
be consistent during multiple imports. In which case
[ReconciliationMode.FULL][google.cloud.discoveryengine.v1.ImportDocumentsRequest.ReconciliationMode.FULL]
is highly recommended to avoid duplicate contents. If unset or set to
false, [Document.id][google.cloud.discoveryengine.v1.Document.id]s have
to be specified using
[id_field][google.cloud.discoveryengine.v1.ImportDocumentsRequest.id_field],
otherwise, documents without IDs fail to be imported.
Only set this field when using
[GcsSource][google.cloud.discoveryengine.v1.GcsSource] or
[BigQuerySource][google.cloud.discoveryengine.v1.BigQuerySource], and when
[GcsSource.data_schema][google.cloud.discoveryengine.v1.GcsSource.data_schema]
or
[BigQuerySource.data_schema][google.cloud.discoveryengine.v1.BigQuerySource.data_schema]
is custom or csv. Otherwise, an INVALID_ARGUMENT error is thrown.
| Property Value | |
|---|---|
| Type | Description |
bool | |
BigquerySource
public BigQuerySource BigquerySource { get; set; }BigQuery input source.
| Property Value | |
|---|---|
| Type | Description |
BigQuerySource | |
ErrorConfig
public ImportErrorConfig ErrorConfig { get; set; }The desired location of errors incurred during the Import.
| Property Value | |
|---|---|
| Type | Description |
ImportErrorConfig | |
GcsSource
public GcsSource GcsSource { get; set; }Cloud Storage location for the input content.
| Property Value | |
|---|---|
| Type | Description |
GcsSource | |
IdField
public string IdField { get; set; }The field in the Cloud Storage and BigQuery sources that indicates the unique IDs of the documents.
For [GcsSource][google.cloud.discoveryengine.v1.GcsSource] it is the key of
the JSON field. For instance, my_id for JSON {"my_id": "some_uuid"}.
For [BigQuerySource][google.cloud.discoveryengine.v1.BigQuerySource] it is
the column name of the BigQuery table where the unique ids are stored.
The values of the JSON field or the BigQuery column are used as the [Document.id][google.cloud.discoveryengine.v1.Document.id]s. The JSON field or the BigQuery column must be of string type, and the values must be set as valid strings conform to RFC-1034 with 1-63 characters. Otherwise, documents without valid IDs fail to be imported.
Only set this field when using
[GcsSource][google.cloud.discoveryengine.v1.GcsSource] or
[BigQuerySource][google.cloud.discoveryengine.v1.BigQuerySource], and when
[GcsSource.data_schema][google.cloud.discoveryengine.v1.GcsSource.data_schema]
or
[BigQuerySource.data_schema][google.cloud.discoveryengine.v1.BigQuerySource.data_schema]
is custom. And only set this field when
[auto_generate_ids][google.cloud.discoveryengine.v1.ImportDocumentsRequest.auto_generate_ids]
is unset or set as false. Otherwise, an INVALID_ARGUMENT error is thrown.
If it is unset, a default value _id is used when importing from the
allowed data sources.
| Property Value | |
|---|---|
| Type | Description |
string | |
InlineSource
public ImportDocumentsRequest.Types.InlineSource InlineSource { get; set; }The Inline source for the input content for documents.
| Property Value | |
|---|---|
| Type | Description |
ImportDocumentsRequestTypesInlineSource | |
Parent
public string Parent { get; set; }Required. The parent branch resource name, such as
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.
Requires create/update permission.
| Property Value | |
|---|---|
| Type | Description |
string | |
ParentAsBranchName
public BranchName ParentAsBranchName { get; set; }BranchName-typed view over the Parent resource name property.
| Property Value | |
|---|---|
| Type | Description |
BranchName | |
ReconciliationMode
public ImportDocumentsRequest.Types.ReconciliationMode ReconciliationMode { get; set; }The mode of reconciliation between existing documents and the documents to be imported. Defaults to [ReconciliationMode.INCREMENTAL][google.cloud.discoveryengine.v1.ImportDocumentsRequest.ReconciliationMode.INCREMENTAL].
| Property Value | |
|---|---|
| Type | Description |
ImportDocumentsRequestTypesReconciliationMode | |
SourceCase
public ImportDocumentsRequest.SourceOneofCase SourceCase { get; }| Property Value | |
|---|---|
| Type | Description |
ImportDocumentsRequestSourceOneofCase | |