Class GcsIngestWithDocAiProcessorsPipeline (0.37.0)

Version latest

• 0.37.0 (latest)
• 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 GcsIngestWithDocAiProcessorsPipeline extends GeneratedMessageV3 implements GcsIngestWithDocAiProcessorsPipelineOrBuilder

The configuration of the Cloud Storage Ingestion with DocAI Processors pipeline.

Protobuf type google.cloud.contentwarehouse.v1.GcsIngestWithDocAiProcessorsPipeline

Inheritance

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

Implements

GcsIngestWithDocAiProcessorsPipelineOrBuilder

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

EXTRACT_PROCESSOR_INFOS_FIELD_NUMBER

public static final int EXTRACT_PROCESSOR_INFOS_FIELD_NUMBER

Field Value
Type	Description
int

INPUT_PATH_FIELD_NUMBER

public static final int INPUT_PATH_FIELD_NUMBER

Field Value
Type	Description
int

PIPELINE_CONFIG_FIELD_NUMBER

public static final int PIPELINE_CONFIG_FIELD_NUMBER

Field Value
Type	Description
int

PROCESSOR_RESULTS_FOLDER_PATH_FIELD_NUMBER

public static final int PROCESSOR_RESULTS_FOLDER_PATH_FIELD_NUMBER

Field Value
Type	Description
int

SKIP_INGESTED_DOCUMENTS_FIELD_NUMBER

public static final int SKIP_INGESTED_DOCUMENTS_FIELD_NUMBER

Field Value
Type	Description
int

SPLIT_CLASSIFY_PROCESSOR_INFO_FIELD_NUMBER

public static final int SPLIT_CLASSIFY_PROCESSOR_INFO_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static GcsIngestWithDocAiProcessorsPipeline getDefaultInstance()

Returns
Type	Description
GcsIngestWithDocAiProcessorsPipeline

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static GcsIngestWithDocAiProcessorsPipeline.Builder newBuilder()

Returns
Type	Description
GcsIngestWithDocAiProcessorsPipeline.Builder

newBuilder(GcsIngestWithDocAiProcessorsPipeline prototype)

public static GcsIngestWithDocAiProcessorsPipeline.Builder newBuilder(GcsIngestWithDocAiProcessorsPipeline prototype)

Parameter
Name	Description
prototype	GcsIngestWithDocAiProcessorsPipeline

Returns
Type	Description
GcsIngestWithDocAiProcessorsPipeline.Builder

parseDelimitedFrom(InputStream input)

public static GcsIngestWithDocAiProcessorsPipeline parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
GcsIngestWithDocAiProcessorsPipeline

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GcsIngestWithDocAiProcessorsPipeline parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
GcsIngestWithDocAiProcessorsPipeline

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static GcsIngestWithDocAiProcessorsPipeline parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
GcsIngestWithDocAiProcessorsPipeline

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static GcsIngestWithDocAiProcessorsPipeline parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
GcsIngestWithDocAiProcessorsPipeline

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static GcsIngestWithDocAiProcessorsPipeline parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
GcsIngestWithDocAiProcessorsPipeline

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static GcsIngestWithDocAiProcessorsPipeline parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
GcsIngestWithDocAiProcessorsPipeline

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static GcsIngestWithDocAiProcessorsPipeline parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
GcsIngestWithDocAiProcessorsPipeline

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static GcsIngestWithDocAiProcessorsPipeline parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
GcsIngestWithDocAiProcessorsPipeline

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static GcsIngestWithDocAiProcessorsPipeline parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
GcsIngestWithDocAiProcessorsPipeline

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GcsIngestWithDocAiProcessorsPipeline parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
GcsIngestWithDocAiProcessorsPipeline

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static GcsIngestWithDocAiProcessorsPipeline parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
GcsIngestWithDocAiProcessorsPipeline

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static GcsIngestWithDocAiProcessorsPipeline parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
GcsIngestWithDocAiProcessorsPipeline

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<GcsIngestWithDocAiProcessorsPipeline> parser()

Returns
Type	Description
Parser<GcsIngestWithDocAiProcessorsPipeline>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public GcsIngestWithDocAiProcessorsPipeline getDefaultInstanceForType()

Returns
Type	Description
GcsIngestWithDocAiProcessorsPipeline

getExtractProcessorInfos(int index)

public ProcessorInfo getExtractProcessorInfos(int index)

The extract processors information. One matched extract processor will be used to process documents based on the classify processor result. If no classify processor is specified, the first extract processor will be used.

repeated .google.cloud.contentwarehouse.v1.ProcessorInfo extract_processor_infos = 3;

Parameter
Name	Description
index	int

Returns
Type	Description
ProcessorInfo

getExtractProcessorInfosCount()

public int getExtractProcessorInfosCount()

The extract processors information. One matched extract processor will be used to process documents based on the classify processor result. If no classify processor is specified, the first extract processor will be used.

repeated .google.cloud.contentwarehouse.v1.ProcessorInfo extract_processor_infos = 3;

Returns
Type	Description
int

getExtractProcessorInfosList()

public List<ProcessorInfo> getExtractProcessorInfosList()

The extract processors information. One matched extract processor will be used to process documents based on the classify processor result. If no classify processor is specified, the first extract processor will be used.

repeated .google.cloud.contentwarehouse.v1.ProcessorInfo extract_processor_infos = 3;

Returns
Type	Description
List<ProcessorInfo>

getExtractProcessorInfosOrBuilder(int index)

public ProcessorInfoOrBuilder getExtractProcessorInfosOrBuilder(int index)

The extract processors information. One matched extract processor will be used to process documents based on the classify processor result. If no classify processor is specified, the first extract processor will be used.

repeated .google.cloud.contentwarehouse.v1.ProcessorInfo extract_processor_infos = 3;

Parameter
Name	Description
index	int

Returns
Type	Description
ProcessorInfoOrBuilder

getExtractProcessorInfosOrBuilderList()

public List<? extends ProcessorInfoOrBuilder> getExtractProcessorInfosOrBuilderList()

The extract processors information. One matched extract processor will be used to process documents based on the classify processor result. If no classify processor is specified, the first extract processor will be used.

repeated .google.cloud.contentwarehouse.v1.ProcessorInfo extract_processor_infos = 3;

Returns
Type	Description
List<? extends com.google.cloud.contentwarehouse.v1.ProcessorInfoOrBuilder>

getInputPath()

public String getInputPath()

The input Cloud Storage folder. All files under this folder will be imported to Document Warehouse. Format: gs://<bucket-name>/<folder-name>.

string input_path = 1;

Returns
Type	Description
String	The inputPath.

getInputPathBytes()

public ByteString getInputPathBytes()

The input Cloud Storage folder. All files under this folder will be imported to Document Warehouse. Format: gs://<bucket-name>/<folder-name>.

string input_path = 1;

Returns
Type	Description
ByteString	The bytes for inputPath.

getParserForType()

public Parser<GcsIngestWithDocAiProcessorsPipeline> getParserForType()

Returns
Type	Description
Parser<GcsIngestWithDocAiProcessorsPipeline>

Overrides

GeneratedMessageV3.getParserForType()

getPipelineConfig()

public IngestPipelineConfig getPipelineConfig()

Optional. The config for the Cloud Storage Ingestion with DocAI Processors pipeline. It provides additional customization options to run the pipeline and can be skipped if it is not applicable.

.google.cloud.contentwarehouse.v1.IngestPipelineConfig pipeline_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
IngestPipelineConfig	The pipelineConfig.

getPipelineConfigOrBuilder()

public IngestPipelineConfigOrBuilder getPipelineConfigOrBuilder()

Optional. The config for the Cloud Storage Ingestion with DocAI Processors pipeline. It provides additional customization options to run the pipeline and can be skipped if it is not applicable.

.google.cloud.contentwarehouse.v1.IngestPipelineConfig pipeline_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
IngestPipelineConfigOrBuilder

getProcessorResultsFolderPath()

public String getProcessorResultsFolderPath()

The Cloud Storage folder path used to store the raw results from processors. Format: gs://<bucket-name>/<folder-name>.

string processor_results_folder_path = 4;

Returns
Type	Description
String	The processorResultsFolderPath.

getProcessorResultsFolderPathBytes()

public ByteString getProcessorResultsFolderPathBytes()

The Cloud Storage folder path used to store the raw results from processors. Format: gs://<bucket-name>/<folder-name>.

string processor_results_folder_path = 4;

Returns
Type	Description
ByteString	The bytes for processorResultsFolderPath.

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getSkipIngestedDocuments()

public boolean getSkipIngestedDocuments()

The flag whether to skip ingested documents. If it is set to true, documents in Cloud Storage contains key "status" with value "status=ingested" in custom metadata will be skipped to ingest.

bool skip_ingested_documents = 5;

Returns
Type	Description
boolean	The skipIngestedDocuments.

getSplitClassifyProcessorInfo()

public ProcessorInfo getSplitClassifyProcessorInfo()

The split and classify processor information. The split and classify result will be used to find a matched extract processor.

.google.cloud.contentwarehouse.v1.ProcessorInfo split_classify_processor_info = 2;

Returns
Type	Description
ProcessorInfo	The splitClassifyProcessorInfo.

getSplitClassifyProcessorInfoOrBuilder()

public ProcessorInfoOrBuilder getSplitClassifyProcessorInfoOrBuilder()

The split and classify processor information. The split and classify result will be used to find a matched extract processor.

.google.cloud.contentwarehouse.v1.ProcessorInfo split_classify_processor_info = 2;

Returns
Type	Description
ProcessorInfoOrBuilder

hasPipelineConfig()

public boolean hasPipelineConfig()

Optional. The config for the Cloud Storage Ingestion with DocAI Processors pipeline. It provides additional customization options to run the pipeline and can be skipped if it is not applicable.

.google.cloud.contentwarehouse.v1.IngestPipelineConfig pipeline_config = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the pipelineConfig field is set.

hasSplitClassifyProcessorInfo()

public boolean hasSplitClassifyProcessorInfo()

The split and classify processor information. The split and classify result will be used to find a matched extract processor.

.google.cloud.contentwarehouse.v1.ProcessorInfo split_classify_processor_info = 2;

Returns
Type	Description
boolean	Whether the splitClassifyProcessorInfo 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 GcsIngestWithDocAiProcessorsPipeline.Builder newBuilderForType()

Returns
Type	Description
GcsIngestWithDocAiProcessorsPipeline.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected GcsIngestWithDocAiProcessorsPipeline.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
GcsIngestWithDocAiProcessorsPipeline.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 GcsIngestWithDocAiProcessorsPipeline.Builder toBuilder()

Returns
Type	Description
GcsIngestWithDocAiProcessorsPipeline.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException