GoogleCloudDiscoveryengineV1ImportDocumentsRequest (Discovery Engine API v1-rev20260427-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.discoveryengine.v1.model.GoogleCloudDiscoveryengineV1ImportDocumentsRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class GoogleCloudDiscoveryengineV1ImportDocumentsRequest
extends com.google.api.client.json.GenericJson
```
Request message for Import methods.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Discovery Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

GoogleCloudDiscoveryengineV1ImportDocumentsRequest()

Constructors
Constructor and Description
`GoogleCloudDiscoveryengineV1ImportDocumentsRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GoogleCloudDiscoveryengineV1ImportDocumentsRequest`	`clone()`
`GoogleCloudDiscoveryengineV1AlloyDbSource`	`getAlloyDbSource()` AlloyDB input source.
`Boolean`	`getAutoGenerateIds()` Whether to automatically generate IDs for the documents if absent.
`GoogleCloudDiscoveryengineV1BigQuerySource`	`getBigquerySource()` BigQuery input source.
`GoogleCloudDiscoveryengineV1BigtableSource`	`getBigtableSource()` Cloud Bigtable input source.
`GoogleCloudDiscoveryengineV1CloudSqlSource`	`getCloudSqlSource()` Cloud SQL input source.
`GoogleCloudDiscoveryengineV1ImportErrorConfig`	`getErrorConfig()` The desired location of errors incurred during the Import.
`GoogleCloudDiscoveryengineV1FhirStoreSource`	`getFhirStoreSource()` FhirStore input source.
`GoogleCloudDiscoveryengineV1FirestoreSource`	`getFirestoreSource()` Firestore input source.
`Boolean`	`getForceRefreshContent()` Optional.
`GoogleCloudDiscoveryengineV1GcsSource`	`getGcsSource()` 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.
`GoogleCloudDiscoveryengineV1ImportDocumentsRequestInlineSource`	`getInlineSource()` The Inline source for the input content for documents.
`String`	`getReconciliationMode()` The mode of reconciliation between existing documents and the documents to be imported.
`GoogleCloudDiscoveryengineV1SpannerSource`	`getSpannerSource()` Spanner input source.
`String`	`getUpdateMask()` Indicates which fields in the provided imported documents to update.
`GoogleCloudDiscoveryengineV1ImportDocumentsRequest`	`set(String fieldName, Object value)`
`GoogleCloudDiscoveryengineV1ImportDocumentsRequest`	`setAlloyDbSource(GoogleCloudDiscoveryengineV1AlloyDbSource alloyDbSource)` AlloyDB input source.
`GoogleCloudDiscoveryengineV1ImportDocumentsRequest`	`setAutoGenerateIds(Boolean autoGenerateIds)` Whether to automatically generate IDs for the documents if absent.
`GoogleCloudDiscoveryengineV1ImportDocumentsRequest`	`setBigquerySource(GoogleCloudDiscoveryengineV1BigQuerySource bigquerySource)` BigQuery input source.
`GoogleCloudDiscoveryengineV1ImportDocumentsRequest`	`setBigtableSource(GoogleCloudDiscoveryengineV1BigtableSource bigtableSource)` Cloud Bigtable input source.
`GoogleCloudDiscoveryengineV1ImportDocumentsRequest`	`setCloudSqlSource(GoogleCloudDiscoveryengineV1CloudSqlSource cloudSqlSource)` Cloud SQL input source.
`GoogleCloudDiscoveryengineV1ImportDocumentsRequest`	`setErrorConfig(GoogleCloudDiscoveryengineV1ImportErrorConfig errorConfig)` The desired location of errors incurred during the Import.
`GoogleCloudDiscoveryengineV1ImportDocumentsRequest`	`setFhirStoreSource(GoogleCloudDiscoveryengineV1FhirStoreSource fhirStoreSource)` FhirStore input source.
`GoogleCloudDiscoveryengineV1ImportDocumentsRequest`	`setFirestoreSource(GoogleCloudDiscoveryengineV1FirestoreSource firestoreSource)` Firestore input source.
`GoogleCloudDiscoveryengineV1ImportDocumentsRequest`	`setForceRefreshContent(Boolean forceRefreshContent)` Optional.
`GoogleCloudDiscoveryengineV1ImportDocumentsRequest`	`setGcsSource(GoogleCloudDiscoveryengineV1GcsSource gcsSource)` Cloud Storage location for the input content.
`GoogleCloudDiscoveryengineV1ImportDocumentsRequest`	`setIdField(String idField)` The field indicates the ID field or column to be used as unique IDs of the documents.
`GoogleCloudDiscoveryengineV1ImportDocumentsRequest`	`setInlineSource(GoogleCloudDiscoveryengineV1ImportDocumentsRequestInlineSource inlineSource)` The Inline source for the input content for documents.
`GoogleCloudDiscoveryengineV1ImportDocumentsRequest`	`setReconciliationMode(String reconciliationMode)` The mode of reconciliation between existing documents and the documents to be imported.
`GoogleCloudDiscoveryengineV1ImportDocumentsRequest`	`setSpannerSource(GoogleCloudDiscoveryengineV1SpannerSource spannerSource)` Spanner input source.
`GoogleCloudDiscoveryengineV1ImportDocumentsRequest`	`setUpdateMask(String updateMask)` Indicates which fields in the provided imported documents to update.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - GoogleCloudDiscoveryengineV1ImportDocumentsRequest
```
public GoogleCloudDiscoveryengineV1ImportDocumentsRequest()
```
- Method Detail
  - getAlloyDbSource
```
public GoogleCloudDiscoveryengineV1AlloyDbSource getAlloyDbSource()
```
    AlloyDB input source.
    
    Returns:
    
    value or null for none
  - setAlloyDbSource
```
public GoogleCloudDiscoveryengineV1ImportDocumentsRequest setAlloyDbSource(GoogleCloudDiscoveryengineV1AlloyDbSource alloyDbSource)
```
    AlloyDB input source.
    
    Parameters:
    
    alloyDbSource - alloyDbSource or null for none
  - 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.
    
    Returns:
    
    value or null for none
  - setAutoGenerateIds
```
public GoogleCloudDiscoveryengineV1ImportDocumentsRequest setAutoGenerateIds(Boolean autoGenerateIds)
```
    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.
    
    Parameters:
    
    autoGenerateIds - autoGenerateIds or null for none
  - getBigquerySource
```
public GoogleCloudDiscoveryengineV1BigQuerySource getBigquerySource()
```
    BigQuery input source.
    
    Returns:
    
    value or null for none
  - setBigquerySource
```
public GoogleCloudDiscoveryengineV1ImportDocumentsRequest setBigquerySource(GoogleCloudDiscoveryengineV1BigQuerySource bigquerySource)
```
    BigQuery input source.
    
    Parameters:
    
    bigquerySource - bigquerySource or null for none
  - getBigtableSource
```
public GoogleCloudDiscoveryengineV1BigtableSource getBigtableSource()
```
    Cloud Bigtable input source.
    
    Returns:
    
    value or null for none
  - setBigtableSource
```
public GoogleCloudDiscoveryengineV1ImportDocumentsRequest setBigtableSource(GoogleCloudDiscoveryengineV1BigtableSource bigtableSource)
```
    Cloud Bigtable input source.
    
    Parameters:
    
    bigtableSource - bigtableSource or null for none
  - getCloudSqlSource
```
public GoogleCloudDiscoveryengineV1CloudSqlSource getCloudSqlSource()
```
    Cloud SQL input source.
    
    Returns:
    
    value or null for none
  - setCloudSqlSource
```
public GoogleCloudDiscoveryengineV1ImportDocumentsRequest setCloudSqlSource(GoogleCloudDiscoveryengineV1CloudSqlSource cloudSqlSource)
```
    Cloud SQL input source.
    
    Parameters:
    
    cloudSqlSource - cloudSqlSource or null for none
  - getErrorConfig
```
public GoogleCloudDiscoveryengineV1ImportErrorConfig getErrorConfig()
```
    The desired location of errors incurred during the Import.
    
    Returns:
    
    value or null for none
  - setErrorConfig
```
public GoogleCloudDiscoveryengineV1ImportDocumentsRequest setErrorConfig(GoogleCloudDiscoveryengineV1ImportErrorConfig errorConfig)
```
    The desired location of errors incurred during the Import.
    
    Parameters:
    
    errorConfig - errorConfig or null for none
  - getFhirStoreSource
```
public GoogleCloudDiscoveryengineV1FhirStoreSource getFhirStoreSource()
```
    FhirStore input source.
    
    Returns:
    
    value or null for none
  - setFhirStoreSource
```
public GoogleCloudDiscoveryengineV1ImportDocumentsRequest setFhirStoreSource(GoogleCloudDiscoveryengineV1FhirStoreSource fhirStoreSource)
```
    FhirStore input source.
    
    Parameters:
    
    fhirStoreSource - fhirStoreSource or null for none
  - getFirestoreSource
```
public GoogleCloudDiscoveryengineV1FirestoreSource getFirestoreSource()
```
    Firestore input source.
    
    Returns:
    
    value or null for none
  - setFirestoreSource
```
public GoogleCloudDiscoveryengineV1ImportDocumentsRequest setFirestoreSource(GoogleCloudDiscoveryengineV1FirestoreSource firestoreSource)
```
    Firestore input source.
    
    Parameters:
    
    firestoreSource - firestoreSource or null for none
  - getForceRefreshContent
```
public Boolean getForceRefreshContent()
```
    Optional. Whether to force refresh the unstructured content of the documents. If set to `true`, the content part of the documents will be refreshed regardless of the update status of the referencing content.
    
    Returns:
    
    value or null for none
  - setForceRefreshContent
```
public GoogleCloudDiscoveryengineV1ImportDocumentsRequest setForceRefreshContent(Boolean forceRefreshContent)
```
    Optional. Whether to force refresh the unstructured content of the documents. If set to `true`, the content part of the documents will be refreshed regardless of the update status of the referencing content.
    
    Parameters:
    
    forceRefreshContent - forceRefreshContent or null for none
  - getGcsSource
```
public GoogleCloudDiscoveryengineV1GcsSource getGcsSource()
```
    Cloud Storage location for the input content.
    
    Returns:
    
    value or null for none
  - setGcsSource
```
public GoogleCloudDiscoveryengineV1ImportDocumentsRequest setGcsSource(GoogleCloudDiscoveryengineV1GcsSource gcsSource)
```
    Cloud Storage location for the input content.
    
    Parameters:
    
    gcsSource - gcsSource or null for none
  - 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](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 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. * BigtableSource.
    
    Returns:
    
    value or null for none
  - setIdField
```
public GoogleCloudDiscoveryengineV1ImportDocumentsRequest setIdField(String idField)
```
    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](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 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. * BigtableSource.
    
    Parameters:
    
    idField - idField or null for none
  - getInlineSource
```
public GoogleCloudDiscoveryengineV1ImportDocumentsRequestInlineSource getInlineSource()
```
    The Inline source for the input content for documents.
    
    Returns:
    
    value or null for none
  - setInlineSource
```
public GoogleCloudDiscoveryengineV1ImportDocumentsRequest setInlineSource(GoogleCloudDiscoveryengineV1ImportDocumentsRequestInlineSource inlineSource)
```
    The Inline source for the input content for documents.
    
    Parameters:
    
    inlineSource - inlineSource or null for none
  - getReconciliationMode
```
public String getReconciliationMode()
```
    The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL.
    
    Returns:
    
    value or null for none
  - setReconciliationMode
```
public GoogleCloudDiscoveryengineV1ImportDocumentsRequest setReconciliationMode(String reconciliationMode)
```
    The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL.
    
    Parameters:
    
    reconciliationMode - reconciliationMode or null for none
  - getSpannerSource
```
public GoogleCloudDiscoveryengineV1SpannerSource getSpannerSource()
```
    Spanner input source.
    
    Returns:
    
    value or null for none
  - setSpannerSource
```
public GoogleCloudDiscoveryengineV1ImportDocumentsRequest setSpannerSource(GoogleCloudDiscoveryengineV1SpannerSource spannerSource)
```
    Spanner input source.
    
    Parameters:
    
    spannerSource - spannerSource or null for none
  - getUpdateMask
```
public String getUpdateMask()
```
    Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields.
    
    Returns:
    
    value or null for none
  - setUpdateMask
```
public GoogleCloudDiscoveryengineV1ImportDocumentsRequest setUpdateMask(String updateMask)
```
    Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields.
    
    Parameters:
    
    updateMask - updateMask or null for none
  - set
```
public GoogleCloudDiscoveryengineV1ImportDocumentsRequest set(String fieldName,
                                                              Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public GoogleCloudDiscoveryengineV1ImportDocumentsRequest clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class GoogleCloudDiscoveryengineV1ImportDocumentsRequest

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

GoogleCloudDiscoveryengineV1ImportDocumentsRequest

Method Detail

getAlloyDbSource

setAlloyDbSource

getAutoGenerateIds

setAutoGenerateIds

getBigquerySource

setBigquerySource

getBigtableSource

setBigtableSource

getCloudSqlSource

setCloudSqlSource

getErrorConfig

setErrorConfig

getFhirStoreSource

setFhirStoreSource

getFirestoreSource

setFirestoreSource

getForceRefreshContent

setForceRefreshContent

getGcsSource

setGcsSource

getIdField

setIdField

getInlineSource

setInlineSource

getReconciliationMode

setReconciliationMode

getSpannerSource

setSpannerSource

getUpdateMask

setUpdateMask

set

clone