com.google.cloud.discoveryengine.v1alpha

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
AlloyDbSource	getAlloyDbSource() AlloyDB input source.
AlloyDbSourceOrBuilder	getAlloyDbSourceOrBuilder() AlloyDB input source.
boolean	getAutoGenerateIds() Whether to automatically generate IDs for the documents if absent.
BigQuerySource	getBigquerySource() BigQuery input source.
BigQuerySourceOrBuilder	getBigquerySourceOrBuilder() BigQuery input source.
BigtableSource	getBigtableSource() Cloud Bigtable input source.
BigtableSourceOrBuilder	getBigtableSourceOrBuilder() Cloud Bigtable input source.
CloudSqlSource	getCloudSqlSource() Cloud SQL input source.
CloudSqlSourceOrBuilder	getCloudSqlSourceOrBuilder() Cloud SQL input source.
ImportErrorConfig	getErrorConfig() The desired location of errors incurred during the Import.
ImportErrorConfigOrBuilder	getErrorConfigOrBuilder() The desired location of errors incurred during the Import.
FhirStoreSource	getFhirStoreSource() FhirStore input source.
FhirStoreSourceOrBuilder	getFhirStoreSourceOrBuilder() FhirStore input source.
FirestoreSource	getFirestoreSource() Firestore input source.
FirestoreSourceOrBuilder	getFirestoreSourceOrBuilder() Firestore input source.
GcsSource	getGcsSource() Cloud Storage location for the input content.
GcsSourceOrBuilder	getGcsSourceOrBuilder() Cloud Storage location for the input content.
String	getIdField() The field indicates the ID field or column to be used as unique IDs of the documents.
com.google.protobuf.ByteString	getIdFieldBytes() The field indicates the ID field or column to be used as 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()
SpannerSource	getSpannerSource() Spanner input source.
SpannerSourceOrBuilder	getSpannerSourceOrBuilder() Spanner input source.
com.google.protobuf.FieldMask	getUpdateMask() Indicates which fields in the provided imported documents to update.
com.google.protobuf.FieldMaskOrBuilder	getUpdateMaskOrBuilder() Indicates which fields in the provided imported documents to update.
boolean	hasAlloyDbSource() AlloyDB input source.
boolean	hasBigquerySource() BigQuery input source.
boolean	hasBigtableSource() Cloud Bigtable input source.
boolean	hasCloudSqlSource() Cloud SQL input source.
boolean	hasErrorConfig() The desired location of errors incurred during the Import.
boolean	hasFhirStoreSource() FhirStore input source.
boolean	hasFirestoreSource() Firestore input source.
boolean	hasGcsSource() Cloud Storage location for the input content.
boolean	hasInlineSource() The Inline source for the input content for documents.
boolean	hasSpannerSource() Spanner input source.
boolean	hasUpdateMask() Indicates which fields in the provided imported documents to update.

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.v1alpha.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.v1alpha.ImportDocumentsRequest.InlineSource inline_source = 2;

Returns:

The inlineSource.

getInlineSourceOrBuilder

ImportDocumentsRequest.InlineSourceOrBuilder getInlineSourceOrBuilder()

 The Inline source for the input content for documents.
 

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

hasGcsSource

boolean hasGcsSource()

 Cloud Storage location for the input content.
 

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

Returns:

Whether the gcsSource field is set.

getGcsSource

GcsSource getGcsSource()

 Cloud Storage location for the input content.
 

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

Returns:

The gcsSource.

getGcsSourceOrBuilder

GcsSourceOrBuilder getGcsSourceOrBuilder()

 Cloud Storage location for the input content.
 

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

hasBigquerySource

boolean hasBigquerySource()

 BigQuery input source.
 

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

Returns:

Whether the bigquerySource field is set.

getBigquerySource

BigQuerySource getBigquerySource()

 BigQuery input source.
 

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

Returns:

The bigquerySource.

getBigquerySourceOrBuilder

BigQuerySourceOrBuilder getBigquerySourceOrBuilder()

 BigQuery input source.
 

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

hasFhirStoreSource

boolean hasFhirStoreSource()

 FhirStore input source.
 

.google.cloud.discoveryengine.v1alpha.FhirStoreSource fhir_store_source = 10;

Returns:

Whether the fhirStoreSource field is set.

getFhirStoreSource

FhirStoreSource getFhirStoreSource()

 FhirStore input source.
 

.google.cloud.discoveryengine.v1alpha.FhirStoreSource fhir_store_source = 10;

Returns:

The fhirStoreSource.

getFhirStoreSourceOrBuilder

FhirStoreSourceOrBuilder getFhirStoreSourceOrBuilder()

 FhirStore input source.
 

.google.cloud.discoveryengine.v1alpha.FhirStoreSource fhir_store_source = 10;

hasSpannerSource

boolean hasSpannerSource()

 Spanner input source.
 

.google.cloud.discoveryengine.v1alpha.SpannerSource spanner_source = 11;

Returns:

Whether the spannerSource field is set.

getSpannerSource

SpannerSource getSpannerSource()

 Spanner input source.
 

.google.cloud.discoveryengine.v1alpha.SpannerSource spanner_source = 11;

Returns:

The spannerSource.

getSpannerSourceOrBuilder

SpannerSourceOrBuilder getSpannerSourceOrBuilder()

 Spanner input source.
 

.google.cloud.discoveryengine.v1alpha.SpannerSource spanner_source = 11;

hasCloudSqlSource

boolean hasCloudSqlSource()

 Cloud SQL input source.
 

.google.cloud.discoveryengine.v1alpha.CloudSqlSource cloud_sql_source = 12;

Returns:

Whether the cloudSqlSource field is set.

getCloudSqlSource

CloudSqlSource getCloudSqlSource()

 Cloud SQL input source.
 

.google.cloud.discoveryengine.v1alpha.CloudSqlSource cloud_sql_source = 12;

Returns:

The cloudSqlSource.

getCloudSqlSourceOrBuilder

CloudSqlSourceOrBuilder getCloudSqlSourceOrBuilder()

 Cloud SQL input source.
 

.google.cloud.discoveryengine.v1alpha.CloudSqlSource cloud_sql_source = 12;

hasFirestoreSource

boolean hasFirestoreSource()

 Firestore input source.
 

.google.cloud.discoveryengine.v1alpha.FirestoreSource firestore_source = 13;

Returns:

Whether the firestoreSource field is set.

getFirestoreSource

FirestoreSource getFirestoreSource()

 Firestore input source.
 

.google.cloud.discoveryengine.v1alpha.FirestoreSource firestore_source = 13;

Returns:

The firestoreSource.

getFirestoreSourceOrBuilder

FirestoreSourceOrBuilder getFirestoreSourceOrBuilder()

 Firestore input source.
 

.google.cloud.discoveryengine.v1alpha.FirestoreSource firestore_source = 13;

hasAlloyDbSource

boolean hasAlloyDbSource()

 AlloyDB input source.
 

.google.cloud.discoveryengine.v1alpha.AlloyDbSource alloy_db_source = 14;

Returns:

Whether the alloyDbSource field is set.

getAlloyDbSource

AlloyDbSource getAlloyDbSource()

 AlloyDB input source.
 

.google.cloud.discoveryengine.v1alpha.AlloyDbSource alloy_db_source = 14;

Returns:

The alloyDbSource.

getAlloyDbSourceOrBuilder

AlloyDbSourceOrBuilder getAlloyDbSourceOrBuilder()

 AlloyDB input source.
 

.google.cloud.discoveryengine.v1alpha.AlloyDbSource alloy_db_source = 14;

hasBigtableSource

boolean hasBigtableSource()

 Cloud Bigtable input source.
 

.google.cloud.discoveryengine.v1alpha.BigtableSource bigtable_source = 15;

Returns:

Whether the bigtableSource field is set.

getBigtableSource

BigtableSource getBigtableSource()

 Cloud Bigtable input source.
 

.google.cloud.discoveryengine.v1alpha.BigtableSource bigtable_source = 15;

Returns:

The bigtableSource.

getBigtableSourceOrBuilder

BigtableSourceOrBuilder getBigtableSourceOrBuilder()

 Cloud Bigtable input source.
 

.google.cloud.discoveryengine.v1alpha.BigtableSource bigtable_source = 15;

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.v1alpha.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.v1alpha.ImportErrorConfig error_config = 5;

Returns:

The errorConfig.

getErrorConfigOrBuilder

ImportErrorConfigOrBuilder getErrorConfigOrBuilder()

 The desired location of errors incurred during the Import.
 

.google.cloud.discoveryengine.v1alpha.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.v1alpha.ImportDocumentsRequest.ReconciliationMode.INCREMENTAL].
 

.google.cloud.discoveryengine.v1alpha.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.v1alpha.ImportDocumentsRequest.ReconciliationMode.INCREMENTAL].
 

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

Returns:

The reconciliationMode.

hasUpdateMask

boolean hasUpdateMask()

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

.google.protobuf.FieldMask update_mask = 7;

Returns:

Whether the updateMask field is set.

getUpdateMask

com.google.protobuf.FieldMask getUpdateMask()

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

.google.protobuf.FieldMask update_mask = 7;

Returns:

The updateMask.

getUpdateMaskOrBuilder

com.google.protobuf.FieldMaskOrBuilder getUpdateMaskOrBuilder()

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

.google.protobuf.FieldMask update_mask = 7;

getAutoGenerateIds

boolean getAutoGenerateIds()

 Whether to automatically generate IDs for the documents if absent.

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

 Supported data sources:

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

bool auto_generate_ids = 8;

Returns:

The autoGenerateIds.

getIdField

String getIdField()

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

 For [GcsSource][google.cloud.discoveryengine.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.GcsSource].
 [GcsSource.data_schema][google.cloud.discoveryengine.v1alpha.GcsSource.data_schema]
 must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
 * [BigQuerySource][google.cloud.discoveryengine.v1alpha.BigQuerySource].
 [BigQuerySource.data_schema][google.cloud.discoveryengine.v1alpha.BigQuerySource.data_schema]
 must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
 * [SpannerSource][google.cloud.discoveryengine.v1alpha.SpannerSource].
 * [CloudSqlSource][google.cloud.discoveryengine.v1alpha.CloudSqlSource].
 * [FirestoreSource][google.cloud.discoveryengine.v1alpha.FirestoreSource].
 * [BigtableSource][google.cloud.discoveryengine.v1alpha.BigtableSource].
 

string id_field = 9;

Returns:

The idField.

getIdFieldBytes

com.google.protobuf.ByteString getIdFieldBytes()

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

 For [GcsSource][google.cloud.discoveryengine.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.GcsSource].
 [GcsSource.data_schema][google.cloud.discoveryengine.v1alpha.GcsSource.data_schema]
 must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
 * [BigQuerySource][google.cloud.discoveryengine.v1alpha.BigQuerySource].
 [BigQuerySource.data_schema][google.cloud.discoveryengine.v1alpha.BigQuerySource.data_schema]
 must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
 * [SpannerSource][google.cloud.discoveryengine.v1alpha.SpannerSource].
 * [CloudSqlSource][google.cloud.discoveryengine.v1alpha.CloudSqlSource].
 * [FirestoreSource][google.cloud.discoveryengine.v1alpha.FirestoreSource].
 * [BigtableSource][google.cloud.discoveryengine.v1alpha.BigtableSource].
 

string id_field = 9;

Returns:

The bytes for idField.

getSourceCase

ImportDocumentsRequest.SourceCase getSourceCase()