# Discovery Engine v1beta API - Class ImportDocumentsRequest (1.0.0-beta23)

1.0.0-beta23 (latest) 1.0.0-beta22

    public sealed class ImportDocumentsRequest : IMessage<ImportDocumentsRequest>, IEquatable<ImportDocumentsRequest>, IDeepCloneable<ImportDocumentsRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Discovery Engine v1beta API class ImportDocumentsRequest.

Request message for Import methods.

## Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) \> ImportDocumentsRequest

## Implements

[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[ImportDocumentsRequest](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.ImportDocumentsRequest), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[ImportDocumentsRequest](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.ImportDocumentsRequest), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[ImportDocumentsRequest](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.ImportDocumentsRequest), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html)

## Inherited Members

[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) [object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) [object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)

## Namespace

[Google.Cloud.DiscoveryEngine.V1Beta](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta)

## Assembly

Google.Cloud.DiscoveryEngine.V1Beta.dll

## Constructors

### ImportDocumentsRequest()

    public ImportDocumentsRequest()

### ImportDocumentsRequest(ImportDocumentsRequest)

    public ImportDocumentsRequest(ImportDocumentsRequest other)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `other` | `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.ImportDocumentsRequest` |

## Properties

### AlloyDbSource

    public AlloyDbSource AlloyDbSource { get; set; }

AlloyDB input source.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.AlloyDbSource` |   |

### 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.v1beta.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.v1beta.ImportDocumentsRequest.ReconciliationMode.FULL\]
is highly recommended to avoid duplicate contents. If unset or set to
`false`, \[Document.id\]\[google.cloud.discoveryengine.v1beta.Document.id\]s
have to be specified using
\[id_field\]\[google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.id_field\],
otherwise, documents without IDs fail to be imported.

Supported data sources:

- \[GcsSource\]\[google.cloud.discoveryengine.v1beta.GcsSource\]. \[GcsSource.data_schema\]\[google.cloud.discoveryengine.v1beta.GcsSource.data_schema\] must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
- \[BigQuerySource\]\[google.cloud.discoveryengine.v1beta.BigQuerySource\]. \[BigQuerySource.data_schema\]\[google.cloud.discoveryengine.v1beta.BigQuerySource.data_schema\] must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
- \[SpannerSource\]\[google.cloud.discoveryengine.v1beta.SpannerSource\].
- \[CloudSqlSource\]\[google.cloud.discoveryengine.v1beta.CloudSqlSource\].
- \[FirestoreSource\]\[google.cloud.discoveryengine.v1beta.FirestoreSource\].
- \[BigtableSource\]\[google.cloud.discoveryengine.v1beta.BigtableSource\].

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.boolean` |   |

### BigquerySource

    public BigQuerySource BigquerySource { get; set; }

BigQuery input source.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.BigQuerySource` |   |

### BigtableSource

    public BigtableSource BigtableSource { get; set; }

Cloud Bigtable input source.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.BigtableSource` |   |

### CloudSqlSource

    public CloudSqlSource CloudSqlSource { get; set; }

Cloud SQL input source.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.CloudSqlSource` |   |

### ErrorConfig

    public ImportErrorConfig ErrorConfig { get; set; }

The desired location of errors incurred during the Import.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.ImportErrorConfig` |   |

### FhirStoreSource

    public FhirStoreSource FhirStoreSource { get; set; }

FhirStore input source.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.FhirStoreSource` |   |

### FirestoreSource

    public FirestoreSource FirestoreSource { get; set; }

Firestore input source.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.FirestoreSource` |   |

### GcsSource

    public GcsSource GcsSource { get; set; }

Cloud Storage location for the input content.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.GcsSource` |   |

### IdField

    public string IdField { get; set; }

The field indicates the ID field or column to be used as unique IDs of
the documents.

For \[GcsSource\]\[google.cloud.discoveryengine.v1beta.GcsSource\] it is the
key of the JSON field. For instance, `my_id` for JSON `{"my_id":
"some_uuid"}`. For others, it may be the column name of the table where the
unique ids are stored.

The values of the JSON field or the table column are used as the
\[Document.id\]\[google.cloud.discoveryengine.v1beta.Document.id\]s. The JSON
field or the table column must be of string type, and the values must be
set as valid strings conform to
[RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters.
Otherwise, documents without valid IDs fail to be imported.

Only set this field when
\[auto_generate_ids\]\[google.cloud.discoveryengine.v1beta.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.

Supported data sources:

- \[GcsSource\]\[google.cloud.discoveryengine.v1beta.GcsSource\]. \[GcsSource.data_schema\]\[google.cloud.discoveryengine.v1beta.GcsSource.data_schema\] must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
- \[BigQuerySource\]\[google.cloud.discoveryengine.v1beta.BigQuerySource\]. \[BigQuerySource.data_schema\]\[google.cloud.discoveryengine.v1beta.BigQuerySource.data_schema\] must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
- \[SpannerSource\]\[google.cloud.discoveryengine.v1beta.SpannerSource\].
- \[CloudSqlSource\]\[google.cloud.discoveryengine.v1beta.CloudSqlSource\].
- \[FirestoreSource\]\[google.cloud.discoveryengine.v1beta.FirestoreSource\].
- \[BigtableSource\]\[google.cloud.discoveryengine.v1beta.BigtableSource\].

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### InlineSource

    public ImportDocumentsRequest.Types.InlineSource InlineSource { get; set; }

The Inline source for the input content for documents.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.ImportDocumentsRequesthttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.ImportDocumentsRequest.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.ImportDocumentsRequest.Types.InlineSource` |   |

### 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** |
| `https://learn.microsoft.com/dotnet/api/system.string` |   |

### ParentAsBranchName

    public BranchName ParentAsBranchName { get; set; }

[BranchName](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.BranchName)-typed view over the [Parent](https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.ImportDocumentsRequest#Google_Cloud_DiscoveryEngine_V1Beta_ImportDocumentsRequest_Parent) resource name property.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.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.v1beta.ImportDocumentsRequest.ReconciliationMode.INCREMENTAL\].

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.ImportDocumentsRequesthttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.ImportDocumentsRequest.Typeshttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.ImportDocumentsRequest.Types.ReconciliationMode` |   |

### SourceCase

    public ImportDocumentsRequest.SourceOneofCase SourceCase { get; }

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.ImportDocumentsRequesthttps://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.ImportDocumentsRequest.SourceOneofCase` |   |

### SpannerSource

    public SpannerSource SpannerSource { get; set; }

Spanner input source.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/dotnet/docs/reference/Google.Cloud.DiscoveryEngine.V1Beta/latest/Google.Cloud.DiscoveryEngine.V1Beta.SpannerSource` |   |

### UpdateMask

    public FieldMask UpdateMask { get; set; }

Indicates which fields in the provided imported documents to update. If
not set, the default is to update all fields.

| **Property Value** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.WellKnownTypes.FieldMask.html` |   |