- 0.50.0 (latest)
- 0.49.0
- 0.48.0
- 0.47.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
public interface ImportDocumentsRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAutoGenerateIds()
public abstract boolean 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,
otherwise, documents without IDs fail to be imported.
Only set this field when using
GcsSource or
BigQuerySource, and
when
GcsSource.data_schema
or
BigQuerySource.data_schema
is custom or csv. Otherwise, an INVALID_ARGUMENT error is thrown.
bool auto_generate_ids = 8;
| Returns | |
|---|---|
| Type | Description |
boolean | The autoGenerateIds. |
getBigquerySource()
public abstract BigQuerySource getBigquerySource()BigQuery input source.
.google.cloud.discoveryengine.v1alpha.BigQuerySource bigquery_source = 4;
| Returns | |
|---|---|
| Type | Description |
BigQuerySource | The bigquerySource. |
getBigquerySourceOrBuilder()
public abstract BigQuerySourceOrBuilder getBigquerySourceOrBuilder()BigQuery input source.
.google.cloud.discoveryengine.v1alpha.BigQuerySource bigquery_source = 4;
| Returns | |
|---|---|
| Type | Description |
BigQuerySourceOrBuilder | |
getErrorConfig()
public abstract ImportErrorConfig getErrorConfig()The desired location of errors incurred during the Import.
.google.cloud.discoveryengine.v1alpha.ImportErrorConfig error_config = 5;
| Returns | |
|---|---|
| Type | Description |
ImportErrorConfig | The errorConfig. |
getErrorConfigOrBuilder()
public abstract ImportErrorConfigOrBuilder getErrorConfigOrBuilder()The desired location of errors incurred during the Import.
.google.cloud.discoveryengine.v1alpha.ImportErrorConfig error_config = 5;
| Returns | |
|---|---|
| Type | Description |
ImportErrorConfigOrBuilder | |
getGcsSource()
public abstract GcsSource getGcsSource()Cloud Storage location for the input content.
.google.cloud.discoveryengine.v1alpha.GcsSource gcs_source = 3;
| Returns | |
|---|---|
| Type | Description |
GcsSource | The gcsSource. |
getGcsSourceOrBuilder()
public abstract GcsSourceOrBuilder getGcsSourceOrBuilder()Cloud Storage location for the input content.
.google.cloud.discoveryengine.v1alpha.GcsSource gcs_source = 3;
| Returns | |
|---|---|
| Type | Description |
GcsSourceOrBuilder | |
getIdField()
public abstract String 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 are 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 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.
string id_field = 9;
| Returns | |
|---|---|
| Type | Description |
String | The idField. |
getIdFieldBytes()
public abstract ByteString getIdFieldBytes()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 are 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 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.
string id_field = 9;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for idField. |
getInlineSource()
public abstract ImportDocumentsRequest.InlineSource getInlineSource()The Inline source for the input content for documents.
.google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.InlineSource inline_source = 2;
| Returns | |
|---|---|
| Type | Description |
ImportDocumentsRequest.InlineSource | The inlineSource. |
getInlineSourceOrBuilder()
public abstract ImportDocumentsRequest.InlineSourceOrBuilder getInlineSourceOrBuilder()The Inline source for the input content for documents.
.google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.InlineSource inline_source = 2;
| Returns | |
|---|---|
| Type | Description |
ImportDocumentsRequest.InlineSourceOrBuilder | |
getParent()
public abstract String 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 parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String | The parent. |
getParentBytes()
public abstract ByteString getParentBytes() Required. The parent branch resource name, such as
projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.
Requires create/update permission.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for parent. |
getReconciliationMode()
public abstract ImportDocumentsRequest.ReconciliationMode getReconciliationMode()The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL.
.google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.ReconciliationMode reconciliation_mode = 6;
| Returns | |
|---|---|
| Type | Description |
ImportDocumentsRequest.ReconciliationMode | The reconciliationMode. |
getReconciliationModeValue()
public abstract int getReconciliationModeValue()The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL.
.google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.ReconciliationMode reconciliation_mode = 6;
| Returns | |
|---|---|
| Type | Description |
int | The enum numeric value on the wire for reconciliationMode. |
getSourceCase()
public abstract ImportDocumentsRequest.SourceCase getSourceCase()| Returns | |
|---|---|
| Type | Description |
ImportDocumentsRequest.SourceCase | |
hasBigquerySource()
public abstract boolean hasBigquerySource()BigQuery input source.
.google.cloud.discoveryengine.v1alpha.BigQuerySource bigquery_source = 4;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the bigquerySource field is set. |
hasErrorConfig()
public abstract boolean hasErrorConfig()The desired location of errors incurred during the Import.
.google.cloud.discoveryengine.v1alpha.ImportErrorConfig error_config = 5;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the errorConfig field is set. |
hasGcsSource()
public abstract boolean hasGcsSource()Cloud Storage location for the input content.
.google.cloud.discoveryengine.v1alpha.GcsSource gcs_source = 3;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the gcsSource field is set. |
hasInlineSource()
public abstract boolean hasInlineSource()The Inline source for the input content for documents.
.google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.InlineSource inline_source = 2;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the inlineSource field is set. |