public final class ImportDocumentsRequest extends GeneratedMessageV3 implements ImportDocumentsRequestOrBuilder
Request message for Import methods.
Protobuf type google.cloud.discoveryengine.v1.ImportDocumentsRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
AUTO_GENERATE_IDS_FIELD_NUMBER
public static final int AUTO_GENERATE_IDS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
BIGQUERY_SOURCE_FIELD_NUMBER
public static final int BIGQUERY_SOURCE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ERROR_CONFIG_FIELD_NUMBER
public static final int ERROR_CONFIG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
GCS_SOURCE_FIELD_NUMBER
public static final int GCS_SOURCE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ID_FIELD_FIELD_NUMBER
public static final int ID_FIELD_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
INLINE_SOURCE_FIELD_NUMBER
public static final int INLINE_SOURCE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
RECONCILIATION_MODE_FIELD_NUMBER
public static final int RECONCILIATION_MODE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static ImportDocumentsRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ImportDocumentsRequest.Builder newBuilder()
newBuilder(ImportDocumentsRequest prototype)
public static ImportDocumentsRequest.Builder newBuilder(ImportDocumentsRequest prototype)
public static ImportDocumentsRequest parseDelimitedFrom(InputStream input)
public static ImportDocumentsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ImportDocumentsRequest parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ImportDocumentsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ImportDocumentsRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ImportDocumentsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ImportDocumentsRequest parseFrom(CodedInputStream input)
public static ImportDocumentsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ImportDocumentsRequest parseFrom(InputStream input)
public static ImportDocumentsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ImportDocumentsRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ImportDocumentsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ImportDocumentsRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
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,
otherwises, documents without IDs will fail to be imported.
Only set this field when using
GcsSource or
BigQuerySource, and when
GcsSource.data_schema
or
BigQuerySource.data_schema
is custom. 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;
getBigquerySourceOrBuilder()
public BigQuerySourceOrBuilder getBigquerySourceOrBuilder()
BigQuery input source.
.google.cloud.discoveryengine.v1.BigQuerySource bigquery_source = 4;
getDefaultInstanceForType()
public ImportDocumentsRequest getDefaultInstanceForType()
getErrorConfig()
public ImportErrorConfig getErrorConfig()
The desired location of errors incurred during the Import.
.google.cloud.discoveryengine.v1.ImportErrorConfig error_config = 5;
getErrorConfigOrBuilder()
public ImportErrorConfigOrBuilder getErrorConfigOrBuilder()
The desired location of errors incurred during the Import.
.google.cloud.discoveryengine.v1.ImportErrorConfig error_config = 5;
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.
|
getGcsSourceOrBuilder()
public GcsSourceOrBuilder getGcsSourceOrBuilder()
Cloud Storage location for the input content.
.google.cloud.discoveryengine.v1.GcsSource gcs_source = 3;
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 will be 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 will 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 will be 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 will 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;
getInlineSourceOrBuilder()
public ImportDocumentsRequest.InlineSourceOrBuilder getInlineSourceOrBuilder()
The Inline source for the input content for documents.
.google.cloud.discoveryengine.v1.ImportDocumentsRequest.InlineSource inline_source = 2;
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.
|
getParserForType()
public Parser<ImportDocumentsRequest> getParserForType()
Overrides
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;
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.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getSourceCase()
public ImportDocumentsRequest.SourceCase getSourceCase()
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.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ImportDocumentsRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ImportDocumentsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public ImportDocumentsRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
