Class ImportDocumentsRequest (0.24.0)

public final class ImportDocumentsRequest extends GeneratedMessageV3 implements ImportDocumentsRequestOrBuilder

Request message for Import methods.

Protobuf type google.cloud.discoveryengine.v1.ImportDocumentsRequest

Static Fields

AUTO_GENERATE_IDS_FIELD_NUMBER

public static final int AUTO_GENERATE_IDS_FIELD_NUMBER
Field Value
TypeDescription
int

BIGQUERY_SOURCE_FIELD_NUMBER

public static final int BIGQUERY_SOURCE_FIELD_NUMBER
Field Value
TypeDescription
int

ERROR_CONFIG_FIELD_NUMBER

public static final int ERROR_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

GCS_SOURCE_FIELD_NUMBER

public static final int GCS_SOURCE_FIELD_NUMBER
Field Value
TypeDescription
int

ID_FIELD_FIELD_NUMBER

public static final int ID_FIELD_FIELD_NUMBER
Field Value
TypeDescription
int

INLINE_SOURCE_FIELD_NUMBER

public static final int INLINE_SOURCE_FIELD_NUMBER
Field Value
TypeDescription
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
TypeDescription
int

RECONCILIATION_MODE_FIELD_NUMBER

public static final int RECONCILIATION_MODE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ImportDocumentsRequest getDefaultInstance()
Returns
TypeDescription
ImportDocumentsRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ImportDocumentsRequest.Builder newBuilder()
Returns
TypeDescription
ImportDocumentsRequest.Builder

newBuilder(ImportDocumentsRequest prototype)

public static ImportDocumentsRequest.Builder newBuilder(ImportDocumentsRequest prototype)
Parameter
NameDescription
prototypeImportDocumentsRequest
Returns
TypeDescription
ImportDocumentsRequest.Builder

parseDelimitedFrom(InputStream input)

public static ImportDocumentsRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ImportDocumentsRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ImportDocumentsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImportDocumentsRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ImportDocumentsRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ImportDocumentsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ImportDocumentsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImportDocumentsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ImportDocumentsRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ImportDocumentsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ImportDocumentsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImportDocumentsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ImportDocumentsRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ImportDocumentsRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ImportDocumentsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImportDocumentsRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ImportDocumentsRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ImportDocumentsRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ImportDocumentsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImportDocumentsRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ImportDocumentsRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ImportDocumentsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ImportDocumentsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ImportDocumentsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ImportDocumentsRequest> parser()
Returns
TypeDescription
Parser<ImportDocumentsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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.

Only set this field when using GcsSource or BigQuerySource, and when GcsSource.data_schema or BigQuerySource.data_schema is custom or csv. Otherwise, an INVALID_ARGUMENT error is thrown.

bool auto_generate_ids = 8;

Returns
TypeDescription
boolean

The autoGenerateIds.

getBigquerySource()

public BigQuerySource getBigquerySource()

BigQuery input source.

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

Returns
TypeDescription
BigQuerySource

The bigquerySource.

getBigquerySourceOrBuilder()

public BigQuerySourceOrBuilder getBigquerySourceOrBuilder()

BigQuery input source.

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

Returns
TypeDescription
BigQuerySourceOrBuilder

getDefaultInstanceForType()

public ImportDocumentsRequest getDefaultInstanceForType()
Returns
TypeDescription
ImportDocumentsRequest

getErrorConfig()

public ImportErrorConfig getErrorConfig()

The desired location of errors incurred during the Import.

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

Returns
TypeDescription
ImportErrorConfig

The errorConfig.

getErrorConfigOrBuilder()

public ImportErrorConfigOrBuilder getErrorConfigOrBuilder()

The desired location of errors incurred during the Import.

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

Returns
TypeDescription
ImportErrorConfigOrBuilder

getGcsSource()

public GcsSource getGcsSource()

Cloud Storage location for the input content.

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

Returns
TypeDescription
GcsSource

The gcsSource.

getGcsSourceOrBuilder()

public GcsSourceOrBuilder getGcsSourceOrBuilder()

Cloud Storage location for the input content.

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

Returns
TypeDescription
GcsSourceOrBuilder

getIdField()

public String getIdField()

The field in the Cloud Storage and BigQuery sources that indicates the 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 BigQuerySource it is the column name of the BigQuery table where the unique ids are stored.

The values of the JSON field or the BigQuery column are used as the Document.ids. The JSON field or the BigQuery 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 using GcsSource or BigQuerySource, and when GcsSource.data_schema or BigQuerySource.data_schema is custom. And 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.

string id_field = 9;

Returns
TypeDescription
String

The idField.

getIdFieldBytes()

public ByteString getIdFieldBytes()

The field in the Cloud Storage and BigQuery sources that indicates the 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 BigQuerySource it is the column name of the BigQuery table where the unique ids are stored.

The values of the JSON field or the BigQuery column are used as the Document.ids. The JSON field or the BigQuery 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 using GcsSource or BigQuerySource, and when GcsSource.data_schema or BigQuerySource.data_schema is custom. And 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.

string id_field = 9;

Returns
TypeDescription
ByteString

The bytes for idField.

getInlineSource()

public ImportDocumentsRequest.InlineSource getInlineSource()

The Inline source for the input content for documents.

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

Returns
TypeDescription
ImportDocumentsRequest.InlineSource

The inlineSource.

getInlineSourceOrBuilder()

public ImportDocumentsRequest.InlineSourceOrBuilder getInlineSourceOrBuilder()

The Inline source for the input content for documents.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for parent.

getParserForType()

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

Returns
TypeDescription
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.v1.ImportDocumentsRequest.ReconciliationMode reconciliation_mode = 6;

Returns
TypeDescription
int

The enum numeric value on the wire for reconciliationMode.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSourceCase()

public ImportDocumentsRequest.SourceCase getSourceCase()
Returns
TypeDescription
ImportDocumentsRequest.SourceCase

hasBigquerySource()

public boolean hasBigquerySource()

BigQuery input source.

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

Returns
TypeDescription
boolean

Whether the bigquerySource field is set.

hasErrorConfig()

public boolean hasErrorConfig()

The desired location of errors incurred during the Import.

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

Returns
TypeDescription
boolean

Whether the errorConfig field is set.

hasGcsSource()

public boolean hasGcsSource()

Cloud Storage location for the input content.

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

Returns
TypeDescription
boolean

Whether the gcsSource field is set.

hasInlineSource()

public boolean hasInlineSource()

The Inline source for the input content for documents.

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

Returns
TypeDescription
boolean

Whether the inlineSource field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ImportDocumentsRequest.Builder newBuilderForType()
Returns
TypeDescription
ImportDocumentsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ImportDocumentsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ImportDocumentsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ImportDocumentsRequest.Builder toBuilder()
Returns
TypeDescription
ImportDocumentsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException