public final class ExportToCdwPipeline extends GeneratedMessageV3 implements ExportToCdwPipelineOrBuilder
The configuration of exporting documents from the Document Warehouse to CDW
pipeline.
Protobuf type google.cloud.contentwarehouse.v1.ExportToCdwPipeline
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
DOCUMENTS_FIELD_NUMBER
public static final int DOCUMENTS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DOC_AI_DATASET_FIELD_NUMBER
public static final int DOC_AI_DATASET_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
EXPORT_FOLDER_PATH_FIELD_NUMBER
public static final int EXPORT_FOLDER_PATH_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
TRAINING_SPLIT_RATIO_FIELD_NUMBER
public static final int TRAINING_SPLIT_RATIO_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static ExportToCdwPipeline getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ExportToCdwPipeline.Builder newBuilder()
newBuilder(ExportToCdwPipeline prototype)
public static ExportToCdwPipeline.Builder newBuilder(ExportToCdwPipeline prototype)
parseDelimitedFrom(InputStream input)
public static ExportToCdwPipeline parseDelimitedFrom(InputStream input)
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ExportToCdwPipeline parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ExportToCdwPipeline parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ExportToCdwPipeline parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ExportToCdwPipeline parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ExportToCdwPipeline parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
parseFrom(CodedInputStream input)
public static ExportToCdwPipeline parseFrom(CodedInputStream input)
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ExportToCdwPipeline parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(InputStream input)
public static ExportToCdwPipeline parseFrom(InputStream input)
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static ExportToCdwPipeline parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ExportToCdwPipeline parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ExportToCdwPipeline parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ExportToCdwPipeline> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public ExportToCdwPipeline getDefaultInstanceForType()
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 |
| Type |
Description |
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 |
| 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;
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.
|
getParserForType()
public Parser<ExportToCdwPipeline> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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 |
| Type |
Description |
float |
The trainingSplitRatio.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ExportToCdwPipeline.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ExportToCdwPipeline.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public ExportToCdwPipeline.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
