Class ImportDocumentsRequest (0.43.0) 

public final class ImportDocumentsRequest extends GeneratedMessageV3 implements ImportDocumentsRequestOrBuilder

Request message for Import methods.

Protobuf type google.cloud.discoveryengine.v1alpha.ImportDocumentsRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > ImportDocumentsRequest

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

BIGTABLE_SOURCE_FIELD_NUMBER

public static final int BIGTABLE_SOURCE_FIELD_NUMBER
Field Value
Type Description
int

CLOUD_SQL_SOURCE_FIELD_NUMBER

public static final int CLOUD_SQL_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

FHIR_STORE_SOURCE_FIELD_NUMBER

public static final int FHIR_STORE_SOURCE_FIELD_NUMBER
Field Value
Type Description
int

FIRESTORE_SOURCE_FIELD_NUMBER

public static final int FIRESTORE_SOURCE_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

SPANNER_SOURCE_FIELD_NUMBER

public static final int SPANNER_SOURCE_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_MASK_FIELD_NUMBER

public static final int UPDATE_MASK_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ImportDocumentsRequest getDefaultInstance()
Returns
Type Description
ImportDocumentsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ImportDocumentsRequest.Builder newBuilder()
Returns
Type Description
ImportDocumentsRequest.Builder

newBuilder(ImportDocumentsRequest prototype)

public static ImportDocumentsRequest.Builder newBuilder(ImportDocumentsRequest prototype)
Parameter
Name Description
prototype ImportDocumentsRequest
Returns
Type Description
ImportDocumentsRequest.Builder

parseDelimitedFrom(InputStream input)

public static ImportDocumentsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ImportDocumentsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ImportDocumentsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ImportDocumentsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ImportDocumentsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ImportDocumentsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ImportDocumentsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ImportDocumentsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ImportDocumentsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ImportDocumentsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ImportDocumentsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ImportDocumentsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ImportDocumentsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ImportDocumentsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ImportDocumentsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ImportDocumentsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ImportDocumentsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ImportDocumentsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ImportDocumentsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ImportDocumentsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ImportDocumentsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ImportDocumentsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ImportDocumentsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ImportDocumentsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ImportDocumentsRequest> parser()
Returns
Type Description
Parser<ImportDocumentsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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, otherwise, documents without IDs fail to be imported.

Supported data sources:

  • GcsSource. GcsSource.data_schema must be custom or csv. Otherwise, an INVALID_ARGUMENT error is thrown.
  • BigQuerySource. BigQuerySource.data_schema must be custom or csv. Otherwise, an INVALID_ARGUMENT error is thrown.
  • SpannerSource.
  • CloudSqlSource.
  • FirestoreSource.
  • BigtableSource.

bool auto_generate_ids = 8;

Returns
Type Description
boolean

The autoGenerateIds.

getBigquerySource()

public BigQuerySource getBigquerySource()

BigQuery input source.

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

Returns
Type Description
BigQuerySource

The bigquerySource.

getBigquerySourceOrBuilder()

public BigQuerySourceOrBuilder getBigquerySourceOrBuilder()

BigQuery input source.

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

Returns
Type Description
BigQuerySourceOrBuilder

getBigtableSource()

public BigtableSource getBigtableSource()

Cloud Bigtable input source.

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

Returns
Type Description
BigtableSource

The bigtableSource.

getBigtableSourceOrBuilder()

public BigtableSourceOrBuilder getBigtableSourceOrBuilder()

Cloud Bigtable input source.

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

Returns
Type Description
BigtableSourceOrBuilder

getCloudSqlSource()

public CloudSqlSource getCloudSqlSource()

Cloud SQL input source.

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

Returns
Type Description
CloudSqlSource

The cloudSqlSource.

getCloudSqlSourceOrBuilder()

public CloudSqlSourceOrBuilder getCloudSqlSourceOrBuilder()

Cloud SQL input source.

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

Returns
Type Description
CloudSqlSourceOrBuilder

getDefaultInstanceForType()

public ImportDocumentsRequest getDefaultInstanceForType()
Returns
Type Description
ImportDocumentsRequest

getErrorConfig()

public ImportErrorConfig getErrorConfig()

The desired location of errors incurred during the Import.

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

Returns
Type Description
ImportErrorConfig

The errorConfig.

getErrorConfigOrBuilder()

public ImportErrorConfigOrBuilder getErrorConfigOrBuilder()

The desired location of errors incurred during the Import.

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

Returns
Type Description
ImportErrorConfigOrBuilder

getFhirStoreSource()

public FhirStoreSource getFhirStoreSource()

FhirStore input source.

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

Returns
Type Description
FhirStoreSource

The fhirStoreSource.

getFhirStoreSourceOrBuilder()

public FhirStoreSourceOrBuilder getFhirStoreSourceOrBuilder()

FhirStore input source.

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

Returns
Type Description
FhirStoreSourceOrBuilder

getFirestoreSource()

public FirestoreSource getFirestoreSource()

Firestore input source.

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

Returns
Type Description
FirestoreSource

The firestoreSource.

getFirestoreSourceOrBuilder()

public FirestoreSourceOrBuilder getFirestoreSourceOrBuilder()

Firestore input source.

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

Returns
Type Description
FirestoreSourceOrBuilder

getGcsSource()

public GcsSource getGcsSource()

Cloud Storage location for the input content.

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

Returns
Type Description
GcsSource

The gcsSource.

getGcsSourceOrBuilder()

public GcsSourceOrBuilder getGcsSourceOrBuilder()

Cloud Storage location for the input content.

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

Returns
Type Description
GcsSourceOrBuilder

getIdField()

public String getIdField()

The field indicates the ID field or column to be used as 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 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.ids. 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 with 1-63 characters. Otherwise, documents without valid IDs fail to be imported.

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.

Supported data sources:

  • GcsSource. GcsSource.data_schema must be custom or csv. Otherwise, an INVALID_ARGUMENT error is thrown.
  • BigQuerySource. BigQuerySource.data_schema must be custom or csv. Otherwise, an INVALID_ARGUMENT error is thrown.
  • SpannerSource.
  • CloudSqlSource.
  • FirestoreSource.
  • BigtableSource.

string id_field = 9;

Returns
Type Description
String

The idField.

getIdFieldBytes()

public ByteString getIdFieldBytes()

The field indicates the ID field or column to be used as 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 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.ids. 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 with 1-63 characters. Otherwise, documents without valid IDs fail to be imported.

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.

Supported data sources:

  • GcsSource. GcsSource.data_schema must be custom or csv. Otherwise, an INVALID_ARGUMENT error is thrown.
  • BigQuerySource. BigQuerySource.data_schema must be custom or csv. Otherwise, an INVALID_ARGUMENT error is thrown.
  • SpannerSource.
  • CloudSqlSource.
  • FirestoreSource.
  • BigtableSource.

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.v1alpha.ImportDocumentsRequest.InlineSource inline_source = 2;

Returns
Type Description
ImportDocumentsRequest.InlineSource

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;

Returns
Type Description
ImportDocumentsRequest.InlineSourceOrBuilder

getParent()

public String getParent()

Required. The parent branch resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}. Requires create/update permission.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The parent branch resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}. Requires create/update permission.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

public Parser<ImportDocumentsRequest> getParserForType()
Returns
Type Description
Parser<ImportDocumentsRequest>
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.v1alpha.ImportDocumentsRequest.ReconciliationMode reconciliation_mode = 6;

Returns
Type Description
ImportDocumentsRequest.ReconciliationMode

The reconciliationMode.

getReconciliationModeValue()

public int getReconciliationModeValue()

The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL.

.google.cloud.discoveryengine.v1alpha.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()
Returns
Type Description
ImportDocumentsRequest.SourceCase

getSpannerSource()

public SpannerSource getSpannerSource()

Spanner input source.

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

Returns
Type Description
SpannerSource

The spannerSource.

getSpannerSourceOrBuilder()

public SpannerSourceOrBuilder getSpannerSourceOrBuilder()

Spanner input source.

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

Returns
Type Description
SpannerSourceOrBuilder

getUpdateMask()

public 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;

Returns
Type Description
FieldMask

The updateMask.

getUpdateMaskOrBuilder()

public 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;

Returns
Type Description
FieldMaskOrBuilder

hasBigquerySource()

public boolean hasBigquerySource()

BigQuery input source.

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

Returns
Type Description
boolean

Whether the bigquerySource field is set.

hasBigtableSource()

public boolean hasBigtableSource()

Cloud Bigtable input source.

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

Returns
Type Description
boolean

Whether the bigtableSource field is set.

hasCloudSqlSource()

public boolean hasCloudSqlSource()

Cloud SQL input source.

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

Returns
Type Description
boolean

Whether the cloudSqlSource field is set.

hasErrorConfig()

public boolean hasErrorConfig()

The desired location of errors incurred during the Import.

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

Returns
Type Description
boolean

Whether the errorConfig field is set.

hasFhirStoreSource()

public boolean hasFhirStoreSource()

FhirStore input source.

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

Returns
Type Description
boolean

Whether the fhirStoreSource field is set.

hasFirestoreSource()

public boolean hasFirestoreSource()

Firestore input source.

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

Returns
Type Description
boolean

Whether the firestoreSource field is set.

hasGcsSource()

public boolean hasGcsSource()

Cloud Storage location for the input content.

.google.cloud.discoveryengine.v1alpha.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.v1alpha.ImportDocumentsRequest.InlineSource inline_source = 2;

Returns
Type Description
boolean

Whether the inlineSource field is set.

hasSpannerSource()

public boolean hasSpannerSource()

Spanner input source.

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

Returns
Type Description
boolean

Whether the spannerSource field is set.

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;

Returns
Type Description
boolean

Whether the updateMask field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ImportDocumentsRequest.Builder newBuilderForType()
Returns
Type Description
ImportDocumentsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ImportDocumentsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ImportDocumentsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ImportDocumentsRequest.Builder toBuilder()
Returns
Type Description
ImportDocumentsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException