Class IngestPipelineConfig.Builder (0.42.0) 

public static final class IngestPipelineConfig.Builder extends GeneratedMessageV3.Builder<IngestPipelineConfig.Builder> implements IngestPipelineConfigOrBuilder

The ingestion pipeline config.

Protobuf type google.cloud.contentwarehouse.v1.IngestPipelineConfig

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > IngestPipelineConfig.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public IngestPipelineConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
IngestPipelineConfig.Builder
Overrides

build()

public IngestPipelineConfig build()
Returns
Type Description
IngestPipelineConfig

buildPartial()

public IngestPipelineConfig buildPartial()
Returns
Type Description
IngestPipelineConfig

clear()

public IngestPipelineConfig.Builder clear()
Returns
Type Description
IngestPipelineConfig.Builder
Overrides

clearCloudFunction()

public IngestPipelineConfig.Builder clearCloudFunction()

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
IngestPipelineConfig.Builder

This builder for chaining.

clearDocumentAclPolicy()

public IngestPipelineConfig.Builder clearDocumentAclPolicy()

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
IngestPipelineConfig.Builder

clearEnableDocumentTextExtraction()

public IngestPipelineConfig.Builder clearEnableDocumentTextExtraction()

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
IngestPipelineConfig.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public IngestPipelineConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
IngestPipelineConfig.Builder
Overrides

clearFolder()

public IngestPipelineConfig.Builder clearFolder()

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
IngestPipelineConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public IngestPipelineConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
IngestPipelineConfig.Builder
Overrides

clone()

public IngestPipelineConfig.Builder clone()
Returns
Type Description
IngestPipelineConfig.Builder
Overrides

getCloudFunction()

public 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 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.

getDefaultInstanceForType()

public IngestPipelineConfig getDefaultInstanceForType()
Returns
Type Description
IngestPipelineConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDocumentAclPolicy()

public 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.

getDocumentAclPolicyBuilder()

public Policy.Builder getDocumentAclPolicyBuilder()

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.Builder

getDocumentAclPolicyOrBuilder()

public 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 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 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 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 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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeDocumentAclPolicy(Policy value)

public IngestPipelineConfig.Builder mergeDocumentAclPolicy(Policy value)

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;

Parameter
Name Description
value com.google.iam.v1.Policy
Returns
Type Description
IngestPipelineConfig.Builder

mergeFrom(IngestPipelineConfig other)

public IngestPipelineConfig.Builder mergeFrom(IngestPipelineConfig other)
Parameter
Name Description
other IngestPipelineConfig
Returns
Type Description
IngestPipelineConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public IngestPipelineConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IngestPipelineConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public IngestPipelineConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
IngestPipelineConfig.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final IngestPipelineConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
IngestPipelineConfig.Builder
Overrides

setCloudFunction(String value)

public IngestPipelineConfig.Builder setCloudFunction(String value)

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) = { ... }

Parameter
Name Description
value String

The cloudFunction to set.
Returns
Type Description
IngestPipelineConfig.Builder

This builder for chaining.

setCloudFunctionBytes(ByteString value)

public IngestPipelineConfig.Builder setCloudFunctionBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for cloudFunction to set.
Returns
Type Description
IngestPipelineConfig.Builder

This builder for chaining.

setDocumentAclPolicy(Policy value)

public IngestPipelineConfig.Builder setDocumentAclPolicy(Policy value)

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;

Parameter
Name Description
value com.google.iam.v1.Policy
Returns
Type Description
IngestPipelineConfig.Builder

setDocumentAclPolicy(Policy.Builder builderForValue)

public IngestPipelineConfig.Builder setDocumentAclPolicy(Policy.Builder builderForValue)

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;

Parameter
Name Description
builderForValue com.google.iam.v1.Policy.Builder
Returns
Type Description
IngestPipelineConfig.Builder

setEnableDocumentTextExtraction(boolean value)

public IngestPipelineConfig.Builder setEnableDocumentTextExtraction(boolean value)

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;

Parameter
Name Description
value boolean

The enableDocumentTextExtraction to set.
Returns
Type Description
IngestPipelineConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public IngestPipelineConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
IngestPipelineConfig.Builder
Overrides

setFolder(String value)

public IngestPipelineConfig.Builder setFolder(String value)

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];

Parameter
Name Description
value String

The folder to set.
Returns
Type Description
IngestPipelineConfig.Builder

This builder for chaining.

setFolderBytes(ByteString value)

public IngestPipelineConfig.Builder setFolderBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for folder to set.
Returns
Type Description
IngestPipelineConfig.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public IngestPipelineConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
IngestPipelineConfig.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final IngestPipelineConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
IngestPipelineConfig.Builder
Overrides