Class ExportToCdwPipeline.Builder (0.36.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

Inheritance

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

Implements

ExportToCdwPipelineOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

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

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

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

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

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`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
Name	Description
`values`	`Iterable<String>` The documents to add.

Returns
Type	Description
`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
Name	Description
`value`	`String` The documents to add.

Returns
Type	Description
`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
Name	Description
`value`	`ByteString` The bytes of the documents to add.

Returns
Type	Description
`ExportToCdwPipeline.Builder`	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ExportToCdwPipeline.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`ExportToCdwPipeline.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public ExportToCdwPipeline build()

Returns
Type	Description
`ExportToCdwPipeline`

buildPartial()

public ExportToCdwPipeline buildPartial()

Returns
Type	Description
`ExportToCdwPipeline`

clear()

public ExportToCdwPipeline.Builder clear()

Returns
Type	Description
`ExportToCdwPipeline.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

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
Type	Description
`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
Type	Description
`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
Type	Description
`ExportToCdwPipeline.Builder`	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public ExportToCdwPipeline.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`ExportToCdwPipeline.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public ExportToCdwPipeline.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`ExportToCdwPipeline.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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
Type	Description
`ExportToCdwPipeline.Builder`	This builder for chaining.

clone()

public ExportToCdwPipeline.Builder clone()

Returns
Type	Description
`ExportToCdwPipeline.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public ExportToCdwPipeline getDefaultInstanceForType()

Returns
Type	Description
`ExportToCdwPipeline`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDocAiDataset()

public String getDocAiDataset()

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

Returns
Type	Description
`String`	The docAiDataset.

getDocAiDatasetBytes()

public ByteString getDocAiDatasetBytes()

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

Returns
Type	Description
`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
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.

getTrainingSplitRatio()

public float getTrainingSplitRatio()

float training_split_ratio = 4;

Returns
Type	Description
`float`	The trainingSplitRatio.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(ExportToCdwPipeline other)

public ExportToCdwPipeline.Builder mergeFrom(ExportToCdwPipeline other)

Parameter
Name	Description
`other`	`ExportToCdwPipeline`

Returns
Type	Description
`ExportToCdwPipeline.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ExportToCdwPipeline.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`ExportToCdwPipeline.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public ExportToCdwPipeline.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`ExportToCdwPipeline.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ExportToCdwPipeline.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`ExportToCdwPipeline.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setDocAiDataset(String value)

public ExportToCdwPipeline.Builder setDocAiDataset(String value)

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

Parameter
Name	Description
`value`	`String` The docAiDataset to set.

Returns
Type	Description
`ExportToCdwPipeline.Builder`	This builder for chaining.

setDocAiDatasetBytes(ByteString value)

public ExportToCdwPipeline.Builder setDocAiDatasetBytes(ByteString value)

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

Parameter
Name	Description
`value`	`ByteString` The bytes for docAiDataset to set.

Returns
Type	Description
`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
Name	Description
`index`	`int` The index to set the value at.
`value`	`String` The documents to set.

Returns
Type	Description
`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
Name	Description
`value`	`String` The exportFolderPath to set.

Returns
Type	Description
`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
Name	Description
`value`	`ByteString` The bytes for exportFolderPath to set.

Returns
Type	Description
`ExportToCdwPipeline.Builder`	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public ExportToCdwPipeline.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`ExportToCdwPipeline.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

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

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`ExportToCdwPipeline.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setTrainingSplitRatio(float value)

public ExportToCdwPipeline.Builder setTrainingSplitRatio(float value)

float training_split_ratio = 4;

Parameter
Name	Description
`value`	`float` The trainingSplitRatio to set.

Returns
Type	Description
`ExportToCdwPipeline.Builder`	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final ExportToCdwPipeline.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`ExportToCdwPipeline.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)