Package com.google.cloud.discoveryengine.v1

Class 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.v1.ImportDocumentsRequest
    See Also:
    Serialized Form

    • 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

      • 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

      • AUTO_GENERATE_IDS_FIELD_NUMBER

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

      • hasInlineSource

        public boolean hasInlineSource()
         The Inline source for the input content for documents.
        .google.cloud.discoveryengine.v1.ImportDocumentsRequest.InlineSource inline_source = 2;
        Specified by:
        hasInlineSource in interface ImportDocumentsRequestOrBuilder
        Returns:
        Whether the inlineSource field is set.

      • hasGcsSource

        public boolean hasGcsSource()
         Cloud Storage location for the input content.
        .google.cloud.discoveryengine.v1.GcsSource gcs_source = 3;
        Specified by:
        hasGcsSource in interface ImportDocumentsRequestOrBuilder
        Returns:
        Whether the gcsSource field is set.

      • hasBigquerySource

        public boolean hasBigquerySource()
         BigQuery input source.
        .google.cloud.discoveryengine.v1.BigQuerySource bigquery_source = 4;
        Specified by:
        hasBigquerySource in interface ImportDocumentsRequestOrBuilder
        Returns:
        Whether the bigquerySource field is set.

      • 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.v1.ImportErrorConfig error_config = 5;
        Specified by:
        hasErrorConfig in interface ImportDocumentsRequestOrBuilder
        Returns:
        Whether the errorConfig field is set.

      • 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.INCREMENTAL].
        .google.cloud.discoveryengine.v1.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.v1.ImportDocumentsRequest.ReconciliationMode.INCREMENTAL].
        .google.cloud.discoveryengine.v1.ImportDocumentsRequest.ReconciliationMode reconciliation_mode = 6;
        Specified by:
        getReconciliationMode in interface ImportDocumentsRequestOrBuilder
        Returns:
        The reconciliationMode.

      • getAutoGenerateIds

        public boolean getAutoGenerateIds()
         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.

 Only set this field when using
 [GcsSource][google.cloud.discoveryengine.v1.GcsSource] or
 [BigQuerySource][google.cloud.discoveryengine.v1.BigQuerySource], and when
 [GcsSource.data_schema][google.cloud.discoveryengine.v1.GcsSource.data_schema]
 or
 [BigQuerySource.data_schema][google.cloud.discoveryengine.v1.BigQuerySource.data_schema]
 is `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
        bool auto_generate_ids = 8;
        Specified by:
        getAutoGenerateIds in interface ImportDocumentsRequestOrBuilder
        Returns:
        The autoGenerateIds.

      • getIdField

        public String getIdField()
         The field in the Cloud Storage and BigQuery sources that indicates the
 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 [BigQuerySource][google.cloud.discoveryengine.v1.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.id][google.cloud.discoveryengine.v1.Document.id]s. 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](https://tools.ietf.org/html/rfc1034)
 with 1-63 characters. Otherwise, documents without valid IDs fail to be
 imported.

 Only set this field when using
 [GcsSource][google.cloud.discoveryengine.v1.GcsSource] or
 [BigQuerySource][google.cloud.discoveryengine.v1.BigQuerySource], and when
 [GcsSource.data_schema][google.cloud.discoveryengine.v1.GcsSource.data_schema]
 or
 [BigQuerySource.data_schema][google.cloud.discoveryengine.v1.BigQuerySource.data_schema]
 is `custom`. And 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.
        string id_field = 9;
        Specified by:
        getIdField in interface ImportDocumentsRequestOrBuilder
        Returns:
        The idField.

      • getIdFieldBytes

        public com.google.protobuf.ByteString getIdFieldBytes()
         The field in the Cloud Storage and BigQuery sources that indicates the
 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 [BigQuerySource][google.cloud.discoveryengine.v1.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.id][google.cloud.discoveryengine.v1.Document.id]s. 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](https://tools.ietf.org/html/rfc1034)
 with 1-63 characters. Otherwise, documents without valid IDs fail to be
 imported.

 Only set this field when using
 [GcsSource][google.cloud.discoveryengine.v1.GcsSource] or
 [BigQuerySource][google.cloud.discoveryengine.v1.BigQuerySource], and when
 [GcsSource.data_schema][google.cloud.discoveryengine.v1.GcsSource.data_schema]
 or
 [BigQuerySource.data_schema][google.cloud.discoveryengine.v1.BigQuerySource.data_schema]
 is `custom`. And 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.
        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

      • newBuilderForType

        public ImportDocumentsRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • 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

      • 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