Class ImportDocumentsRequest
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.discoveryengine.v1beta.ImportDocumentsRequest
- All Implemented Interfaces:
ImportDocumentsRequestOrBuilder,com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Serializable
@Generated
public final class ImportDocumentsRequest
extends com.google.protobuf.GeneratedMessage
implements ImportDocumentsRequestOrBuilder
Request message for Import methods.Protobuf type
google.cloud.discoveryengine.v1beta.ImportDocumentsRequest- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classRequest message for Import methods.static final classThe inline source for the input config for ImportDocuments method.static interfacestatic enumIndicates how imported documents are reconciled with the existing documents created or imported before.static enumNested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage
com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message, T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage
com.google.protobuf.AbstractMessage.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanAlloyDB input source.AlloyDB input source.booleanWhether to automatically generate IDs for the documents if absent.BigQuery input source.BigQuery input source.Cloud Bigtable input source.Cloud Bigtable input source.Cloud SQL input source.Cloud SQL input source.static ImportDocumentsRequeststatic final com.google.protobuf.Descriptors.DescriptorThe desired location of errors incurred during the Import.The desired location of errors incurred during the Import.FhirStore input source.FhirStore input source.Firestore input source.Firestore input source.Cloud Storage location for the input content.Cloud Storage location for the input content.The field indicates the ID field or column to be used as unique IDs of the documents.com.google.protobuf.ByteStringThe field indicates the ID field or column to be used as unique IDs of the documents.The Inline source for the input content for documents.The Inline source for the input content for documents.Required.com.google.protobuf.ByteStringRequired.com.google.protobuf.Parser<ImportDocumentsRequest>The mode of reconciliation between existing documents and the documents to be imported.intThe mode of reconciliation between existing documents and the documents to be imported.intSpanner input source.Spanner input source.com.google.protobuf.FieldMaskIndicates which fields in the provided imported documents to update.com.google.protobuf.FieldMaskOrBuilderIndicates which fields in the provided imported documents to update.booleanAlloyDB input source.booleanBigQuery input source.booleanCloud Bigtable input source.booleanCloud SQL input source.booleanThe desired location of errors incurred during the Import.booleanFhirStore input source.booleanFirestore input source.booleanCloud Storage location for the input content.inthashCode()booleanThe Inline source for the input content for documents.booleanSpanner input source.booleanIndicates which fields in the provided imported documents to update.protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleannewBuilder(ImportDocumentsRequest prototype) protected ImportDocumentsRequest.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) static ImportDocumentsRequestparseDelimitedFrom(InputStream input) static ImportDocumentsRequestparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ImportDocumentsRequestparseFrom(byte[] data) static ImportDocumentsRequestparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ImportDocumentsRequestparseFrom(com.google.protobuf.ByteString data) static ImportDocumentsRequestparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ImportDocumentsRequestparseFrom(com.google.protobuf.CodedInputStream input) static ImportDocumentsRequestparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ImportDocumentsRequestparseFrom(InputStream input) static ImportDocumentsRequestparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ImportDocumentsRequestparseFrom(ByteBuffer data) static ImportDocumentsRequestparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<ImportDocumentsRequest>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessage
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, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
INLINE_SOURCE_FIELD_NUMBER
public static final int INLINE_SOURCE_FIELD_NUMBER- See Also:
-
GCS_SOURCE_FIELD_NUMBER
public static final int GCS_SOURCE_FIELD_NUMBER- See Also:
-
BIGQUERY_SOURCE_FIELD_NUMBER
public static final int BIGQUERY_SOURCE_FIELD_NUMBER- See Also:
-
FHIR_STORE_SOURCE_FIELD_NUMBER
public static final int FHIR_STORE_SOURCE_FIELD_NUMBER- See Also:
-
SPANNER_SOURCE_FIELD_NUMBER
public static final int SPANNER_SOURCE_FIELD_NUMBER- See Also:
-
CLOUD_SQL_SOURCE_FIELD_NUMBER
public static final int CLOUD_SQL_SOURCE_FIELD_NUMBER- See Also:
-
FIRESTORE_SOURCE_FIELD_NUMBER
public static final int FIRESTORE_SOURCE_FIELD_NUMBER- See Also:
-
ALLOY_DB_SOURCE_FIELD_NUMBER
public static final int ALLOY_DB_SOURCE_FIELD_NUMBER- See Also:
-
BIGTABLE_SOURCE_FIELD_NUMBER
public static final int BIGTABLE_SOURCE_FIELD_NUMBER- See Also:
-
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER- See Also:
-
ERROR_CONFIG_FIELD_NUMBER
public static final int ERROR_CONFIG_FIELD_NUMBER- See Also:
-
RECONCILIATION_MODE_FIELD_NUMBER
public static final int RECONCILIATION_MODE_FIELD_NUMBER- See Also:
-
UPDATE_MASK_FIELD_NUMBER
public static final int UPDATE_MASK_FIELD_NUMBER- See Also:
-
AUTO_GENERATE_IDS_FIELD_NUMBER
public static final int AUTO_GENERATE_IDS_FIELD_NUMBER- See Also:
-
ID_FIELD_FIELD_NUMBER
public static final int ID_FIELD_FIELD_NUMBER- See Also:
-
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
getSourceCase
- Specified by:
getSourceCasein interfaceImportDocumentsRequestOrBuilder
-
hasInlineSource
public boolean hasInlineSource()The Inline source for the input content for documents.
.google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.InlineSource inline_source = 2;- Specified by:
hasInlineSourcein interfaceImportDocumentsRequestOrBuilder- Returns:
- Whether the inlineSource field is set.
-
getInlineSource
The Inline source for the input content for documents.
.google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.InlineSource inline_source = 2;- Specified by:
getInlineSourcein interfaceImportDocumentsRequestOrBuilder- Returns:
- The inlineSource.
-
getInlineSourceOrBuilder
The Inline source for the input content for documents.
.google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.InlineSource inline_source = 2;- Specified by:
getInlineSourceOrBuilderin interfaceImportDocumentsRequestOrBuilder
-
hasGcsSource
public boolean hasGcsSource()Cloud Storage location for the input content.
.google.cloud.discoveryengine.v1beta.GcsSource gcs_source = 3;- Specified by:
hasGcsSourcein interfaceImportDocumentsRequestOrBuilder- Returns:
- Whether the gcsSource field is set.
-
getGcsSource
Cloud Storage location for the input content.
.google.cloud.discoveryengine.v1beta.GcsSource gcs_source = 3;- Specified by:
getGcsSourcein interfaceImportDocumentsRequestOrBuilder- Returns:
- The gcsSource.
-
getGcsSourceOrBuilder
Cloud Storage location for the input content.
.google.cloud.discoveryengine.v1beta.GcsSource gcs_source = 3;- Specified by:
getGcsSourceOrBuilderin interfaceImportDocumentsRequestOrBuilder
-
hasBigquerySource
public boolean hasBigquerySource()BigQuery input source.
.google.cloud.discoveryengine.v1beta.BigQuerySource bigquery_source = 4;- Specified by:
hasBigquerySourcein interfaceImportDocumentsRequestOrBuilder- Returns:
- Whether the bigquerySource field is set.
-
getBigquerySource
BigQuery input source.
.google.cloud.discoveryengine.v1beta.BigQuerySource bigquery_source = 4;- Specified by:
getBigquerySourcein interfaceImportDocumentsRequestOrBuilder- Returns:
- The bigquerySource.
-
getBigquerySourceOrBuilder
BigQuery input source.
.google.cloud.discoveryengine.v1beta.BigQuerySource bigquery_source = 4;- Specified by:
getBigquerySourceOrBuilderin interfaceImportDocumentsRequestOrBuilder
-
hasFhirStoreSource
public boolean hasFhirStoreSource()FhirStore input source.
.google.cloud.discoveryengine.v1beta.FhirStoreSource fhir_store_source = 10;- Specified by:
hasFhirStoreSourcein interfaceImportDocumentsRequestOrBuilder- Returns:
- Whether the fhirStoreSource field is set.
-
getFhirStoreSource
FhirStore input source.
.google.cloud.discoveryengine.v1beta.FhirStoreSource fhir_store_source = 10;- Specified by:
getFhirStoreSourcein interfaceImportDocumentsRequestOrBuilder- Returns:
- The fhirStoreSource.
-
getFhirStoreSourceOrBuilder
FhirStore input source.
.google.cloud.discoveryengine.v1beta.FhirStoreSource fhir_store_source = 10;- Specified by:
getFhirStoreSourceOrBuilderin interfaceImportDocumentsRequestOrBuilder
-
hasSpannerSource
public boolean hasSpannerSource()Spanner input source.
.google.cloud.discoveryengine.v1beta.SpannerSource spanner_source = 11;- Specified by:
hasSpannerSourcein interfaceImportDocumentsRequestOrBuilder- Returns:
- Whether the spannerSource field is set.
-
getSpannerSource
Spanner input source.
.google.cloud.discoveryengine.v1beta.SpannerSource spanner_source = 11;- Specified by:
getSpannerSourcein interfaceImportDocumentsRequestOrBuilder- Returns:
- The spannerSource.
-
getSpannerSourceOrBuilder
Spanner input source.
.google.cloud.discoveryengine.v1beta.SpannerSource spanner_source = 11;- Specified by:
getSpannerSourceOrBuilderin interfaceImportDocumentsRequestOrBuilder
-
hasCloudSqlSource
public boolean hasCloudSqlSource()Cloud SQL input source.
.google.cloud.discoveryengine.v1beta.CloudSqlSource cloud_sql_source = 12;- Specified by:
hasCloudSqlSourcein interfaceImportDocumentsRequestOrBuilder- Returns:
- Whether the cloudSqlSource field is set.
-
getCloudSqlSource
Cloud SQL input source.
.google.cloud.discoveryengine.v1beta.CloudSqlSource cloud_sql_source = 12;- Specified by:
getCloudSqlSourcein interfaceImportDocumentsRequestOrBuilder- Returns:
- The cloudSqlSource.
-
getCloudSqlSourceOrBuilder
Cloud SQL input source.
.google.cloud.discoveryengine.v1beta.CloudSqlSource cloud_sql_source = 12;- Specified by:
getCloudSqlSourceOrBuilderin interfaceImportDocumentsRequestOrBuilder
-
hasFirestoreSource
public boolean hasFirestoreSource()Firestore input source.
.google.cloud.discoveryengine.v1beta.FirestoreSource firestore_source = 13;- Specified by:
hasFirestoreSourcein interfaceImportDocumentsRequestOrBuilder- Returns:
- Whether the firestoreSource field is set.
-
getFirestoreSource
Firestore input source.
.google.cloud.discoveryengine.v1beta.FirestoreSource firestore_source = 13;- Specified by:
getFirestoreSourcein interfaceImportDocumentsRequestOrBuilder- Returns:
- The firestoreSource.
-
getFirestoreSourceOrBuilder
Firestore input source.
.google.cloud.discoveryengine.v1beta.FirestoreSource firestore_source = 13;- Specified by:
getFirestoreSourceOrBuilderin interfaceImportDocumentsRequestOrBuilder
-
hasAlloyDbSource
public boolean hasAlloyDbSource()AlloyDB input source.
.google.cloud.discoveryengine.v1beta.AlloyDbSource alloy_db_source = 14;- Specified by:
hasAlloyDbSourcein interfaceImportDocumentsRequestOrBuilder- Returns:
- Whether the alloyDbSource field is set.
-
getAlloyDbSource
AlloyDB input source.
.google.cloud.discoveryengine.v1beta.AlloyDbSource alloy_db_source = 14;- Specified by:
getAlloyDbSourcein interfaceImportDocumentsRequestOrBuilder- Returns:
- The alloyDbSource.
-
getAlloyDbSourceOrBuilder
AlloyDB input source.
.google.cloud.discoveryengine.v1beta.AlloyDbSource alloy_db_source = 14;- Specified by:
getAlloyDbSourceOrBuilderin interfaceImportDocumentsRequestOrBuilder
-
hasBigtableSource
public boolean hasBigtableSource()Cloud Bigtable input source.
.google.cloud.discoveryengine.v1beta.BigtableSource bigtable_source = 15;- Specified by:
hasBigtableSourcein interfaceImportDocumentsRequestOrBuilder- Returns:
- Whether the bigtableSource field is set.
-
getBigtableSource
Cloud Bigtable input source.
.google.cloud.discoveryengine.v1beta.BigtableSource bigtable_source = 15;- Specified by:
getBigtableSourcein interfaceImportDocumentsRequestOrBuilder- Returns:
- The bigtableSource.
-
getBigtableSourceOrBuilder
Cloud Bigtable input source.
.google.cloud.discoveryengine.v1beta.BigtableSource bigtable_source = 15;- Specified by:
getBigtableSourceOrBuilderin interfaceImportDocumentsRequestOrBuilder
-
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) = { ... }- Specified by:
getParentin interfaceImportDocumentsRequestOrBuilder- Returns:
- The parent.
-
getParentBytes
public 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) = { ... }- Specified by:
getParentBytesin interfaceImportDocumentsRequestOrBuilder- Returns:
- The bytes for parent.
-
hasErrorConfig
public boolean hasErrorConfig()The desired location of errors incurred during the Import.
.google.cloud.discoveryengine.v1beta.ImportErrorConfig error_config = 5;- Specified by:
hasErrorConfigin interfaceImportDocumentsRequestOrBuilder- Returns:
- Whether the errorConfig field is set.
-
getErrorConfig
The desired location of errors incurred during the Import.
.google.cloud.discoveryengine.v1beta.ImportErrorConfig error_config = 5;- Specified by:
getErrorConfigin interfaceImportDocumentsRequestOrBuilder- Returns:
- The errorConfig.
-
getErrorConfigOrBuilder
The desired location of errors incurred during the Import.
.google.cloud.discoveryengine.v1beta.ImportErrorConfig error_config = 5;- Specified by:
getErrorConfigOrBuilderin interfaceImportDocumentsRequestOrBuilder
-
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.INCREMENTAL].
.google.cloud.discoveryengine.v1beta.ImportDocumentsRequest.ReconciliationMode reconciliation_mode = 6;- Specified by:
getReconciliationModeValuein interfaceImportDocumentsRequestOrBuilder- Returns:
- The enum numeric value on the wire for 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;- Specified by:
getReconciliationModein interfaceImportDocumentsRequestOrBuilder- Returns:
- The reconciliationMode.
-
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;- Specified by:
hasUpdateMaskin interfaceImportDocumentsRequestOrBuilder- Returns:
- Whether the updateMask field is set.
-
getUpdateMask
public com.google.protobuf.FieldMask getUpdateMask()Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields.
.google.protobuf.FieldMask update_mask = 7;- Specified by:
getUpdateMaskin interfaceImportDocumentsRequestOrBuilder- Returns:
- The updateMask.
-
getUpdateMaskOrBuilder
public com.google.protobuf.FieldMaskOrBuilder getUpdateMaskOrBuilder()Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields.
.google.protobuf.FieldMask update_mask = 7;- Specified by:
getUpdateMaskOrBuilderin interfaceImportDocumentsRequestOrBuilder
-
getAutoGenerateIds
public 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. Supported data sources: * [GcsSource][google.cloud.discoveryengine.v1beta.GcsSource]. [GcsSource.data_schema][google.cloud.discoveryengine.v1beta.GcsSource.data_schema] must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * [BigQuerySource][google.cloud.discoveryengine.v1beta.BigQuerySource]. [BigQuerySource.data_schema][google.cloud.discoveryengine.v1beta.BigQuerySource.data_schema] must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * [SpannerSource][google.cloud.discoveryengine.v1beta.SpannerSource]. * [CloudSqlSource][google.cloud.discoveryengine.v1beta.CloudSqlSource]. * [FirestoreSource][google.cloud.discoveryengine.v1beta.FirestoreSource]. * [BigtableSource][google.cloud.discoveryengine.v1beta.BigtableSource].
bool auto_generate_ids = 8;- Specified by:
getAutoGenerateIdsin interfaceImportDocumentsRequestOrBuilder- Returns:
- The autoGenerateIds.
-
getIdField
The field indicates the ID field or column to be used as 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 others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the [Document.id][google.cloud.discoveryengine.v1beta.Document.id]s. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when [auto_generate_ids][google.cloud.discoveryengine.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. Supported data sources: * [GcsSource][google.cloud.discoveryengine.v1beta.GcsSource]. [GcsSource.data_schema][google.cloud.discoveryengine.v1beta.GcsSource.data_schema] must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * [BigQuerySource][google.cloud.discoveryengine.v1beta.BigQuerySource]. [BigQuerySource.data_schema][google.cloud.discoveryengine.v1beta.BigQuerySource.data_schema] must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * [SpannerSource][google.cloud.discoveryengine.v1beta.SpannerSource]. * [CloudSqlSource][google.cloud.discoveryengine.v1beta.CloudSqlSource]. * [FirestoreSource][google.cloud.discoveryengine.v1beta.FirestoreSource]. * [BigtableSource][google.cloud.discoveryengine.v1beta.BigtableSource].string id_field = 9;- Specified by:
getIdFieldin interfaceImportDocumentsRequestOrBuilder- Returns:
- The idField.
-
getIdFieldBytes
public com.google.protobuf.ByteString getIdFieldBytes()The field indicates the ID field or column to be used as unique IDs of the documents. For [GcsSource][google.cloud.discoveryengine.v1beta.GcsSource] it is the key of the JSON field. For instance, `my_id` for JSON `{"my_id": "some_uuid"}`. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the [Document.id][google.cloud.discoveryengine.v1beta.Document.id]s. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when [auto_generate_ids][google.cloud.discoveryengine.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. Supported data sources: * [GcsSource][google.cloud.discoveryengine.v1beta.GcsSource]. [GcsSource.data_schema][google.cloud.discoveryengine.v1beta.GcsSource.data_schema] must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * [BigQuerySource][google.cloud.discoveryengine.v1beta.BigQuerySource]. [BigQuerySource.data_schema][google.cloud.discoveryengine.v1beta.BigQuerySource.data_schema] must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * [SpannerSource][google.cloud.discoveryengine.v1beta.SpannerSource]. * [CloudSqlSource][google.cloud.discoveryengine.v1beta.CloudSqlSource]. * [FirestoreSource][google.cloud.discoveryengine.v1beta.FirestoreSource]. * [BigtableSource][google.cloud.discoveryengine.v1beta.BigtableSource].string id_field = 9;- Specified by:
getIdFieldBytesin interfaceImportDocumentsRequestOrBuilder- Returns:
- The bytes for idField.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static ImportDocumentsRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ImportDocumentsRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ImportDocumentsRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ImportDocumentsRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ImportDocumentsRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static ImportDocumentsRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static ImportDocumentsRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static ImportDocumentsRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static ImportDocumentsRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static ImportDocumentsRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected ImportDocumentsRequest.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-