Class ProcessWithDocAiPipeline.Builder (0.44.0) 

public static final class ProcessWithDocAiPipeline.Builder extends GeneratedMessageV3.Builder<ProcessWithDocAiPipeline.Builder> implements ProcessWithDocAiPipelineOrBuilder

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

Protobuf type google.cloud.contentwarehouse.v1.ProcessWithDocAiPipeline

Inheritance

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

Static Methods

getDescriptor()

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

Methods

addAllDocuments(Iterable<String> values)

public ProcessWithDocAiPipeline.Builder addAllDocuments(Iterable<String> values)

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
values Iterable<String>

The documents to add.
Returns
Type Description
ProcessWithDocAiPipeline.Builder

This builder for chaining.

addDocuments(String value)

public ProcessWithDocAiPipeline.Builder addDocuments(String value)

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
value String

The documents to add.
Returns
Type Description
ProcessWithDocAiPipeline.Builder

This builder for chaining.

addDocumentsBytes(ByteString value)

public ProcessWithDocAiPipeline.Builder addDocumentsBytes(ByteString value)

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
value ByteString

The bytes of the documents to add.
Returns
Type Description
ProcessWithDocAiPipeline.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public ProcessWithDocAiPipeline build()
Returns
Type Description
ProcessWithDocAiPipeline

buildPartial()

public ProcessWithDocAiPipeline buildPartial()
Returns
Type Description
ProcessWithDocAiPipeline

clear()

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

clearDocuments()

public ProcessWithDocAiPipeline.Builder clearDocuments()

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

This builder for chaining.

clearExportFolderPath()

public ProcessWithDocAiPipeline.Builder clearExportFolderPath()

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

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearProcessorInfo()

public ProcessWithDocAiPipeline.Builder clearProcessorInfo()

The CDW processor information.

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

Returns
Type Description
ProcessWithDocAiPipeline.Builder

clearProcessorResultsFolderPath()

public ProcessWithDocAiPipeline.Builder clearProcessorResultsFolderPath()

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

This builder for chaining.

clone()

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

getDefaultInstanceForType()

public ProcessWithDocAiPipeline getDefaultInstanceForType()
Returns
Type Description
ProcessWithDocAiPipeline

getDescriptorForType()

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

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.

getProcessorInfo()

public ProcessorInfo getProcessorInfo()

The CDW processor information.

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

Returns
Type Description
ProcessorInfo

The processorInfo.

getProcessorInfoBuilder()

public ProcessorInfo.Builder getProcessorInfoBuilder()

The CDW processor information.

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

Returns
Type Description
ProcessorInfo.Builder

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ProcessWithDocAiPipeline other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeProcessorInfo(ProcessorInfo value)

public ProcessWithDocAiPipeline.Builder mergeProcessorInfo(ProcessorInfo value)

The CDW processor information.

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

Parameter
Name Description
value ProcessorInfo
Returns
Type Description
ProcessWithDocAiPipeline.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setDocuments(int index, String value)

public ProcessWithDocAiPipeline.Builder setDocuments(int index, String value)

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;

Parameters
Name Description
index int

The index to set the value at.
value String

The documents to set.
Returns
Type Description
ProcessWithDocAiPipeline.Builder

This builder for chaining.

setExportFolderPath(String value)

public ProcessWithDocAiPipeline.Builder setExportFolderPath(String value)

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;

Parameter
Name Description
value String

The exportFolderPath to set.
Returns
Type Description
ProcessWithDocAiPipeline.Builder

This builder for chaining.

setExportFolderPathBytes(ByteString value)

public ProcessWithDocAiPipeline.Builder setExportFolderPathBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for exportFolderPath to set.
Returns
Type Description
ProcessWithDocAiPipeline.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setProcessorInfo(ProcessorInfo value)

public ProcessWithDocAiPipeline.Builder setProcessorInfo(ProcessorInfo value)

The CDW processor information.

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

Parameter
Name Description
value ProcessorInfo
Returns
Type Description
ProcessWithDocAiPipeline.Builder

setProcessorInfo(ProcessorInfo.Builder builderForValue)

public ProcessWithDocAiPipeline.Builder setProcessorInfo(ProcessorInfo.Builder builderForValue)

The CDW processor information.

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

Parameter
Name Description
builderForValue ProcessorInfo.Builder
Returns
Type Description
ProcessWithDocAiPipeline.Builder

setProcessorResultsFolderPath(String value)

public ProcessWithDocAiPipeline.Builder setProcessorResultsFolderPath(String value)

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;

Parameter
Name Description
value String

The processorResultsFolderPath to set.
Returns
Type Description
ProcessWithDocAiPipeline.Builder

This builder for chaining.

setProcessorResultsFolderPathBytes(ByteString value)

public ProcessWithDocAiPipeline.Builder setProcessorResultsFolderPathBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for processorResultsFolderPath to set.
Returns
Type Description
ProcessWithDocAiPipeline.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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