Interface IngestPipelineConfigOrBuilder (0.50.0) 

public interface IngestPipelineConfigOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getCloudFunction()

public abstract String getCloudFunction()

The Cloud Function resource name. The Cloud Function needs to live inside consumer project and is accessible to Document AI Warehouse P4SA. Only Cloud Functions V2 is supported. Cloud function execution should complete within 5 minutes or this file ingestion may fail due to timeout. Format: https://{region}-{project_id}.cloudfunctions.net/{cloud_function} The following keys are available the request json payload.

  • display_name
  • properties
  • plain_text
  • reference_id
  • document_schema_name
  • raw_document_path

  • raw_document_file_type

    The following keys from the cloud function json response payload will be ingested to the Document AI Warehouse as part of Document proto content and/or related information. The original values will be overridden if any key is present in the response.

  • display_name
  • properties
  • plain_text
  • document_acl_policy
  • folder

string cloud_function = 4 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The cloudFunction.

getCloudFunctionBytes()

public abstract ByteString getCloudFunctionBytes()

The Cloud Function resource name. The Cloud Function needs to live inside consumer project and is accessible to Document AI Warehouse P4SA. Only Cloud Functions V2 is supported. Cloud function execution should complete within 5 minutes or this file ingestion may fail due to timeout. Format: https://{region}-{project_id}.cloudfunctions.net/{cloud_function} The following keys are available the request json payload.

  • display_name
  • properties
  • plain_text
  • reference_id
  • document_schema_name
  • raw_document_path

  • raw_document_file_type

    The following keys from the cloud function json response payload will be ingested to the Document AI Warehouse as part of Document proto content and/or related information. The original values will be overridden if any key is present in the response.

  • display_name
  • properties
  • plain_text
  • document_acl_policy
  • folder

string cloud_function = 4 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for cloudFunction.

getDocumentAclPolicy()

public abstract 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 and members 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
Type Description
com.google.iam.v1.Policy

The documentAclPolicy.

getDocumentAclPolicyOrBuilder()

public abstract 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 and members 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
Type Description
com.google.iam.v1.PolicyOrBuilder

getEnableDocumentTextExtraction()

public abstract 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
Type Description
boolean

The enableDocumentTextExtraction.

getFolder()

public abstract 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
Type Description
String

The folder.

getFolderBytes()

public abstract 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
Type Description
ByteString

The bytes for folder.

hasDocumentAclPolicy()

public abstract 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 and members 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
Type Description
boolean

Whether the documentAclPolicy field is set.