com.google.cloud.discoveryengine.v1alpha

Class ImportDocumentsRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest

All Implemented Interfaces:

ImportDocumentsRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class ImportDocumentsRequest
extends com.google.protobuf.GeneratedMessageV3
implements ImportDocumentsRequestOrBuilder

 Request message for Import methods.
 

Protobuf type google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

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

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALLOY_DB_SOURCE_FIELD_NUMBER
static int	AUTO_GENERATE_IDS_FIELD_NUMBER
static int	BIGQUERY_SOURCE_FIELD_NUMBER
static int	BIGTABLE_SOURCE_FIELD_NUMBER
static int	CLOUD_SQL_SOURCE_FIELD_NUMBER
static int	ERROR_CONFIG_FIELD_NUMBER
static int	FHIR_STORE_SOURCE_FIELD_NUMBER
static int	FIRESTORE_SOURCE_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
static int	SPANNER_SOURCE_FIELD_NUMBER
static int	UPDATE_MASK_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
AlloyDbSource	getAlloyDbSource() AlloyDB input source.
AlloyDbSourceOrBuilder	getAlloyDbSourceOrBuilder() AlloyDB input source.
boolean	getAutoGenerateIds() Whether to automatically generate IDs for the documents if absent.
BigQuerySource	getBigquerySource() BigQuery input source.
BigQuerySourceOrBuilder	getBigquerySourceOrBuilder() BigQuery input source.
BigtableSource	getBigtableSource() Cloud Bigtable input source.
BigtableSourceOrBuilder	getBigtableSourceOrBuilder() Cloud Bigtable input source.
CloudSqlSource	getCloudSqlSource() Cloud SQL input source.
CloudSqlSourceOrBuilder	getCloudSqlSourceOrBuilder() Cloud SQL 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.
FhirStoreSource	getFhirStoreSource() FhirStore input source.
FhirStoreSourceOrBuilder	getFhirStoreSourceOrBuilder() FhirStore input source.
FirestoreSource	getFirestoreSource() Firestore input source.
FirestoreSourceOrBuilder	getFirestoreSourceOrBuilder() Firestore input source.
GcsSource	getGcsSource() Cloud Storage location for the input content.
GcsSourceOrBuilder	getGcsSourceOrBuilder() Cloud Storage location for the input content.
String	getIdField() The field indicates the ID field or column to be used as unique IDs of the documents.
com.google.protobuf.ByteString	getIdFieldBytes() The field indicates the ID field or column to be used as 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()
SpannerSource	getSpannerSource() Spanner input source.
SpannerSourceOrBuilder	getSpannerSourceOrBuilder() Spanner input source.
com.google.protobuf.FieldMask	getUpdateMask() Indicates which fields in the provided imported documents to update.
com.google.protobuf.FieldMaskOrBuilder	getUpdateMaskOrBuilder() Indicates which fields in the provided imported documents to update.
boolean	hasAlloyDbSource() AlloyDB input source.
boolean	hasBigquerySource() BigQuery input source.
boolean	hasBigtableSource() Cloud Bigtable input source.
boolean	hasCloudSqlSource() Cloud SQL input source.
boolean	hasErrorConfig() The desired location of errors incurred during the Import.
boolean	hasFhirStoreSource() FhirStore input source.
boolean	hasFirestoreSource() Firestore input source.
boolean	hasGcsSource() Cloud Storage location for the input content.
int	hashCode()
boolean	hasInlineSource() The Inline source for the input content for documents.
boolean	hasSpannerSource() Spanner input source.
boolean	hasUpdateMask() Indicates which fields in the provided imported documents to update.
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)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

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, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

INLINE_SOURCE_FIELD_NUMBER

public static final int INLINE_SOURCE_FIELD_NUMBER

See Also:

Constant Field Values

GCS_SOURCE_FIELD_NUMBER

public static final int GCS_SOURCE_FIELD_NUMBER

See Also:

Constant Field Values

BIGQUERY_SOURCE_FIELD_NUMBER

public static final int BIGQUERY_SOURCE_FIELD_NUMBER

See Also:

Constant Field Values

FHIR_STORE_SOURCE_FIELD_NUMBER

public static final int FHIR_STORE_SOURCE_FIELD_NUMBER

See Also:

Constant Field Values

SPANNER_SOURCE_FIELD_NUMBER

public static final int SPANNER_SOURCE_FIELD_NUMBER

See Also:

Constant Field Values

CLOUD_SQL_SOURCE_FIELD_NUMBER

public static final int CLOUD_SQL_SOURCE_FIELD_NUMBER

See Also:

Constant Field Values

FIRESTORE_SOURCE_FIELD_NUMBER

public static final int FIRESTORE_SOURCE_FIELD_NUMBER

See Also:

Constant Field Values

ALLOY_DB_SOURCE_FIELD_NUMBER

public static final int ALLOY_DB_SOURCE_FIELD_NUMBER

See Also:

Constant Field Values

BIGTABLE_SOURCE_FIELD_NUMBER

public static final int BIGTABLE_SOURCE_FIELD_NUMBER

See Also:

Constant Field Values

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER

See Also:

Constant Field Values

ERROR_CONFIG_FIELD_NUMBER

public static final int ERROR_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

RECONCILIATION_MODE_FIELD_NUMBER

public static final int RECONCILIATION_MODE_FIELD_NUMBER

See Also:

Constant Field Values

UPDATE_MASK_FIELD_NUMBER

public static final int UPDATE_MASK_FIELD_NUMBER

See Also:

Constant Field Values

AUTO_GENERATE_IDS_FIELD_NUMBER

public static final int AUTO_GENERATE_IDS_FIELD_NUMBER

See Also:

Constant Field Values

ID_FIELD_FIELD_NUMBER

public static final int ID_FIELD_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getSourceCase

public ImportDocumentsRequest.SourceCase getSourceCase()

Specified by:

getSourceCase in interface ImportDocumentsRequestOrBuilder

hasInlineSource

public boolean hasInlineSource()

 The Inline source for the input content for documents.
 

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

Specified by:

hasInlineSource in interface ImportDocumentsRequestOrBuilder

Returns:

Whether the inlineSource field is set.

getInlineSource

public ImportDocumentsRequest.InlineSource getInlineSource()

 The Inline source for the input content for documents.
 

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

Specified by:

getInlineSource in interface ImportDocumentsRequestOrBuilder

Returns:

The inlineSource.

getInlineSourceOrBuilder

public ImportDocumentsRequest.InlineSourceOrBuilder getInlineSourceOrBuilder()

 The Inline source for the input content for documents.
 

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

Specified by:

getInlineSourceOrBuilder in interface ImportDocumentsRequestOrBuilder

hasGcsSource

public boolean hasGcsSource()

 Cloud Storage location for the input content.
 

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

Specified by:

hasGcsSource in interface ImportDocumentsRequestOrBuilder

Returns:

Whether the gcsSource field is set.

getGcsSource

public GcsSource getGcsSource()

 Cloud Storage location for the input content.
 

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

Specified by:

getGcsSource in interface ImportDocumentsRequestOrBuilder

Returns:

The gcsSource.

getGcsSourceOrBuilder

public GcsSourceOrBuilder getGcsSourceOrBuilder()

 Cloud Storage location for the input content.
 

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

Specified by:

getGcsSourceOrBuilder in interface ImportDocumentsRequestOrBuilder

hasBigquerySource

public boolean hasBigquerySource()

 BigQuery input source.
 

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

Specified by:

hasBigquerySource in interface ImportDocumentsRequestOrBuilder

Returns:

Whether the bigquerySource field is set.

getBigquerySource

public BigQuerySource getBigquerySource()

 BigQuery input source.
 

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

Specified by:

getBigquerySource in interface ImportDocumentsRequestOrBuilder

Returns:

The bigquerySource.

getBigquerySourceOrBuilder

public BigQuerySourceOrBuilder getBigquerySourceOrBuilder()

 BigQuery input source.
 

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

Specified by:

getBigquerySourceOrBuilder in interface ImportDocumentsRequestOrBuilder

hasFhirStoreSource

public boolean hasFhirStoreSource()

 FhirStore input source.
 

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

Specified by:

hasFhirStoreSource in interface ImportDocumentsRequestOrBuilder

Returns:

Whether the fhirStoreSource field is set.

getFhirStoreSource

public FhirStoreSource getFhirStoreSource()

 FhirStore input source.
 

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

Specified by:

getFhirStoreSource in interface ImportDocumentsRequestOrBuilder

Returns:

The fhirStoreSource.

getFhirStoreSourceOrBuilder

public FhirStoreSourceOrBuilder getFhirStoreSourceOrBuilder()

 FhirStore input source.
 

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

Specified by:

getFhirStoreSourceOrBuilder in interface ImportDocumentsRequestOrBuilder

hasSpannerSource

public boolean hasSpannerSource()

 Spanner input source.
 

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

Specified by:

hasSpannerSource in interface ImportDocumentsRequestOrBuilder

Returns:

Whether the spannerSource field is set.

getSpannerSource

public SpannerSource getSpannerSource()

 Spanner input source.
 

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

Specified by:

getSpannerSource in interface ImportDocumentsRequestOrBuilder

Returns:

The spannerSource.

getSpannerSourceOrBuilder

public SpannerSourceOrBuilder getSpannerSourceOrBuilder()

 Spanner input source.
 

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

Specified by:

getSpannerSourceOrBuilder in interface ImportDocumentsRequestOrBuilder

hasCloudSqlSource

public boolean hasCloudSqlSource()

 Cloud SQL input source.
 

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

Specified by:

hasCloudSqlSource in interface ImportDocumentsRequestOrBuilder

Returns:

Whether the cloudSqlSource field is set.

getCloudSqlSource

public CloudSqlSource getCloudSqlSource()

 Cloud SQL input source.
 

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

Specified by:

getCloudSqlSource in interface ImportDocumentsRequestOrBuilder

Returns:

The cloudSqlSource.

getCloudSqlSourceOrBuilder

public CloudSqlSourceOrBuilder getCloudSqlSourceOrBuilder()

 Cloud SQL input source.
 

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

Specified by:

getCloudSqlSourceOrBuilder in interface ImportDocumentsRequestOrBuilder

hasFirestoreSource

public boolean hasFirestoreSource()

 Firestore input source.
 

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

Specified by:

hasFirestoreSource in interface ImportDocumentsRequestOrBuilder

Returns:

Whether the firestoreSource field is set.

getFirestoreSource

public FirestoreSource getFirestoreSource()

 Firestore input source.
 

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

Specified by:

getFirestoreSource in interface ImportDocumentsRequestOrBuilder

Returns:

The firestoreSource.

getFirestoreSourceOrBuilder

public FirestoreSourceOrBuilder getFirestoreSourceOrBuilder()

 Firestore input source.
 

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

Specified by:

getFirestoreSourceOrBuilder in interface ImportDocumentsRequestOrBuilder

hasAlloyDbSource

public boolean hasAlloyDbSource()

 AlloyDB input source.
 

.google.cloud.discoveryengine.v1alpha.AlloyDbSource alloy_db_source = 14;

Specified by:

hasAlloyDbSource in interface ImportDocumentsRequestOrBuilder

Returns:

Whether the alloyDbSource field is set.

getAlloyDbSource

public AlloyDbSource getAlloyDbSource()

 AlloyDB input source.
 

.google.cloud.discoveryengine.v1alpha.AlloyDbSource alloy_db_source = 14;

Specified by:

getAlloyDbSource in interface ImportDocumentsRequestOrBuilder

Returns:

The alloyDbSource.

getAlloyDbSourceOrBuilder

public AlloyDbSourceOrBuilder getAlloyDbSourceOrBuilder()

 AlloyDB input source.
 

.google.cloud.discoveryengine.v1alpha.AlloyDbSource alloy_db_source = 14;

Specified by:

getAlloyDbSourceOrBuilder in interface ImportDocumentsRequestOrBuilder

hasBigtableSource

public boolean hasBigtableSource()

 Cloud Bigtable input source.
 

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

Specified by:

hasBigtableSource in interface ImportDocumentsRequestOrBuilder

Returns:

Whether the bigtableSource field is set.

getBigtableSource

public BigtableSource getBigtableSource()

 Cloud Bigtable input source.
 

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

Specified by:

getBigtableSource in interface ImportDocumentsRequestOrBuilder

Returns:

The bigtableSource.

getBigtableSourceOrBuilder

public BigtableSourceOrBuilder getBigtableSourceOrBuilder()

 Cloud Bigtable input source.
 

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

Specified by:

getBigtableSourceOrBuilder in interface ImportDocumentsRequestOrBuilder

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

Specified by:

getParent in interface ImportDocumentsRequestOrBuilder

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:

getParentBytes in interface ImportDocumentsRequestOrBuilder

Returns:

The bytes for parent.

hasErrorConfig

public boolean hasErrorConfig()

 The desired location of errors incurred during the Import.
 

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

Specified by:

hasErrorConfig in interface ImportDocumentsRequestOrBuilder

Returns:

Whether the errorConfig field is set.

getErrorConfig

public ImportErrorConfig getErrorConfig()

 The desired location of errors incurred during the Import.
 

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

Specified by:

getErrorConfig in interface ImportDocumentsRequestOrBuilder

Returns:

The errorConfig.

getErrorConfigOrBuilder

public ImportErrorConfigOrBuilder getErrorConfigOrBuilder()

 The desired location of errors incurred during the Import.
 

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

Specified by:

getErrorConfigOrBuilder in interface ImportDocumentsRequestOrBuilder

getReconciliationModeValue

public int getReconciliationModeValue()

 The mode of reconciliation between existing documents and the documents to
 be imported. Defaults to
 [ReconciliationMode.INCREMENTAL][google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.ReconciliationMode.INCREMENTAL].
 

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

Specified by:

getReconciliationModeValue in interface ImportDocumentsRequestOrBuilder

Returns:

The enum numeric value on the wire for reconciliationMode.

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.v1alpha.ImportDocumentsRequest.ReconciliationMode.INCREMENTAL].
 

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

Specified by:

getReconciliationMode in interface ImportDocumentsRequestOrBuilder

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:

hasUpdateMask in interface ImportDocumentsRequestOrBuilder

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:

getUpdateMask in interface ImportDocumentsRequestOrBuilder

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:

getUpdateMaskOrBuilder in interface ImportDocumentsRequestOrBuilder

getAutoGenerateIds

public boolean getAutoGenerateIds()

 Whether to automatically generate IDs for the documents if absent.

 If set to `true`,
 [Document.id][google.cloud.discoveryengine.v1alpha.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.v1alpha.ImportDocumentsRequest.ReconciliationMode.FULL]
 is highly recommended to avoid duplicate contents. If unset or set to
 `false`, [Document.id][google.cloud.discoveryengine.v1alpha.Document.id]s
 have to be specified using
 [id_field][google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest.id_field],
 otherwise, documents without IDs fail to be imported.

 Supported data sources:

 * [GcsSource][google.cloud.discoveryengine.v1alpha.GcsSource].
 [GcsSource.data_schema][google.cloud.discoveryengine.v1alpha.GcsSource.data_schema]
 must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
 * [BigQuerySource][google.cloud.discoveryengine.v1alpha.BigQuerySource].
 [BigQuerySource.data_schema][google.cloud.discoveryengine.v1alpha.BigQuerySource.data_schema]
 must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
 * [SpannerSource][google.cloud.discoveryengine.v1alpha.SpannerSource].
 * [CloudSqlSource][google.cloud.discoveryengine.v1alpha.CloudSqlSource].
 * [FirestoreSource][google.cloud.discoveryengine.v1alpha.FirestoreSource].
 * [BigtableSource][google.cloud.discoveryengine.v1alpha.BigtableSource].
 

bool auto_generate_ids = 8;

Specified by:

getAutoGenerateIds in interface ImportDocumentsRequestOrBuilder

Returns:

The autoGenerateIds.

getIdField

public String getIdField()

 The field indicates the ID field or column to be used as unique IDs of
 the documents.

 For [GcsSource][google.cloud.discoveryengine.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.GcsSource].
 [GcsSource.data_schema][google.cloud.discoveryengine.v1alpha.GcsSource.data_schema]
 must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
 * [BigQuerySource][google.cloud.discoveryengine.v1alpha.BigQuerySource].
 [BigQuerySource.data_schema][google.cloud.discoveryengine.v1alpha.BigQuerySource.data_schema]
 must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
 * [SpannerSource][google.cloud.discoveryengine.v1alpha.SpannerSource].
 * [CloudSqlSource][google.cloud.discoveryengine.v1alpha.CloudSqlSource].
 * [FirestoreSource][google.cloud.discoveryengine.v1alpha.FirestoreSource].
 * [BigtableSource][google.cloud.discoveryengine.v1alpha.BigtableSource].
 

string id_field = 9;

Specified by:

getIdField in interface ImportDocumentsRequestOrBuilder

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.v1alpha.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.v1alpha.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.v1alpha.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.v1alpha.GcsSource].
 [GcsSource.data_schema][google.cloud.discoveryengine.v1alpha.GcsSource.data_schema]
 must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
 * [BigQuerySource][google.cloud.discoveryengine.v1alpha.BigQuerySource].
 [BigQuerySource.data_schema][google.cloud.discoveryengine.v1alpha.BigQuerySource.data_schema]
 must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
 * [SpannerSource][google.cloud.discoveryengine.v1alpha.SpannerSource].
 * [CloudSqlSource][google.cloud.discoveryengine.v1alpha.CloudSqlSource].
 * [FirestoreSource][google.cloud.discoveryengine.v1alpha.FirestoreSource].
 * [BigtableSource][google.cloud.discoveryengine.v1alpha.BigtableSource].
 

string id_field = 9;

Specified by:

getIdFieldBytes in interface ImportDocumentsRequestOrBuilder

Returns:

The bytes for idField.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.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

public static ImportDocumentsRequest parseFrom(InputStream input)
                                        throws IOException

Throws:

IOException

parseFrom

public static ImportDocumentsRequest parseFrom(InputStream input,
                                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static ImportDocumentsRequest parseDelimitedFrom(InputStream input)
                                                 throws IOException

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

public ImportDocumentsRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static ImportDocumentsRequest.Builder newBuilder()

newBuilder

public static ImportDocumentsRequest.Builder newBuilder(ImportDocumentsRequest prototype)

toBuilder

public ImportDocumentsRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected ImportDocumentsRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static ImportDocumentsRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<ImportDocumentsRequest> parser()

getParserForType

public com.google.protobuf.Parser<ImportDocumentsRequest> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public ImportDocumentsRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder