com.google.cloud.discoveryengine.v1beta

Interface ImportDocumentsRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ImportDocumentsRequest, ImportDocumentsRequest.Builder

public interface ImportDocumentsRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	getAutoGenerateIds() Whether to automatically generate IDs for the documents if absent.
BigQuerySource	getBigquerySource() BigQuery input source.
BigQuerySourceOrBuilder	getBigquerySourceOrBuilder() BigQuery input source.
ImportErrorConfig	getErrorConfig() The desired location of errors incurred during the Import.
ImportErrorConfigOrBuilder	getErrorConfigOrBuilder() The desired location of errors incurred during the Import.
GcsSource	getGcsSource() Cloud Storage location for the input content.
GcsSourceOrBuilder	getGcsSourceOrBuilder() Cloud Storage location for the input content.
String	getIdField() The field in the Cloud Storage and BigQuery sources that indicates the unique IDs of the documents.
com.google.protobuf.ByteString	getIdFieldBytes() The field in the Cloud Storage and BigQuery sources that indicates the unique IDs of the documents.
ImportDocumentsRequest.InlineSource	getInlineSource() The Inline source for the input content for documents.
ImportDocumentsRequest.InlineSourceOrBuilder	getInlineSourceOrBuilder() The Inline source for the input content for documents.
String	getParent() Required.
com.google.protobuf.ByteString	getParentBytes() Required.
ImportDocumentsRequest.ReconciliationMode	getReconciliationMode() The mode of reconciliation between existing documents and the documents to be imported.
int	getReconciliationModeValue() The mode of reconciliation between existing documents and the documents to be imported.
ImportDocumentsRequest.SourceCase	getSourceCase()
boolean	hasBigquerySource() BigQuery input source.
boolean	hasErrorConfig() The desired location of errors incurred during the Import.
boolean	hasGcsSource() Cloud Storage location for the input content.
boolean	hasInlineSource() The Inline source for the input content for documents.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasInlineSource

boolean hasInlineSource()

 The Inline source for the input content for documents.
 

.google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.InlineSource inline_source = 2;

Returns:

Whether the inlineSource field is set.

getInlineSource

ImportDocumentsRequest.InlineSource getInlineSource()

 The Inline source for the input content for documents.
 

.google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.InlineSource inline_source = 2;

Returns:

The inlineSource.

getInlineSourceOrBuilder

ImportDocumentsRequest.InlineSourceOrBuilder getInlineSourceOrBuilder()

 The Inline source for the input content for documents.
 

.google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.InlineSource inline_source = 2;

hasGcsSource

boolean hasGcsSource()

 Cloud Storage location for the input content.
 

.google.cloud.discoveryengine.v1beta.GcsSource gcs_source = 3;

Returns:

Whether the gcsSource field is set.

getGcsSource

GcsSource getGcsSource()

 Cloud Storage location for the input content.
 

.google.cloud.discoveryengine.v1beta.GcsSource gcs_source = 3;

Returns:

The gcsSource.

getGcsSourceOrBuilder

GcsSourceOrBuilder getGcsSourceOrBuilder()

 Cloud Storage location for the input content.
 

.google.cloud.discoveryengine.v1beta.GcsSource gcs_source = 3;

hasBigquerySource

boolean hasBigquerySource()

 BigQuery input source.
 

.google.cloud.discoveryengine.v1beta.BigQuerySource bigquery_source = 4;

Returns:

Whether the bigquerySource field is set.

getBigquerySource

BigQuerySource getBigquerySource()

 BigQuery input source.
 

.google.cloud.discoveryengine.v1beta.BigQuerySource bigquery_source = 4;

Returns:

The bigquerySource.

getBigquerySourceOrBuilder

BigQuerySourceOrBuilder getBigquerySourceOrBuilder()

 BigQuery input source.
 

.google.cloud.discoveryengine.v1beta.BigQuerySource bigquery_source = 4;

getParent

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:

The parent.

getParentBytes

com.google.protobuf.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:

The bytes for parent.

hasErrorConfig

boolean hasErrorConfig()

 The desired location of errors incurred during the Import.
 

.google.cloud.discoveryengine.v1beta.ImportErrorConfig error_config = 5;

Returns:

Whether the errorConfig field is set.

getErrorConfig

ImportErrorConfig getErrorConfig()

 The desired location of errors incurred during the Import.
 

.google.cloud.discoveryengine.v1beta.ImportErrorConfig error_config = 5;

Returns:

The errorConfig.

getErrorConfigOrBuilder

ImportErrorConfigOrBuilder getErrorConfigOrBuilder()

 The desired location of errors incurred during the Import.
 

.google.cloud.discoveryengine.v1beta.ImportErrorConfig error_config = 5;

getReconciliationModeValue

int getReconciliationModeValue()

 The mode of reconciliation between existing documents and the documents to
 be imported. Defaults to
 [ReconciliationMode.INCREMENTAL][google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.ReconciliationMode.INCREMENTAL].
 

.google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.ReconciliationMode reconciliation_mode = 6;

Returns:

The enum numeric value on the wire for reconciliationMode.

getReconciliationMode

ImportDocumentsRequest.ReconciliationMode getReconciliationMode()

 The mode of reconciliation between existing documents and the documents to
 be imported. Defaults to
 [ReconciliationMode.INCREMENTAL][google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.ReconciliationMode.INCREMENTAL].
 

.google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.ReconciliationMode reconciliation_mode = 6;

Returns:

The reconciliationMode.

getAutoGenerateIds

boolean getAutoGenerateIds()

 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.

 Only set this field when using
 [GcsSource][google.cloud.discoveryengine.v1beta.GcsSource] or
 [BigQuerySource][google.cloud.discoveryengine.v1beta.BigQuerySource], and
 when
 [GcsSource.data_schema][google.cloud.discoveryengine.v1beta.GcsSource.data_schema]
 or
 [BigQuerySource.data_schema][google.cloud.discoveryengine.v1beta.BigQuerySource.data_schema]
 is `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
 

bool auto_generate_ids = 8;

Returns:

The autoGenerateIds.

getIdField

String getIdField()

 The field in the Cloud Storage and BigQuery sources that indicates the
 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
 [BigQuerySource][google.cloud.discoveryengine.v1beta.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.v1beta.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](https://tools.ietf.org/html/rfc1034) with 1-63 characters.
 Otherwise, documents without valid IDs fail to be imported.

 Only set this field when using
 [GcsSource][google.cloud.discoveryengine.v1beta.GcsSource] or
 [BigQuerySource][google.cloud.discoveryengine.v1beta.BigQuerySource], and
 when
 [GcsSource.data_schema][google.cloud.discoveryengine.v1beta.GcsSource.data_schema]
 or
 [BigQuerySource.data_schema][google.cloud.discoveryengine.v1beta.BigQuerySource.data_schema]
 is `custom`. And 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.
 

string id_field = 9;

Returns:

The idField.

getIdFieldBytes

com.google.protobuf.ByteString getIdFieldBytes()

 The field in the Cloud Storage and BigQuery sources that indicates the
 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
 [BigQuerySource][google.cloud.discoveryengine.v1beta.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.v1beta.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](https://tools.ietf.org/html/rfc1034) with 1-63 characters.
 Otherwise, documents without valid IDs fail to be imported.

 Only set this field when using
 [GcsSource][google.cloud.discoveryengine.v1beta.GcsSource] or
 [BigQuerySource][google.cloud.discoveryengine.v1beta.BigQuerySource], and
 when
 [GcsSource.data_schema][google.cloud.discoveryengine.v1beta.GcsSource.data_schema]
 or
 [BigQuerySource.data_schema][google.cloud.discoveryengine.v1beta.BigQuerySource.data_schema]
 is `custom`. And 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.
 

string id_field = 9;

Returns:

The bytes for idField.

getSourceCase

ImportDocumentsRequest.SourceCase getSourceCase()