Struct google_api_proto::google::cloud::discoveryengine::v1::ImportDocumentsRequest

pub struct ImportDocumentsRequest {
    pub parent: String,
    pub error_config: Option<ImportErrorConfig>,
    pub reconciliation_mode: i32,
    pub update_mask: Option<FieldMask>,
    pub auto_generate_ids: bool,
    pub id_field: String,
    pub source: Option<Source>,
}

Request message for Import methods.

Fields

parent: String

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

error_config: Option<ImportErrorConfig>

The desired location of errors incurred during the Import.

reconciliation_mode: i32

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

update_mask: Option<FieldMask>

Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields.

auto_generate_ids: bool

Whether to automatically generate IDs for the documents if absent.

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

Supported data sources:

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

id_field: String

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

For [GcsSource][google.cloud.discoveryengine.v1.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.v1.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 with 1-63 characters. Otherwise, documents without valid IDs fail to be imported.

Only set this field when [auto_generate_ids][google.cloud.discoveryengine.v1.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.v1.GcsSource]. [GcsSource.data_schema][google.cloud.discoveryengine.v1.GcsSource.data_schema] must be custom or csv. Otherwise, an INVALID_ARGUMENT error is thrown.
• [BigQuerySource][google.cloud.discoveryengine.v1.BigQuerySource]. [BigQuerySource.data_schema][google.cloud.discoveryengine.v1.BigQuerySource.data_schema] must be custom or csv. Otherwise, an INVALID_ARGUMENT error is thrown.
• [SpannerSource][google.cloud.discoveryengine.v1.SpannerSource].
• [CloudSqlSource][google.cloud.discoveryengine.v1.CloudSqlSource].
• [FirestoreSource][google.cloud.discoveryengine.v1.FirestoreSource].
• [BigtableSource][google.cloud.discoveryengine.v1.BigtableSource].

source: Option<Source>

Required. The source of the input.

Implementations

impl ImportDocumentsRequest

pub fn reconciliation_mode(&self) -> ReconciliationMode

Returns the enum value of reconciliation_mode, or the default if the field is set to an invalid enum value.

pub fn set_reconciliation_mode(&mut self, value: ReconciliationMode)

Sets reconciliation_mode to the provided enum value.

Trait Implementations

impl Clone for ImportDocumentsRequest

fn clone(&self) -> ImportDocumentsRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ImportDocumentsRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ImportDocumentsRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for ImportDocumentsRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for ImportDocumentsRequest

fn eq(&self, other: &ImportDocumentsRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ImportDocumentsRequest