Package com.google.cloud.contentwarehouse.v1

Interface IngestPipelineConfigOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    IngestPipelineConfig, IngestPipelineConfig.Builder
    public interface IngestPipelineConfigOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      com.google.iam.v1.Policy getDocumentAclPolicy()
      The document level acl policy config.
      com.google.iam.v1.PolicyOrBuilder getDocumentAclPolicyOrBuilder()
      The document level acl policy config.
      boolean getEnableDocumentTextExtraction()
      The document text extraction enabled flag.
      String getFolder()
      Optional.
      com.google.protobuf.ByteString getFolderBytes()
      Optional.
      boolean hasDocumentAclPolicy()
      The document level acl policy config.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • hasDocumentAclPolicy

        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;
        Returns:
        Whether the documentAclPolicy field is set.

      • getDocumentAclPolicy

        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;
        Returns:
        The documentAclPolicy.

      • getDocumentAclPolicyOrBuilder

        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;

      • getEnableDocumentTextExtraction

        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;
        Returns:
        The enableDocumentTextExtraction.

      • getFolder

        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];
        Returns:
        The folder.

      • getFolderBytes

        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];
        Returns:
        The bytes for folder.