Class ExportToCdwPipeline.Builder (0.25.0)

public static final class ExportToCdwPipeline.Builder extends GeneratedMessageV3.Builder<ExportToCdwPipeline.Builder> implements ExportToCdwPipelineOrBuilder

The configuration of exporting documents from the Document Warehouse to CDW pipeline.

Protobuf type google.cloud.contentwarehouse.v1.ExportToCdwPipeline

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addAllDocuments(Iterable<String> values)

public ExportToCdwPipeline.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
NameDescription
valuesIterable<String>

The documents to add.

Returns
TypeDescription
ExportToCdwPipeline.Builder

This builder for chaining.

addDocuments(String value)

public ExportToCdwPipeline.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
NameDescription
valueString

The documents to add.

Returns
TypeDescription
ExportToCdwPipeline.Builder

This builder for chaining.

addDocumentsBytes(ByteString value)

public ExportToCdwPipeline.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
NameDescription
valueByteString

The bytes of the documents to add.

Returns
TypeDescription
ExportToCdwPipeline.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ExportToCdwPipeline.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ExportToCdwPipeline.Builder
Overrides

build()

public ExportToCdwPipeline build()
Returns
TypeDescription
ExportToCdwPipeline

buildPartial()

public ExportToCdwPipeline buildPartial()
Returns
TypeDescription
ExportToCdwPipeline

clear()

public ExportToCdwPipeline.Builder clear()
Returns
TypeDescription
ExportToCdwPipeline.Builder
Overrides

clearDocAiDataset()

public ExportToCdwPipeline.Builder clearDocAiDataset()

Optional. The CDW dataset resource name. This field is optional. If not set, the documents will be exported to Cloud Storage only. Format: projects/{project}/locations/{location}/processors/{processor}/dataset

string doc_ai_dataset = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ExportToCdwPipeline.Builder

This builder for chaining.

clearDocuments()

public ExportToCdwPipeline.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
TypeDescription
ExportToCdwPipeline.Builder

This builder for chaining.

clearExportFolderPath()

public ExportToCdwPipeline.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
TypeDescription
ExportToCdwPipeline.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ExportToCdwPipeline.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ExportToCdwPipeline.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ExportToCdwPipeline.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ExportToCdwPipeline.Builder
Overrides

clearTrainingSplitRatio()

public ExportToCdwPipeline.Builder clearTrainingSplitRatio()

Ratio of training dataset split. When importing into Document AI Workbench, documents will be automatically split into training and test split category with the specified ratio. This field is required if doc_ai_dataset is set.

float training_split_ratio = 4;

Returns
TypeDescription
ExportToCdwPipeline.Builder

This builder for chaining.

clone()

public ExportToCdwPipeline.Builder clone()
Returns
TypeDescription
ExportToCdwPipeline.Builder
Overrides

getDefaultInstanceForType()

public ExportToCdwPipeline getDefaultInstanceForType()
Returns
TypeDescription
ExportToCdwPipeline

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDocAiDataset()

public String getDocAiDataset()

Optional. The CDW dataset resource name. This field is optional. If not set, the documents will be exported to Cloud Storage only. Format: projects/{project}/locations/{location}/processors/{processor}/dataset

string doc_ai_dataset = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
String

The docAiDataset.

getDocAiDatasetBytes()

public ByteString getDocAiDatasetBytes()

Optional. The CDW dataset resource name. This field is optional. If not set, the documents will be exported to Cloud Storage only. Format: projects/{project}/locations/{location}/processors/{processor}/dataset

string doc_ai_dataset = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
ByteString

The bytes for docAiDataset.

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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for exportFolderPath.

getTrainingSplitRatio()

public float getTrainingSplitRatio()

Ratio of training dataset split. When importing into Document AI Workbench, documents will be automatically split into training and test split category with the specified ratio. This field is required if doc_ai_dataset is set.

float training_split_ratio = 4;

Returns
TypeDescription
float

The trainingSplitRatio.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ExportToCdwPipeline other)

public ExportToCdwPipeline.Builder mergeFrom(ExportToCdwPipeline other)
Parameter
NameDescription
otherExportToCdwPipeline
Returns
TypeDescription
ExportToCdwPipeline.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ExportToCdwPipeline.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExportToCdwPipeline.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ExportToCdwPipeline.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ExportToCdwPipeline.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ExportToCdwPipeline.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ExportToCdwPipeline.Builder
Overrides

setDocAiDataset(String value)

public ExportToCdwPipeline.Builder setDocAiDataset(String value)

Optional. The CDW dataset resource name. This field is optional. If not set, the documents will be exported to Cloud Storage only. Format: projects/{project}/locations/{location}/processors/{processor}/dataset

string doc_ai_dataset = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueString

The docAiDataset to set.

Returns
TypeDescription
ExportToCdwPipeline.Builder

This builder for chaining.

setDocAiDatasetBytes(ByteString value)

public ExportToCdwPipeline.Builder setDocAiDatasetBytes(ByteString value)

Optional. The CDW dataset resource name. This field is optional. If not set, the documents will be exported to Cloud Storage only. Format: projects/{project}/locations/{location}/processors/{processor}/dataset

string doc_ai_dataset = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
NameDescription
valueByteString

The bytes for docAiDataset to set.

Returns
TypeDescription
ExportToCdwPipeline.Builder

This builder for chaining.

setDocuments(int index, String value)

public ExportToCdwPipeline.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
NameDescription
indexint

The index to set the value at.

valueString

The documents to set.

Returns
TypeDescription
ExportToCdwPipeline.Builder

This builder for chaining.

setExportFolderPath(String value)

public ExportToCdwPipeline.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
NameDescription
valueString

The exportFolderPath to set.

Returns
TypeDescription
ExportToCdwPipeline.Builder

This builder for chaining.

setExportFolderPathBytes(ByteString value)

public ExportToCdwPipeline.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
NameDescription
valueByteString

The bytes for exportFolderPath to set.

Returns
TypeDescription
ExportToCdwPipeline.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ExportToCdwPipeline.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ExportToCdwPipeline.Builder
Overrides

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

public ExportToCdwPipeline.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ExportToCdwPipeline.Builder
Overrides

setTrainingSplitRatio(float value)

public ExportToCdwPipeline.Builder setTrainingSplitRatio(float value)

Ratio of training dataset split. When importing into Document AI Workbench, documents will be automatically split into training and test split category with the specified ratio. This field is required if doc_ai_dataset is set.

float training_split_ratio = 4;

Parameter
NameDescription
valuefloat

The trainingSplitRatio to set.

Returns
TypeDescription
ExportToCdwPipeline.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ExportToCdwPipeline.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ExportToCdwPipeline.Builder
Overrides