Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class ImportDocumentsRequest.
Request message for Import methods.
Generated from protobuf message google.cloud.discoveryengine.v1.ImportDocumentsRequest
Namespace
Google \ Cloud \ DiscoveryEngine \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ inline_source
Google\Cloud\DiscoveryEngine\V1\ImportDocumentsRequest\InlineSource
The Inline source for the input content for documents.
↳ gcs_source
↳ bigquery_source
↳ fhir_store_source
↳ spanner_source
↳ cloud_sql_source
↳ firestore_source
↳ alloy_db_source
↳ bigtable_source
↳ parent
string
Required. The parent branch resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}
. Requires create/update permission.
↳ error_config
Google\Cloud\DiscoveryEngine\V1\ImportErrorConfig
The desired location of errors incurred during the Import.
↳ reconciliation_mode
int
The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL .
↳ update_mask
Google\Protobuf\FieldMask
Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields.
↳ auto_generate_ids
bool
Whether to automatically generate IDs for the documents if absent. If set to true
, 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
is highly recommended to avoid duplicate contents. If unset or set to false
, Document.id
s have to be specified using id_field
, otherwise, documents without IDs fail to be imported. Supported data sources: * GcsSource
. GcsSource.data_schema
must be custom
or csv
. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource
. BigQuerySource.data_schema
must be custom
or csv
. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource
. * CloudSqlSource
. * FirestoreSource
. * BigtableSource
.
↳ id_field
string
The field indicates the ID field or column to be used as unique IDs of the documents. For 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
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
with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when 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
. GcsSource.data_schema
must be custom
or csv
. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource
. BigQuerySource.data_schema
must be custom
or csv
. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource
. * CloudSqlSource
. * FirestoreSource
. * BigtableSource
.
getInlineSource
The Inline source for the input content for documents.
hasInlineSource
setInlineSource
The Inline source for the input content for documents.
$this
getGcsSource
Cloud Storage location for the input content.
hasGcsSource
setGcsSource
Cloud Storage location for the input content.
$this
getBigquerySource
BigQuery input source.
hasBigquerySource
setBigquerySource
BigQuery input source.
$this
getFhirStoreSource
FhirStore input source.
hasFhirStoreSource
setFhirStoreSource
FhirStore input source.
$this
getSpannerSource
Spanner input source.
hasSpannerSource
setSpannerSource
Spanner input source.
$this
getCloudSqlSource
Cloud SQL input source.
hasCloudSqlSource
setCloudSqlSource
Cloud SQL input source.
$this
getFirestoreSource
Firestore input source.
hasFirestoreSource
setFirestoreSource
Firestore input source.
$this
getAlloyDbSource
AlloyDB input source.
hasAlloyDbSource
setAlloyDbSource
AlloyDB input source.
$this
getBigtableSource
Cloud Bigtable input source.
hasBigtableSource
setBigtableSource
Cloud Bigtable input source.
$this
getParent
Required. The parent branch resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}
.
Requires create/update permission.
string
setParent
Required. The parent branch resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}
.
Requires create/update permission.
var
string
$this
getErrorConfig
The desired location of errors incurred during the Import.
hasErrorConfig
clearErrorConfig
setErrorConfig
The desired location of errors incurred during the Import.
$this
getReconciliationMode
The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL .
int
setReconciliationMode
The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL .
var
int
$this
getUpdateMask
Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields.
hasUpdateMask
clearUpdateMask
setUpdateMask
Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields.
$this
getAutoGenerateIds
Whether to automatically generate IDs for the documents if absent.
If set to true
, 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
is highly recommended to avoid duplicate contents. If unset or set to false
, Document.id
s have
to be specified using id_field
,
otherwise, documents without IDs fail to be imported.
Supported data sources:
- GcsSource
. GcsSource.data_schema
must be
customorcsv. Otherwise, an INVALID_ARGUMENT error is thrown. - BigQuerySource
. BigQuerySource.data_schema
must be
customorcsv. Otherwise, an INVALID_ARGUMENT error is thrown. - SpannerSource .
- CloudSqlSource .
- FirestoreSource .
- BigtableSource .
bool
setAutoGenerateIds
Whether to automatically generate IDs for the documents if absent.
If set to true
, 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
is highly recommended to avoid duplicate contents. If unset or set to false
, Document.id
s have
to be specified using id_field
,
otherwise, documents without IDs fail to be imported.
Supported data sources:
- GcsSource
. GcsSource.data_schema
must be
customorcsv. Otherwise, an INVALID_ARGUMENT error is thrown. - BigQuerySource
. BigQuerySource.data_schema
must be
customorcsv. Otherwise, an INVALID_ARGUMENT error is thrown. - SpannerSource .
- CloudSqlSource .
- FirestoreSource .
- BigtableSource .
var
bool
$this
getIdField
The field indicates the ID field or column to be used as unique IDs of the documents.
For 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
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
with 1-63 characters. Otherwise, documents without valid IDs fail to be
imported.
Only set this field when 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
. GcsSource.data_schema
must be
customorcsv. Otherwise, an INVALID_ARGUMENT error is thrown. - BigQuerySource
. BigQuerySource.data_schema
must be
customorcsv. Otherwise, an INVALID_ARGUMENT error is thrown. - SpannerSource .
- CloudSqlSource .
- FirestoreSource .
- BigtableSource .
string
setIdField
The field indicates the ID field or column to be used as unique IDs of the documents.
For 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
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
with 1-63 characters. Otherwise, documents without valid IDs fail to be
imported.
Only set this field when 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
. GcsSource.data_schema
must be
customorcsv. Otherwise, an INVALID_ARGUMENT error is thrown. - BigQuerySource
. BigQuerySource.data_schema
must be
customorcsv. Otherwise, an INVALID_ARGUMENT error is thrown. - SpannerSource .
- CloudSqlSource .
- FirestoreSource .
- BigtableSource .
var
string
$this
getSource
string
