Class IngestPipelineConfig (0.45.0)

Version 0.45.0

• 0.49.0 (latest)
• 0.48.0
• 0.47.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public final class IngestPipelineConfig extends GeneratedMessageV3 implements IngestPipelineConfigOrBuilder

The ingestion pipeline config.

Protobuf type google.cloud.contentwarehouse.v1.IngestPipelineConfig

Inheritance

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

Implements

IngestPipelineConfigOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

AbstractMessage.equals(Object other)

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:[e-mail]
• group:[e-mail] 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:[e-mail]
• group:[e-mail] 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

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

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:[e-mail]
• group:[e-mail] 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

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

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

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public IngestPipelineConfig.Builder toBuilder()

Returns
Type	Description
IngestPipelineConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException