Interface ExportToCdwPipelineOrBuilder (0.51.0)

public interface ExportToCdwPipelineOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDocAiDataset()

public abstract 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
Type Description
String

The docAiDataset.

getDocAiDatasetBytes()

public abstract 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
Type Description
ByteString

The bytes for docAiDataset.

getDocuments(int index)

public abstract 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 abstract 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 abstract 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 abstract List<String> 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
List<String>

A list containing the documents.

getExportFolderPath()

public abstract 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 abstract 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 abstract 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
Type Description
float

The trainingSplitRatio.