Class ProcessWithDocAiPipeline (0.45.0)

public final class ProcessWithDocAiPipeline extends GeneratedMessageV3 implements ProcessWithDocAiPipelineOrBuilder

The configuration of processing documents in Document Warehouse with DocAi processors pipeline.

Protobuf type google.cloud.contentwarehouse.v1.ProcessWithDocAiPipeline

Static Fields

DOCUMENTS_FIELD_NUMBER

public static final int DOCUMENTS_FIELD_NUMBER
Field Value
Type Description
int

EXPORT_FOLDER_PATH_FIELD_NUMBER

public static final int EXPORT_FOLDER_PATH_FIELD_NUMBER
Field Value
Type Description
int

PROCESSOR_INFO_FIELD_NUMBER

public static final int PROCESSOR_INFO_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

Static Methods

getDefaultInstance()

public static ProcessWithDocAiPipeline getDefaultInstance()
Returns
Type Description
ProcessWithDocAiPipeline

getDescriptor()

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

newBuilder()

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

newBuilder(ProcessWithDocAiPipeline prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ProcessWithDocAiPipeline getDefaultInstanceForType()
Returns
Type Description
ProcessWithDocAiPipeline

getDocuments(int index)

public String getDocuments(int index)

The list of all the resource names of the documents to be processed. Format: projects/{project_number}/locations/{location}/documents/{document_id}.

repeated string documents = 1;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The documents at the given index.

getDocumentsBytes(int index)

public ByteString getDocumentsBytes(int index)

The list of all the resource names of the documents to be processed. Format: projects/{project_number}/locations/{location}/documents/{document_id}.

repeated string documents = 1;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the documents at the given index.

getDocumentsCount()

public int getDocumentsCount()

The list of all the resource names of the documents to be processed. Format: projects/{project_number}/locations/{location}/documents/{document_id}.

repeated string documents = 1;

Returns
Type Description
int

The count of documents.

getDocumentsList()

public ProtocolStringList getDocumentsList()

The list of all the resource names of the documents to be processed. Format: projects/{project_number}/locations/{location}/documents/{document_id}.

repeated string documents = 1;

Returns
Type Description
ProtocolStringList

A list containing the documents.

getExportFolderPath()

public String getExportFolderPath()

The Cloud Storage folder path used to store the exported documents before being sent to CDW. Format: gs://<bucket-name>/<folder-name>.

string export_folder_path = 2;

Returns
Type Description
String

The exportFolderPath.

getExportFolderPathBytes()

public ByteString getExportFolderPathBytes()

The Cloud Storage folder path used to store the exported documents before being sent to CDW. Format: gs://<bucket-name>/<folder-name>.

string export_folder_path = 2;

Returns
Type Description
ByteString

The bytes for exportFolderPath.

getParserForType()

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

getProcessorInfo()

public ProcessorInfo getProcessorInfo()

The CDW processor information.

.google.cloud.contentwarehouse.v1.ProcessorInfo processor_info = 3;

Returns
Type Description
ProcessorInfo

The processorInfo.

getProcessorInfoOrBuilder()

public ProcessorInfoOrBuilder getProcessorInfoOrBuilder()

The CDW processor information.

.google.cloud.contentwarehouse.v1.ProcessorInfo processor_info = 3;

Returns
Type Description
ProcessorInfoOrBuilder

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

hasProcessorInfo()

public boolean hasProcessorInfo()

The CDW processor information.

.google.cloud.contentwarehouse.v1.ProcessorInfo processor_info = 3;

Returns
Type Description
boolean

Whether the processorInfo 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 ProcessWithDocAiPipeline.Builder newBuilderForType()
Returns
Type Description
ProcessWithDocAiPipeline.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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