Class ImportDocumentsRequest.Builder (0.39.0) 

public static final class ImportDocumentsRequest.Builder extends GeneratedMessageV3.Builder<ImportDocumentsRequest.Builder> implements ImportDocumentsRequestOrBuilder

Request message for Import methods.

Protobuf type google.cloud.discoveryengine.v1beta.ImportDocumentsRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ImportDocumentsRequest.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ImportDocumentsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ImportDocumentsRequest.Builder
Overrides

build()

public ImportDocumentsRequest build()
Returns
Type Description
ImportDocumentsRequest

buildPartial()

public ImportDocumentsRequest buildPartial()
Returns
Type Description
ImportDocumentsRequest

clear()

public ImportDocumentsRequest.Builder clear()
Returns
Type Description
ImportDocumentsRequest.Builder
Overrides

clearAutoGenerateIds()

public ImportDocumentsRequest.Builder clearAutoGenerateIds()

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.

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.

bool auto_generate_ids = 8;

Returns
Type Description
ImportDocumentsRequest.Builder

This builder for chaining.

clearBigquerySource()

public ImportDocumentsRequest.Builder clearBigquerySource()

BigQuery input source.

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

Returns
Type Description
ImportDocumentsRequest.Builder

clearBigtableSource()

public ImportDocumentsRequest.Builder clearBigtableSource()

Cloud Bigtable input source.

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

Returns
Type Description
ImportDocumentsRequest.Builder

clearCloudSqlSource()

public ImportDocumentsRequest.Builder clearCloudSqlSource()

Cloud SQL input source.

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

Returns
Type Description
ImportDocumentsRequest.Builder

clearErrorConfig()

public ImportDocumentsRequest.Builder clearErrorConfig()

The desired location of errors incurred during the Import.

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

Returns
Type Description
ImportDocumentsRequest.Builder

clearFhirStoreSource()

public ImportDocumentsRequest.Builder clearFhirStoreSource()

FhirStore input source.

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

Returns
Type Description
ImportDocumentsRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public ImportDocumentsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ImportDocumentsRequest.Builder
Overrides

clearFirestoreSource()

public ImportDocumentsRequest.Builder clearFirestoreSource()

Firestore input source.

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

Returns
Type Description
ImportDocumentsRequest.Builder

clearGcsSource()

public ImportDocumentsRequest.Builder clearGcsSource()

Cloud Storage location for the input content.

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

Returns
Type Description
ImportDocumentsRequest.Builder

clearIdField()

public ImportDocumentsRequest.Builder clearIdField()

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.ids. 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.

string id_field = 9;

Returns
Type Description
ImportDocumentsRequest.Builder

This builder for chaining.

clearInlineSource()

public ImportDocumentsRequest.Builder clearInlineSource()

The Inline source for the input content for documents.

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

Returns
Type Description
ImportDocumentsRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public ImportDocumentsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ImportDocumentsRequest.Builder
Overrides

clearParent()

public ImportDocumentsRequest.Builder clearParent()

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
ImportDocumentsRequest.Builder

This builder for chaining.

clearReconciliationMode()

public ImportDocumentsRequest.Builder clearReconciliationMode()

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

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

Returns
Type Description
ImportDocumentsRequest.Builder

This builder for chaining.

clearSource()

public ImportDocumentsRequest.Builder clearSource()
Returns
Type Description
ImportDocumentsRequest.Builder

clearSpannerSource()

public ImportDocumentsRequest.Builder clearSpannerSource()

Spanner input source.

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

Returns
Type Description
ImportDocumentsRequest.Builder

clearUpdateMask()

public ImportDocumentsRequest.Builder clearUpdateMask()

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
Type Description
ImportDocumentsRequest.Builder

clone()

public ImportDocumentsRequest.Builder clone()
Returns
Type Description
ImportDocumentsRequest.Builder
Overrides

getAutoGenerateIds()

public 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.

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.

bool auto_generate_ids = 8;

Returns
Type Description
boolean

The autoGenerateIds.

getBigquerySource()

public BigQuerySource getBigquerySource()

BigQuery input source.

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

Returns
Type Description
BigQuerySource

The bigquerySource.

getBigquerySourceBuilder()

public BigQuerySource.Builder getBigquerySourceBuilder()

BigQuery input source.

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

Returns
Type Description
BigQuerySource.Builder

getBigquerySourceOrBuilder()

public BigQuerySourceOrBuilder getBigquerySourceOrBuilder()

BigQuery input source.

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

Returns
Type Description
BigQuerySourceOrBuilder

getBigtableSource()

public BigtableSource getBigtableSource()

Cloud Bigtable input source.

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

Returns
Type Description
BigtableSource

The bigtableSource.

getBigtableSourceBuilder()

public BigtableSource.Builder getBigtableSourceBuilder()

Cloud Bigtable input source.

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

Returns
Type Description
BigtableSource.Builder

getBigtableSourceOrBuilder()

public BigtableSourceOrBuilder getBigtableSourceOrBuilder()

Cloud Bigtable input source.

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

Returns
Type Description
BigtableSourceOrBuilder

getCloudSqlSource()

public CloudSqlSource getCloudSqlSource()

Cloud SQL input source.

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

Returns
Type Description
CloudSqlSource

The cloudSqlSource.

getCloudSqlSourceBuilder()

public CloudSqlSource.Builder getCloudSqlSourceBuilder()

Cloud SQL input source.

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

Returns
Type Description
CloudSqlSource.Builder

getCloudSqlSourceOrBuilder()

public CloudSqlSourceOrBuilder getCloudSqlSourceOrBuilder()

Cloud SQL input source.

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

Returns
Type Description
CloudSqlSourceOrBuilder

getDefaultInstanceForType()

public ImportDocumentsRequest getDefaultInstanceForType()
Returns
Type Description
ImportDocumentsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getErrorConfig()

public ImportErrorConfig getErrorConfig()

The desired location of errors incurred during the Import.

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

Returns
Type Description
ImportErrorConfig

The errorConfig.

getErrorConfigBuilder()

public ImportErrorConfig.Builder getErrorConfigBuilder()

The desired location of errors incurred during the Import.

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

Returns
Type Description
ImportErrorConfig.Builder

getErrorConfigOrBuilder()

public ImportErrorConfigOrBuilder getErrorConfigOrBuilder()

The desired location of errors incurred during the Import.

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

Returns
Type Description
ImportErrorConfigOrBuilder

getFhirStoreSource()

public FhirStoreSource getFhirStoreSource()

FhirStore input source.

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

Returns
Type Description
FhirStoreSource

The fhirStoreSource.

getFhirStoreSourceBuilder()

public FhirStoreSource.Builder getFhirStoreSourceBuilder()

FhirStore input source.

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

Returns
Type Description
FhirStoreSource.Builder

getFhirStoreSourceOrBuilder()

public FhirStoreSourceOrBuilder getFhirStoreSourceOrBuilder()

FhirStore input source.

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

Returns
Type Description
FhirStoreSourceOrBuilder

getFirestoreSource()

public FirestoreSource getFirestoreSource()

Firestore input source.

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

Returns
Type Description
FirestoreSource

The firestoreSource.

getFirestoreSourceBuilder()

public FirestoreSource.Builder getFirestoreSourceBuilder()

Firestore input source.

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

Returns
Type Description
FirestoreSource.Builder

getFirestoreSourceOrBuilder()

public FirestoreSourceOrBuilder getFirestoreSourceOrBuilder()

Firestore input source.

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

Returns
Type Description
FirestoreSourceOrBuilder

getGcsSource()

public GcsSource getGcsSource()

Cloud Storage location for the input content.

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

Returns
Type Description
GcsSource

The gcsSource.

getGcsSourceBuilder()

public GcsSource.Builder getGcsSourceBuilder()

Cloud Storage location for the input content.

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

Returns
Type Description
GcsSource.Builder

getGcsSourceOrBuilder()

public GcsSourceOrBuilder getGcsSourceOrBuilder()

Cloud Storage location for the input content.

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

Returns
Type Description
GcsSourceOrBuilder

getIdField()

public String 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.ids. 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.

string id_field = 9;

Returns
Type Description
String

The idField.

getIdFieldBytes()

public ByteString getIdFieldBytes()

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.ids. 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.

string id_field = 9;

Returns
Type Description
ByteString

The bytes for idField.

getInlineSource()

public ImportDocumentsRequest.InlineSource getInlineSource()

The Inline source for the input content for documents.

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

Returns
Type Description
ImportDocumentsRequest.InlineSource

The inlineSource.

getInlineSourceBuilder()

public ImportDocumentsRequest.InlineSource.Builder getInlineSourceBuilder()

The Inline source for the input content for documents.

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

Returns
Type Description
ImportDocumentsRequest.InlineSource.Builder

getInlineSourceOrBuilder()

public ImportDocumentsRequest.InlineSourceOrBuilder getInlineSourceOrBuilder()

The Inline source for the input content for documents.

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

Returns
Type Description
ImportDocumentsRequest.InlineSourceOrBuilder

getParent()

public 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 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 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 reconciliation_mode = 6;

Returns
Type Description
ImportDocumentsRequest.ReconciliationMode

The reconciliationMode.

getReconciliationModeValue()

public 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 reconciliation_mode = 6;

Returns
Type Description
int

The enum numeric value on the wire for reconciliationMode.

getSourceCase()

public ImportDocumentsRequest.SourceCase getSourceCase()
Returns
Type Description
ImportDocumentsRequest.SourceCase

getSpannerSource()

public SpannerSource getSpannerSource()

Spanner input source.

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

Returns
Type Description
SpannerSource

The spannerSource.

getSpannerSourceBuilder()

public SpannerSource.Builder getSpannerSourceBuilder()

Spanner input source.

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

Returns
Type Description
SpannerSource.Builder

getSpannerSourceOrBuilder()

public SpannerSourceOrBuilder getSpannerSourceOrBuilder()

Spanner input source.

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

Returns
Type Description
SpannerSourceOrBuilder

getUpdateMask()

public 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
Type Description
FieldMask

The updateMask.

getUpdateMaskBuilder()

public FieldMask.Builder getUpdateMaskBuilder()

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
Type Description
Builder

getUpdateMaskOrBuilder()

public 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;

Returns
Type Description
FieldMaskOrBuilder

hasBigquerySource()

public boolean hasBigquerySource()

BigQuery input source.

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

Returns
Type Description
boolean

Whether the bigquerySource field is set.

hasBigtableSource()

public boolean hasBigtableSource()

Cloud Bigtable input source.

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

Returns
Type Description
boolean

Whether the bigtableSource field is set.

hasCloudSqlSource()

public boolean hasCloudSqlSource()

Cloud SQL input source.

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

Returns
Type Description
boolean

Whether the cloudSqlSource field is set.

hasErrorConfig()

public boolean hasErrorConfig()

The desired location of errors incurred during the Import.

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

Returns
Type Description
boolean

Whether the errorConfig field is set.

hasFhirStoreSource()

public boolean hasFhirStoreSource()

FhirStore input source.

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

Returns
Type Description
boolean

Whether the fhirStoreSource field is set.

hasFirestoreSource()

public boolean hasFirestoreSource()

Firestore input source.

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

Returns
Type Description
boolean

Whether the firestoreSource field is set.

hasGcsSource()

public boolean hasGcsSource()

Cloud Storage location for the input content.

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

Returns
Type Description
boolean

Whether the gcsSource field is set.

hasInlineSource()

public boolean hasInlineSource()

The Inline source for the input content for documents.

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

Returns
Type Description
boolean

Whether the inlineSource field is set.

hasSpannerSource()

public boolean hasSpannerSource()

Spanner input source.

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

Returns
Type Description
boolean

Whether the spannerSource field is set.

hasUpdateMask()

public 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
Type Description
boolean

Whether the updateMask field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeBigquerySource(BigQuerySource value)

public ImportDocumentsRequest.Builder mergeBigquerySource(BigQuerySource value)

BigQuery input source.

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

Parameter
Name Description
value BigQuerySource
Returns
Type Description
ImportDocumentsRequest.Builder

mergeBigtableSource(BigtableSource value)

public ImportDocumentsRequest.Builder mergeBigtableSource(BigtableSource value)

Cloud Bigtable input source.

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

Parameter
Name Description
value BigtableSource
Returns
Type Description
ImportDocumentsRequest.Builder

mergeCloudSqlSource(CloudSqlSource value)

public ImportDocumentsRequest.Builder mergeCloudSqlSource(CloudSqlSource value)

Cloud SQL input source.

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

Parameter
Name Description
value CloudSqlSource
Returns
Type Description
ImportDocumentsRequest.Builder

mergeErrorConfig(ImportErrorConfig value)

public ImportDocumentsRequest.Builder mergeErrorConfig(ImportErrorConfig value)

The desired location of errors incurred during the Import.

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

Parameter
Name Description
value ImportErrorConfig
Returns
Type Description
ImportDocumentsRequest.Builder

mergeFhirStoreSource(FhirStoreSource value)

public ImportDocumentsRequest.Builder mergeFhirStoreSource(FhirStoreSource value)

FhirStore input source.

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

Parameter
Name Description
value FhirStoreSource
Returns
Type Description
ImportDocumentsRequest.Builder

mergeFirestoreSource(FirestoreSource value)

public ImportDocumentsRequest.Builder mergeFirestoreSource(FirestoreSource value)

Firestore input source.

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

Parameter
Name Description
value FirestoreSource
Returns
Type Description
ImportDocumentsRequest.Builder

mergeFrom(ImportDocumentsRequest other)

public ImportDocumentsRequest.Builder mergeFrom(ImportDocumentsRequest other)
Parameter
Name Description
other ImportDocumentsRequest
Returns
Type Description
ImportDocumentsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ImportDocumentsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ImportDocumentsRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ImportDocumentsRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ImportDocumentsRequest.Builder
Overrides

mergeGcsSource(GcsSource value)

public ImportDocumentsRequest.Builder mergeGcsSource(GcsSource value)

Cloud Storage location for the input content.

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

Parameter
Name Description
value GcsSource
Returns
Type Description
ImportDocumentsRequest.Builder

mergeInlineSource(ImportDocumentsRequest.InlineSource value)

public ImportDocumentsRequest.Builder mergeInlineSource(ImportDocumentsRequest.InlineSource value)

The Inline source for the input content for documents.

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

Parameter
Name Description
value ImportDocumentsRequest.InlineSource
Returns
Type Description
ImportDocumentsRequest.Builder

mergeSpannerSource(SpannerSource value)

public ImportDocumentsRequest.Builder mergeSpannerSource(SpannerSource value)

Spanner input source.

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

Parameter
Name Description
value SpannerSource
Returns
Type Description
ImportDocumentsRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ImportDocumentsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ImportDocumentsRequest.Builder
Overrides

mergeUpdateMask(FieldMask value)

public ImportDocumentsRequest.Builder mergeUpdateMask(FieldMask value)

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;

Parameter
Name Description
value FieldMask
Returns
Type Description
ImportDocumentsRequest.Builder

setAutoGenerateIds(boolean value)

public ImportDocumentsRequest.Builder setAutoGenerateIds(boolean value)

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.

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.

bool auto_generate_ids = 8;

Parameter
Name Description
value boolean

The autoGenerateIds to set.
Returns
Type Description
ImportDocumentsRequest.Builder

This builder for chaining.

setBigquerySource(BigQuerySource value)

public ImportDocumentsRequest.Builder setBigquerySource(BigQuerySource value)

BigQuery input source.

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

Parameter
Name Description
value BigQuerySource
Returns
Type Description
ImportDocumentsRequest.Builder

setBigquerySource(BigQuerySource.Builder builderForValue)

public ImportDocumentsRequest.Builder setBigquerySource(BigQuerySource.Builder builderForValue)

BigQuery input source.

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

Parameter
Name Description
builderForValue BigQuerySource.Builder
Returns
Type Description
ImportDocumentsRequest.Builder

setBigtableSource(BigtableSource value)

public ImportDocumentsRequest.Builder setBigtableSource(BigtableSource value)

Cloud Bigtable input source.

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

Parameter
Name Description
value BigtableSource
Returns
Type Description
ImportDocumentsRequest.Builder

setBigtableSource(BigtableSource.Builder builderForValue)

public ImportDocumentsRequest.Builder setBigtableSource(BigtableSource.Builder builderForValue)

Cloud Bigtable input source.

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

Parameter
Name Description
builderForValue BigtableSource.Builder
Returns
Type Description
ImportDocumentsRequest.Builder

setCloudSqlSource(CloudSqlSource value)

public ImportDocumentsRequest.Builder setCloudSqlSource(CloudSqlSource value)

Cloud SQL input source.

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

Parameter
Name Description
value CloudSqlSource
Returns
Type Description
ImportDocumentsRequest.Builder

setCloudSqlSource(CloudSqlSource.Builder builderForValue)

public ImportDocumentsRequest.Builder setCloudSqlSource(CloudSqlSource.Builder builderForValue)

Cloud SQL input source.

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

Parameter
Name Description
builderForValue CloudSqlSource.Builder
Returns
Type Description
ImportDocumentsRequest.Builder

setErrorConfig(ImportErrorConfig value)

public ImportDocumentsRequest.Builder setErrorConfig(ImportErrorConfig value)

The desired location of errors incurred during the Import.

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

Parameter
Name Description
value ImportErrorConfig
Returns
Type Description
ImportDocumentsRequest.Builder

setErrorConfig(ImportErrorConfig.Builder builderForValue)

public ImportDocumentsRequest.Builder setErrorConfig(ImportErrorConfig.Builder builderForValue)

The desired location of errors incurred during the Import.

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

Parameter
Name Description
builderForValue ImportErrorConfig.Builder
Returns
Type Description
ImportDocumentsRequest.Builder

setFhirStoreSource(FhirStoreSource value)

public ImportDocumentsRequest.Builder setFhirStoreSource(FhirStoreSource value)

FhirStore input source.

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

Parameter
Name Description
value FhirStoreSource
Returns
Type Description
ImportDocumentsRequest.Builder

setFhirStoreSource(FhirStoreSource.Builder builderForValue)

public ImportDocumentsRequest.Builder setFhirStoreSource(FhirStoreSource.Builder builderForValue)

FhirStore input source.

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

Parameter
Name Description
builderForValue FhirStoreSource.Builder
Returns
Type Description
ImportDocumentsRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ImportDocumentsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ImportDocumentsRequest.Builder
Overrides

setFirestoreSource(FirestoreSource value)

public ImportDocumentsRequest.Builder setFirestoreSource(FirestoreSource value)

Firestore input source.

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

Parameter
Name Description
value FirestoreSource
Returns
Type Description
ImportDocumentsRequest.Builder

setFirestoreSource(FirestoreSource.Builder builderForValue)

public ImportDocumentsRequest.Builder setFirestoreSource(FirestoreSource.Builder builderForValue)

Firestore input source.

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

Parameter
Name Description
builderForValue FirestoreSource.Builder
Returns
Type Description
ImportDocumentsRequest.Builder

setGcsSource(GcsSource value)

public ImportDocumentsRequest.Builder setGcsSource(GcsSource value)

Cloud Storage location for the input content.

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

Parameter
Name Description
value GcsSource
Returns
Type Description
ImportDocumentsRequest.Builder

setGcsSource(GcsSource.Builder builderForValue)

public ImportDocumentsRequest.Builder setGcsSource(GcsSource.Builder builderForValue)

Cloud Storage location for the input content.

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

Parameter
Name Description
builderForValue GcsSource.Builder
Returns
Type Description
ImportDocumentsRequest.Builder

setIdField(String value)

public ImportDocumentsRequest.Builder setIdField(String value)

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.ids. 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.

string id_field = 9;

Parameter
Name Description
value String

The idField to set.
Returns
Type Description
ImportDocumentsRequest.Builder

This builder for chaining.

setIdFieldBytes(ByteString value)

public ImportDocumentsRequest.Builder setIdFieldBytes(ByteString value)

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.ids. 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.

string id_field = 9;

Parameter
Name Description
value ByteString

The bytes for idField to set.
Returns
Type Description
ImportDocumentsRequest.Builder

This builder for chaining.

setInlineSource(ImportDocumentsRequest.InlineSource value)

public ImportDocumentsRequest.Builder setInlineSource(ImportDocumentsRequest.InlineSource value)

The Inline source for the input content for documents.

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

Parameter
Name Description
value ImportDocumentsRequest.InlineSource
Returns
Type Description
ImportDocumentsRequest.Builder

setInlineSource(ImportDocumentsRequest.InlineSource.Builder builderForValue)

public ImportDocumentsRequest.Builder setInlineSource(ImportDocumentsRequest.InlineSource.Builder builderForValue)

The Inline source for the input content for documents.

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

Parameter
Name Description
builderForValue ImportDocumentsRequest.InlineSource.Builder
Returns
Type Description
ImportDocumentsRequest.Builder

setParent(String value)

public ImportDocumentsRequest.Builder setParent(String value)

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) = { ... }

Parameter
Name Description
value String

The parent to set.
Returns
Type Description
ImportDocumentsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ImportDocumentsRequest.Builder setParentBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.
Returns
Type Description
ImportDocumentsRequest.Builder

This builder for chaining.

setReconciliationMode(ImportDocumentsRequest.ReconciliationMode value)

public ImportDocumentsRequest.Builder setReconciliationMode(ImportDocumentsRequest.ReconciliationMode value)

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

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

Parameter
Name Description
value ImportDocumentsRequest.ReconciliationMode

The reconciliationMode to set.
Returns
Type Description
ImportDocumentsRequest.Builder

This builder for chaining.

setReconciliationModeValue(int value)

public ImportDocumentsRequest.Builder setReconciliationModeValue(int value)

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

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

Parameter
Name Description
value int

The enum numeric value on the wire for reconciliationMode to set.
Returns
Type Description
ImportDocumentsRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ImportDocumentsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ImportDocumentsRequest.Builder
Overrides

setSpannerSource(SpannerSource value)

public ImportDocumentsRequest.Builder setSpannerSource(SpannerSource value)

Spanner input source.

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

Parameter
Name Description
value SpannerSource
Returns
Type Description
ImportDocumentsRequest.Builder

setSpannerSource(SpannerSource.Builder builderForValue)

public ImportDocumentsRequest.Builder setSpannerSource(SpannerSource.Builder builderForValue)

Spanner input source.

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

Parameter
Name Description
builderForValue SpannerSource.Builder
Returns
Type Description
ImportDocumentsRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final ImportDocumentsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ImportDocumentsRequest.Builder
Overrides

setUpdateMask(FieldMask value)

public ImportDocumentsRequest.Builder setUpdateMask(FieldMask value)

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;

Parameter
Name Description
value FieldMask
Returns
Type Description
ImportDocumentsRequest.Builder

setUpdateMask(FieldMask.Builder builderForValue)

public ImportDocumentsRequest.Builder setUpdateMask(FieldMask.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ImportDocumentsRequest.Builder