public final class ImportDocumentsRequest extends com.google.protobuf.GeneratedMessageV3 implements ImportDocumentsRequestOrBuilder
Request message for Import methods.Protobuf type
google.cloud.discoveryengine.v1beta.ImportDocumentsRequest| Modifier and Type | Class and Description |
|---|---|
static class |
ImportDocumentsRequest.Builder
Request message for Import methods.
|
static class |
ImportDocumentsRequest.InlineSource
The inline source for the input config for ImportDocuments method.
|
static interface |
ImportDocumentsRequest.InlineSourceOrBuilder |
static class |
ImportDocumentsRequest.ReconciliationMode
Indicates how imported documents are reconciled with the existing documents
created or imported before.
|
static class |
ImportDocumentsRequest.SourceCase |
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter| Modifier and Type | Field and Description |
|---|---|
static int |
AUTO_GENERATE_IDS_FIELD_NUMBER |
static int |
BIGQUERY_SOURCE_FIELD_NUMBER |
static int |
ERROR_CONFIG_FIELD_NUMBER |
static int |
GCS_SOURCE_FIELD_NUMBER |
static int |
ID_FIELD_FIELD_NUMBER |
static int |
INLINE_SOURCE_FIELD_NUMBER |
static int |
PARENT_FIELD_NUMBER |
static int |
RECONCILIATION_MODE_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
boolean |
getAutoGenerateIds()
Whether to automatically generate IDs for the documents if absent.
|
BigQuerySource |
getBigquerySource()
BigQuery input source.
|
BigQuerySourceOrBuilder |
getBigquerySourceOrBuilder()
BigQuery input source.
|
static ImportDocumentsRequest |
getDefaultInstance() |
ImportDocumentsRequest |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
ImportErrorConfig |
getErrorConfig()
The desired location of errors incurred during the Import.
|
ImportErrorConfigOrBuilder |
getErrorConfigOrBuilder()
The desired location of errors incurred during the Import.
|
GcsSource |
getGcsSource()
Cloud Storage location for the input content.
|
GcsSourceOrBuilder |
getGcsSourceOrBuilder()
Cloud Storage location for the input content.
|
String |
getIdField()
The field in the Cloud Storage and BigQuery sources that indicates the
unique IDs of the documents.
|
com.google.protobuf.ByteString |
getIdFieldBytes()
The field in the Cloud Storage and BigQuery sources that indicates the
unique IDs of the documents.
|
ImportDocumentsRequest.InlineSource |
getInlineSource()
The Inline source for the input content for documents.
|
ImportDocumentsRequest.InlineSourceOrBuilder |
getInlineSourceOrBuilder()
The Inline source for the input content for documents.
|
String |
getParent()
Required.
|
com.google.protobuf.ByteString |
getParentBytes()
Required.
|
com.google.protobuf.Parser<ImportDocumentsRequest> |
getParserForType() |
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.
|
int |
getSerializedSize() |
ImportDocumentsRequest.SourceCase |
getSourceCase() |
boolean |
hasBigquerySource()
BigQuery input source.
|
boolean |
hasErrorConfig()
The desired location of errors incurred during the Import.
|
boolean |
hasGcsSource()
Cloud Storage location for the input content.
|
int |
hashCode() |
boolean |
hasInlineSource()
The Inline source for the input content for documents.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static ImportDocumentsRequest.Builder |
newBuilder() |
static ImportDocumentsRequest.Builder |
newBuilder(ImportDocumentsRequest prototype) |
ImportDocumentsRequest.Builder |
newBuilderForType() |
protected ImportDocumentsRequest.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static ImportDocumentsRequest |
parseDelimitedFrom(InputStream input) |
static ImportDocumentsRequest |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ImportDocumentsRequest |
parseFrom(byte[] data) |
static ImportDocumentsRequest |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ImportDocumentsRequest |
parseFrom(ByteBuffer data) |
static ImportDocumentsRequest |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ImportDocumentsRequest |
parseFrom(com.google.protobuf.ByteString data) |
static ImportDocumentsRequest |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ImportDocumentsRequest |
parseFrom(com.google.protobuf.CodedInputStream input) |
static ImportDocumentsRequest |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static ImportDocumentsRequest |
parseFrom(InputStream input) |
static ImportDocumentsRequest |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<ImportDocumentsRequest> |
parser() |
ImportDocumentsRequest.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int INLINE_SOURCE_FIELD_NUMBER
public static final int GCS_SOURCE_FIELD_NUMBER
public static final int BIGQUERY_SOURCE_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
public static final int ERROR_CONFIG_FIELD_NUMBER
public static final int RECONCILIATION_MODE_FIELD_NUMBER
public static final int AUTO_GENERATE_IDS_FIELD_NUMBER
public static final int ID_FIELD_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public ImportDocumentsRequest.SourceCase getSourceCase()
getSourceCase in interface ImportDocumentsRequestOrBuilderpublic boolean hasInlineSource()
The Inline source for the input content for documents.
.google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.InlineSource inline_source = 2;
hasInlineSource in interface ImportDocumentsRequestOrBuilderpublic ImportDocumentsRequest.InlineSource getInlineSource()
The Inline source for the input content for documents.
.google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.InlineSource inline_source = 2;
getInlineSource in interface ImportDocumentsRequestOrBuilderpublic ImportDocumentsRequest.InlineSourceOrBuilder getInlineSourceOrBuilder()
The Inline source for the input content for documents.
.google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.InlineSource inline_source = 2;
getInlineSourceOrBuilder in interface ImportDocumentsRequestOrBuilderpublic boolean hasGcsSource()
Cloud Storage location for the input content.
.google.cloud.discoveryengine.v1beta.GcsSource gcs_source = 3;hasGcsSource in interface ImportDocumentsRequestOrBuilderpublic GcsSource getGcsSource()
Cloud Storage location for the input content.
.google.cloud.discoveryengine.v1beta.GcsSource gcs_source = 3;getGcsSource in interface ImportDocumentsRequestOrBuilderpublic GcsSourceOrBuilder getGcsSourceOrBuilder()
Cloud Storage location for the input content.
.google.cloud.discoveryengine.v1beta.GcsSource gcs_source = 3;getGcsSourceOrBuilder in interface ImportDocumentsRequestOrBuilderpublic boolean hasBigquerySource()
BigQuery input source.
.google.cloud.discoveryengine.v1beta.BigQuerySource bigquery_source = 4;hasBigquerySource in interface ImportDocumentsRequestOrBuilderpublic BigQuerySource getBigquerySource()
BigQuery input source.
.google.cloud.discoveryengine.v1beta.BigQuerySource bigquery_source = 4;getBigquerySource in interface ImportDocumentsRequestOrBuilderpublic BigQuerySourceOrBuilder getBigquerySourceOrBuilder()
BigQuery input source.
.google.cloud.discoveryengine.v1beta.BigQuerySource bigquery_source = 4;getBigquerySourceOrBuilder in interface ImportDocumentsRequestOrBuilderpublic 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) = { ... }
getParent in interface ImportDocumentsRequestOrBuilderpublic 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) = { ... }
getParentBytes in interface ImportDocumentsRequestOrBuilderpublic boolean hasErrorConfig()
The desired location of errors incurred during the Import.
.google.cloud.discoveryengine.v1beta.ImportErrorConfig error_config = 5;hasErrorConfig in interface ImportDocumentsRequestOrBuilderpublic ImportErrorConfig getErrorConfig()
The desired location of errors incurred during the Import.
.google.cloud.discoveryengine.v1beta.ImportErrorConfig error_config = 5;getErrorConfig in interface ImportDocumentsRequestOrBuilderpublic ImportErrorConfigOrBuilder getErrorConfigOrBuilder()
The desired location of errors incurred during the Import.
.google.cloud.discoveryengine.v1beta.ImportErrorConfig error_config = 5;getErrorConfigOrBuilder in interface ImportDocumentsRequestOrBuilderpublic int getReconciliationModeValue()
The mode of reconciliation between existing documents and the documents to be imported. Defaults to [ReconciliationMode.INCREMENTAL][google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.ReconciliationMode.INCREMENTAL].
.google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.ReconciliationMode reconciliation_mode = 6;
getReconciliationModeValue in interface ImportDocumentsRequestOrBuilderpublic ImportDocumentsRequest.ReconciliationMode getReconciliationMode()
The mode of reconciliation between existing documents and the documents to be imported. Defaults to [ReconciliationMode.INCREMENTAL][google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.ReconciliationMode.INCREMENTAL].
.google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.ReconciliationMode reconciliation_mode = 6;
getReconciliationMode in interface ImportDocumentsRequestOrBuilderpublic boolean getAutoGenerateIds()
Whether to automatically generate IDs for the documents if absent. If set to `true`, [Document.id][google.cloud.discoveryengine.v1beta.Document.id]s are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case [ReconciliationMode.FULL][google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.ReconciliationMode.FULL] is highly recommended to avoid duplicate contents. If unset or set to `false`, [Document.id][google.cloud.discoveryengine.v1beta.Document.id]s have to be specified using [id_field][google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.id_field], otherwise, documents without IDs fail to be imported. Only set this field when using [GcsSource][google.cloud.discoveryengine.v1beta.GcsSource] or [BigQuerySource][google.cloud.discoveryengine.v1beta.BigQuerySource], and when [GcsSource.data_schema][google.cloud.discoveryengine.v1beta.GcsSource.data_schema] or [BigQuerySource.data_schema][google.cloud.discoveryengine.v1beta.BigQuerySource.data_schema] is `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
bool auto_generate_ids = 8;getAutoGenerateIds in interface ImportDocumentsRequestOrBuilderpublic String getIdField()
The field in the Cloud Storage and BigQuery sources that indicates the
unique IDs of the documents.
For [GcsSource][google.cloud.discoveryengine.v1beta.GcsSource] it is the
key of the JSON field. For instance, `my_id` for JSON `{"my_id":
"some_uuid"}`. For
[BigQuerySource][google.cloud.discoveryengine.v1beta.BigQuerySource] it is
the column name of the BigQuery table where the unique ids are stored.
The values of the JSON field or the BigQuery column are used as the
[Document.id][google.cloud.discoveryengine.v1beta.Document.id]s. The JSON
field or the BigQuery column must be of string type, and the values must be
set as valid strings conform to
[RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters.
Otherwise, documents without valid IDs fail to be imported.
Only set this field when using
[GcsSource][google.cloud.discoveryengine.v1beta.GcsSource] or
[BigQuerySource][google.cloud.discoveryengine.v1beta.BigQuerySource], and
when
[GcsSource.data_schema][google.cloud.discoveryengine.v1beta.GcsSource.data_schema]
or
[BigQuerySource.data_schema][google.cloud.discoveryengine.v1beta.BigQuerySource.data_schema]
is `custom`. And only set this field when
[auto_generate_ids][google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.auto_generate_ids]
is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown.
If it is unset, a default value `_id` is used when importing from the
allowed data sources.
string id_field = 9;getIdField in interface ImportDocumentsRequestOrBuilderpublic com.google.protobuf.ByteString getIdFieldBytes()
The field in the Cloud Storage and BigQuery sources that indicates the
unique IDs of the documents.
For [GcsSource][google.cloud.discoveryengine.v1beta.GcsSource] it is the
key of the JSON field. For instance, `my_id` for JSON `{"my_id":
"some_uuid"}`. For
[BigQuerySource][google.cloud.discoveryengine.v1beta.BigQuerySource] it is
the column name of the BigQuery table where the unique ids are stored.
The values of the JSON field or the BigQuery column are used as the
[Document.id][google.cloud.discoveryengine.v1beta.Document.id]s. The JSON
field or the BigQuery column must be of string type, and the values must be
set as valid strings conform to
[RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters.
Otherwise, documents without valid IDs fail to be imported.
Only set this field when using
[GcsSource][google.cloud.discoveryengine.v1beta.GcsSource] or
[BigQuerySource][google.cloud.discoveryengine.v1beta.BigQuerySource], and
when
[GcsSource.data_schema][google.cloud.discoveryengine.v1beta.GcsSource.data_schema]
or
[BigQuerySource.data_schema][google.cloud.discoveryengine.v1beta.BigQuerySource.data_schema]
is `custom`. And only set this field when
[auto_generate_ids][google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.auto_generate_ids]
is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown.
If it is unset, a default value `_id` is used when importing from the
allowed data sources.
string id_field = 9;getIdFieldBytes in interface ImportDocumentsRequestOrBuilderpublic final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static ImportDocumentsRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ImportDocumentsRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ImportDocumentsRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ImportDocumentsRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ImportDocumentsRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ImportDocumentsRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static ImportDocumentsRequest parseFrom(InputStream input) throws IOException
IOExceptionpublic static ImportDocumentsRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ImportDocumentsRequest parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static ImportDocumentsRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static ImportDocumentsRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static ImportDocumentsRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic ImportDocumentsRequest.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static ImportDocumentsRequest.Builder newBuilder()
public static ImportDocumentsRequest.Builder newBuilder(ImportDocumentsRequest prototype)
public ImportDocumentsRequest.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected ImportDocumentsRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static ImportDocumentsRequest getDefaultInstance()
public static com.google.protobuf.Parser<ImportDocumentsRequest> parser()
public com.google.protobuf.Parser<ImportDocumentsRequest> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public ImportDocumentsRequest getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2024 Google LLC. All rights reserved.