Package com.google.cloud.contentwarehouse.v1

Class IngestPipelineConfig

  • All Implemented Interfaces:
    IngestPipelineConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class IngestPipelineConfig
extends com.google.protobuf.GeneratedMessageV3
implements IngestPipelineConfigOrBuilder
     The ingestion pipeline config.
    Protobuf type google.cloud.contentwarehouse.v1.IngestPipelineConfig
    See Also:
    Serialized Form

    • Field Detail

      • DOCUMENT_ACL_POLICY_FIELD_NUMBER

        public static final int DOCUMENT_ACL_POLICY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ENABLE_DOCUMENT_TEXT_EXTRACTION_FIELD_NUMBER

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

      • hasDocumentAclPolicy

        public boolean hasDocumentAclPolicy()
         The document level acl policy config.
 This refers to an Identity and Access (IAM) policy, which specifies access
 controls for all documents ingested by the pipeline. The
 [role][google.iam.v1.Binding.role] and
 [members][google.iam.v1.Binding.role] under the policy needs to be
 specified.

 The following roles are supported for document level acl control:
 * roles/contentwarehouse.documentAdmin
 * roles/contentwarehouse.documentEditor
 * roles/contentwarehouse.documentViewer

 The following members are supported for document level acl control:
 * user:user-email@example.com
 * group:group-email@example.com
 Note that for documents searched with LLM, only single level user or group
 acl check is supported.
        .google.iam.v1.Policy document_acl_policy = 1;
        Specified by:
        hasDocumentAclPolicy in interface IngestPipelineConfigOrBuilder
        Returns:
        Whether the documentAclPolicy field is set.

      • getDocumentAclPolicy

        public com.google.iam.v1.Policy getDocumentAclPolicy()
         The document level acl policy config.
 This refers to an Identity and Access (IAM) policy, which specifies access
 controls for all documents ingested by the pipeline. The
 [role][google.iam.v1.Binding.role] and
 [members][google.iam.v1.Binding.role] under the policy needs to be
 specified.

 The following roles are supported for document level acl control:
 * roles/contentwarehouse.documentAdmin
 * roles/contentwarehouse.documentEditor
 * roles/contentwarehouse.documentViewer

 The following members are supported for document level acl control:
 * user:user-email@example.com
 * group:group-email@example.com
 Note that for documents searched with LLM, only single level user or group
 acl check is supported.
        .google.iam.v1.Policy document_acl_policy = 1;
        Specified by:
        getDocumentAclPolicy in interface IngestPipelineConfigOrBuilder
        Returns:
        The documentAclPolicy.

      • getDocumentAclPolicyOrBuilder

        public com.google.iam.v1.PolicyOrBuilder getDocumentAclPolicyOrBuilder()
         The document level acl policy config.
 This refers to an Identity and Access (IAM) policy, which specifies access
 controls for all documents ingested by the pipeline. The
 [role][google.iam.v1.Binding.role] and
 [members][google.iam.v1.Binding.role] under the policy needs to be
 specified.

 The following roles are supported for document level acl control:
 * roles/contentwarehouse.documentAdmin
 * roles/contentwarehouse.documentEditor
 * roles/contentwarehouse.documentViewer

 The following members are supported for document level acl control:
 * user:user-email@example.com
 * group:group-email@example.com
 Note that for documents searched with LLM, only single level user or group
 acl check is supported.
        .google.iam.v1.Policy document_acl_policy = 1;
        Specified by:
        getDocumentAclPolicyOrBuilder in interface IngestPipelineConfigOrBuilder

      • getEnableDocumentTextExtraction

        public boolean getEnableDocumentTextExtraction()
         The document text extraction enabled flag.
 If the flag is set to true, DWH will perform text extraction on the raw
 document.
        bool enable_document_text_extraction = 2;
        Specified by:
        getEnableDocumentTextExtraction in interface IngestPipelineConfigOrBuilder
        Returns:
        The enableDocumentTextExtraction.

      • getFolder

        public String getFolder()
         Optional. The name of the folder to which all ingested documents will be
 linked during ingestion process. Format is
 `projects/{project}/locations/{location}/documents/{folder_id}`
        string folder = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getFolder in interface IngestPipelineConfigOrBuilder
        Returns:
        The folder.

      • getFolderBytes

        public com.google.protobuf.ByteString getFolderBytes()
         Optional. The name of the folder to which all ingested documents will be
 linked during ingestion process. Format is
 `projects/{project}/locations/{location}/documents/{folder_id}`
        string folder = 3 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getFolderBytes in interface IngestPipelineConfigOrBuilder
        Returns:
        The bytes for folder.

      • 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 IngestPipelineConfig parseFrom​(ByteBuffer data)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static IngestPipelineConfig parseFrom​(ByteBuffer data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static IngestPipelineConfig parseFrom​(com.google.protobuf.ByteString data)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static IngestPipelineConfig parseFrom​(com.google.protobuf.ByteString data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static IngestPipelineConfig parseFrom​(byte[] data)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static IngestPipelineConfig parseFrom​(byte[] data,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • newBuilderForType

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

      • toBuilder

        public IngestPipelineConfig.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected IngestPipelineConfig.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<IngestPipelineConfig> 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 IngestPipelineConfig getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder