- 0.56.0 (latest)
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 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 static final class ImportDocumentsRequest.Builder extends GeneratedMessageV3.Builder<ImportDocumentsRequest.Builder> implements ImportDocumentsRequestOrBuilderRequest message for Import methods.
Protobuf type google.cloud.discoveryengine.v1.ImportDocumentsRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ImportDocumentsRequest.BuilderImplements
ImportDocumentsRequestOrBuilderStatic 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 |
|
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 |
|
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.
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 |
ImportDocumentsRequest.Builder |
This builder for chaining. |
clearBigquerySource()
public ImportDocumentsRequest.Builder clearBigquerySource()BigQuery input source.
.google.cloud.discoveryengine.v1.BigQuerySource bigquery_source = 4;
| Returns | |
|---|---|
| Type | Description |
ImportDocumentsRequest.Builder |
|
clearErrorConfig()
public ImportDocumentsRequest.Builder clearErrorConfig()The desired location of errors incurred during the Import.
.google.cloud.discoveryengine.v1.ImportErrorConfig error_config = 5;
| 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 |
|
clearGcsSource()
public ImportDocumentsRequest.Builder clearGcsSource()Cloud Storage location for the input content.
.google.cloud.discoveryengine.v1.GcsSource gcs_source = 3;
| Returns | |
|---|---|
| Type | Description |
ImportDocumentsRequest.Builder |
|
clearIdField()
public ImportDocumentsRequest.Builder clearIdField()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 |
ImportDocumentsRequest.Builder |
This builder for chaining. |
clearInlineSource()
public ImportDocumentsRequest.Builder clearInlineSource()The Inline source for the input content for documents.
.google.cloud.discoveryengine.v1.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 |
|
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.v1.ImportDocumentsRequest.ReconciliationMode reconciliation_mode = 6;
| Returns | |
|---|---|
| Type | Description |
ImportDocumentsRequest.Builder |
This builder for chaining. |
clearSource()
public ImportDocumentsRequest.Builder clearSource()| Returns | |
|---|---|
| Type | Description |
ImportDocumentsRequest.Builder |
|
clone()
public ImportDocumentsRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
ImportDocumentsRequest.Builder |
|
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.
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 BigQuerySource getBigquerySource()BigQuery input source.
.google.cloud.discoveryengine.v1.BigQuerySource bigquery_source = 4;
| Returns | |
|---|---|
| Type | Description |
BigQuerySource |
The bigquerySource. |
getBigquerySourceBuilder()
public BigQuerySource.Builder getBigquerySourceBuilder()BigQuery input source.
.google.cloud.discoveryengine.v1.BigQuerySource bigquery_source = 4;
| Returns | |
|---|---|
| Type | Description |
BigQuerySource.Builder |
|
getBigquerySourceOrBuilder()
public BigQuerySourceOrBuilder getBigquerySourceOrBuilder()BigQuery input source.
.google.cloud.discoveryengine.v1.BigQuerySource bigquery_source = 4;
| Returns | |
|---|---|
| Type | Description |
BigQuerySourceOrBuilder |
|
getDefaultInstanceForType()
public ImportDocumentsRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ImportDocumentsRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getErrorConfig()
public ImportErrorConfig getErrorConfig()The desired location of errors incurred during the Import.
.google.cloud.discoveryengine.v1.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.v1.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.v1.ImportErrorConfig error_config = 5;
| Returns | |
|---|---|
| Type | Description |
ImportErrorConfigOrBuilder |
|
getGcsSource()
public GcsSource getGcsSource()Cloud Storage location for the input content.
.google.cloud.discoveryengine.v1.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.v1.GcsSource gcs_source = 3;
| Returns | |
|---|---|
| Type | Description |
GcsSource.Builder |
|
getGcsSourceOrBuilder()
public GcsSourceOrBuilder getGcsSourceOrBuilder()Cloud Storage location for the input content.
.google.cloud.discoveryengine.v1.GcsSource gcs_source = 3;
| Returns | |
|---|---|
| Type | Description |
GcsSourceOrBuilder |
|
getIdField()
public 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 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 ImportDocumentsRequest.InlineSource getInlineSource()The Inline source for the input content for documents.
.google.cloud.discoveryengine.v1.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.v1.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.v1.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.v1.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.v1.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 |
|
hasBigquerySource()
public boolean hasBigquerySource()BigQuery input source.
.google.cloud.discoveryengine.v1.BigQuerySource bigquery_source = 4;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the bigquerySource field is set. |
hasErrorConfig()
public boolean hasErrorConfig()The desired location of errors incurred during the Import.
.google.cloud.discoveryengine.v1.ImportErrorConfig error_config = 5;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the errorConfig field is set. |
hasGcsSource()
public boolean hasGcsSource()Cloud Storage location for the input content.
.google.cloud.discoveryengine.v1.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.v1.ImportDocumentsRequest.InlineSource inline_source = 2;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the inlineSource field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeBigquerySource(BigQuerySource value)
public ImportDocumentsRequest.Builder mergeBigquerySource(BigQuerySource value)BigQuery input source.
.google.cloud.discoveryengine.v1.BigQuerySource bigquery_source = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
BigQuerySource |
| 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.v1.ImportErrorConfig error_config = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
ImportErrorConfig |
| 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 |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ImportDocumentsRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ImportDocumentsRequest.Builder |
|
mergeGcsSource(GcsSource value)
public ImportDocumentsRequest.Builder mergeGcsSource(GcsSource value)Cloud Storage location for the input content.
.google.cloud.discoveryengine.v1.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.v1.ImportDocumentsRequest.InlineSource inline_source = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
ImportDocumentsRequest.InlineSource |
| 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 |
|
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.
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;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe 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.v1.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.v1.BigQuerySource bigquery_source = 4;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
BigQuerySource.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.v1.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.v1.ImportErrorConfig error_config = 5;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ImportErrorConfig.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 |
|
setGcsSource(GcsSource value)
public ImportDocumentsRequest.Builder setGcsSource(GcsSource value)Cloud Storage location for the input content.
.google.cloud.discoveryengine.v1.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.v1.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 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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe idField to set. |
| Returns | |
|---|---|
| Type | Description |
ImportDocumentsRequest.Builder |
This builder for chaining. |
setIdFieldBytes(ByteString value)
public ImportDocumentsRequest.Builder setIdFieldBytes(ByteString value)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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe 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.v1.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.v1.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 |
StringThe 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 |
ByteStringThe 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.v1.ImportDocumentsRequest.ReconciliationMode reconciliation_mode = 6;
| Parameter | |
|---|---|
| Name | Description |
value |
ImportDocumentsRequest.ReconciliationModeThe 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.v1.ImportDocumentsRequest.ReconciliationMode reconciliation_mode = 6;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe 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 |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final ImportDocumentsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ImportDocumentsRequest.Builder |
|