Package com.google.cloud.contentwarehouse.v1

Interface ExportToCdwPipelineOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    ExportToCdwPipeline, ExportToCdwPipeline.Builder
    public interface ExportToCdwPipelineOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getDocAiDataset()
      Optional.
      com.google.protobuf.ByteString getDocAiDatasetBytes()
      Optional.
      String getDocuments​(int index)
      The list of all the resource names of the documents to be processed.
      com.google.protobuf.ByteString getDocumentsBytes​(int index)
      The list of all the resource names of the documents to be processed.
      int getDocumentsCount()
      The list of all the resource names of the documents to be processed.
      List<String> getDocumentsList()
      The list of all the resource names of the documents to be processed.
      String getExportFolderPath()
      The Cloud Storage folder path used to store the exported documents before being sent to CDW.
      com.google.protobuf.ByteString getExportFolderPathBytes()
      The Cloud Storage folder path used to store the exported documents before being sent to CDW.
      float getTrainingSplitRatio()
      Ratio of training dataset split.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getDocumentsList

        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:
        A list containing the documents.

      • getDocumentsCount

        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:
        The count of documents.

      • getDocuments

        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;
        Parameters:
        index - The index of the element to return.
        Returns:
        The documents at the given index.

      • getDocumentsBytes

        com.google.protobuf.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;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the documents at the given index.

      • getExportFolderPath

        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:
        The exportFolderPath.

      • getExportFolderPathBytes

        com.google.protobuf.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:
        The bytes for exportFolderPath.

      • getDocAiDataset

        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:
        The docAiDataset.

      • getDocAiDatasetBytes

        com.google.protobuf.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:
        The bytes for docAiDataset.

      • getTrainingSplitRatio

        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:
        The trainingSplitRatio.