Google Cloud Discovery Engine V1 Client - Class ImportDocumentsRequest (0.5.0)

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 \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
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 Google\Cloud\DiscoveryEngine\V1\GcsSource

Cloud Storage location for the input content.

↳ bigquery_source Google\Cloud\DiscoveryEngine\V1\BigQuerySource

BigQuery input 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.

↳ auto_generate_ids bool

Whether to automatically generate IDs for the documents if absent. If set to true, Document.ids 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.ids have to be specified using id_field, otherwises, documents without IDs will fail to be imported. Only set this field when using GcsSource or BigQuerySource, and when GcsSource.data_schema or BigQuerySource.data_schema is custom. Otherwise, an INVALID_ARGUMENT error is thrown.

↳ id_field string

The field in the Cloud Storage and BigQuery sources that indicates the 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 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 will be used as the Document.ids. 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 will fail to be imported. Only set this field when using GcsSource or BigQuerySource, and when GcsSource.data_schema or BigQuerySource.data_schema is custom. And 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.

getInlineSource

The Inline source for the input content for documents.

Returns
TypeDescription
Google\Cloud\DiscoveryEngine\V1\ImportDocumentsRequest\InlineSource|null

hasInlineSource

setInlineSource

The Inline source for the input content for documents.

Parameter
NameDescription
var Google\Cloud\DiscoveryEngine\V1\ImportDocumentsRequest\InlineSource
Returns
TypeDescription
$this

getGcsSource

Cloud Storage location for the input content.

Returns
TypeDescription
Google\Cloud\DiscoveryEngine\V1\GcsSource|null

hasGcsSource

setGcsSource

Cloud Storage location for the input content.

Parameter
NameDescription
var Google\Cloud\DiscoveryEngine\V1\GcsSource
Returns
TypeDescription
$this

getBigquerySource

BigQuery input source.

Returns
TypeDescription
Google\Cloud\DiscoveryEngine\V1\BigQuerySource|null

hasBigquerySource

setBigquerySource

BigQuery input source.

Parameter
NameDescription
var Google\Cloud\DiscoveryEngine\V1\BigQuerySource
Returns
TypeDescription
$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.

Returns
TypeDescription
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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getErrorConfig

The desired location of errors incurred during the Import.

Returns
TypeDescription
Google\Cloud\DiscoveryEngine\V1\ImportErrorConfig|null

hasErrorConfig

clearErrorConfig

setErrorConfig

The desired location of errors incurred during the Import.

Parameter
NameDescription
var Google\Cloud\DiscoveryEngine\V1\ImportErrorConfig
Returns
TypeDescription
$this

getReconciliationMode

The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL.

Returns
TypeDescription
int

setReconciliationMode

The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getAutoGenerateIds

Whether to automatically generate IDs for the documents if absent.

If set to true, Document.ids 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.ids have to be specified using id_field, otherwises, documents without IDs will fail to be imported. Only set this field when using GcsSource or BigQuerySource, and when GcsSource.data_schema or BigQuerySource.data_schema is custom. Otherwise, an INVALID_ARGUMENT error is thrown.

Returns
TypeDescription
bool

setAutoGenerateIds

Whether to automatically generate IDs for the documents if absent.

If set to true, Document.ids 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.ids have to be specified using id_field, otherwises, documents without IDs will fail to be imported. Only set this field when using GcsSource or BigQuerySource, and when GcsSource.data_schema or BigQuerySource.data_schema is custom. Otherwise, an INVALID_ARGUMENT error is thrown.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this

getIdField

The field in the Cloud Storage and BigQuery sources that indicates the 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 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 will be used as the Document.ids. 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 will fail to be imported. Only set this field when using GcsSource or BigQuerySource, and when GcsSource.data_schema or BigQuerySource.data_schema is custom. And 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.

Returns
TypeDescription
string

setIdField

The field in the Cloud Storage and BigQuery sources that indicates the 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 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 will be used as the Document.ids. 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 will fail to be imported. Only set this field when using GcsSource or BigQuerySource, and when GcsSource.data_schema or BigQuerySource.data_schema is custom. And 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.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getSource

Returns
TypeDescription
string