Class IngestPipelineConfig (0.38.0)

public final class IngestPipelineConfig extends GeneratedMessageV3 implements IngestPipelineConfigOrBuilder

The ingestion pipeline config.

Protobuf type google.cloud.contentwarehouse.v1.IngestPipelineConfig

Static Fields

CLOUD_FUNCTION_FIELD_NUMBER

public static final int CLOUD_FUNCTION_FIELD_NUMBER
Field Value
Type Description
int

DOCUMENT_ACL_POLICY_FIELD_NUMBER

public static final int DOCUMENT_ACL_POLICY_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_DOCUMENT_TEXT_EXTRACTION_FIELD_NUMBER

public static final int ENABLE_DOCUMENT_TEXT_EXTRACTION_FIELD_NUMBER
Field Value
Type Description
int

FOLDER_FIELD_NUMBER

public static final int FOLDER_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static IngestPipelineConfig getDefaultInstance()
Returns
Type Description
IngestPipelineConfig

getDescriptor()

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

newBuilder()

public static IngestPipelineConfig.Builder newBuilder()
Returns
Type Description
IngestPipelineConfig.Builder

newBuilder(IngestPipelineConfig prototype)

public static IngestPipelineConfig.Builder newBuilder(IngestPipelineConfig prototype)
Parameter
Name Description
prototype IngestPipelineConfig
Returns
Type Description
IngestPipelineConfig.Builder

parseDelimitedFrom(InputStream input)

public static IngestPipelineConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
IngestPipelineConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static IngestPipelineConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IngestPipelineConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static IngestPipelineConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
IngestPipelineConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static IngestPipelineConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IngestPipelineConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static IngestPipelineConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
IngestPipelineConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static IngestPipelineConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IngestPipelineConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static IngestPipelineConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
IngestPipelineConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static IngestPipelineConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IngestPipelineConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static IngestPipelineConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
IngestPipelineConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static IngestPipelineConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IngestPipelineConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static IngestPipelineConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
IngestPipelineConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static IngestPipelineConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IngestPipelineConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<IngestPipelineConfig> parser()
Returns
Type Description
Parser<IngestPipelineConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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

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.

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.

getParserForType()

public Parser<IngestPipelineConfig> getParserForType()
Returns
Type Description
Parser<IngestPipelineConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public IngestPipelineConfig.Builder newBuilderForType()
Returns
Type Description
IngestPipelineConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected IngestPipelineConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
IngestPipelineConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public IngestPipelineConfig.Builder toBuilder()
Returns
Type Description
IngestPipelineConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException