Class ExportToCdwPipeline (0.36.0)

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

Static Fields

DOCUMENTS_FIELD_NUMBER

public static final int DOCUMENTS_FIELD_NUMBER
Field Value
TypeDescription
int

DOC_AI_DATASET_FIELD_NUMBER

public static final int DOC_AI_DATASET_FIELD_NUMBER
Field Value
TypeDescription
int

EXPORT_FOLDER_PATH_FIELD_NUMBER

public static final int EXPORT_FOLDER_PATH_FIELD_NUMBER
Field Value
TypeDescription
int

TRAINING_SPLIT_RATIO_FIELD_NUMBER

public static final int TRAINING_SPLIT_RATIO_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ExportToCdwPipeline getDefaultInstance()
Returns
TypeDescription
ExportToCdwPipeline

getDescriptor()

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

newBuilder()

public static ExportToCdwPipeline.Builder newBuilder()
Returns
TypeDescription
ExportToCdwPipeline.Builder

newBuilder(ExportToCdwPipeline prototype)

public static ExportToCdwPipeline.Builder newBuilder(ExportToCdwPipeline prototype)
Parameter
NameDescription
prototypeExportToCdwPipeline
Returns
TypeDescription
ExportToCdwPipeline.Builder

parseDelimitedFrom(InputStream input)

public static ExportToCdwPipeline parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ExportToCdwPipeline
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExportToCdwPipeline parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExportToCdwPipeline
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ExportToCdwPipeline parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ExportToCdwPipeline
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ExportToCdwPipeline parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExportToCdwPipeline
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ExportToCdwPipeline parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ExportToCdwPipeline
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ExportToCdwPipeline parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExportToCdwPipeline
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ExportToCdwPipeline parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ExportToCdwPipeline
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ExportToCdwPipeline parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExportToCdwPipeline
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ExportToCdwPipeline parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ExportToCdwPipeline
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ExportToCdwPipeline parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExportToCdwPipeline
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ExportToCdwPipeline parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ExportToCdwPipeline
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ExportToCdwPipeline parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ExportToCdwPipeline
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ExportToCdwPipeline> parser()
Returns
TypeDescription
Parser<ExportToCdwPipeline>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public ExportToCdwPipeline getDefaultInstanceForType()
Returns
TypeDescription
ExportToCdwPipeline

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.

getParserForType()

public Parser<ExportToCdwPipeline> getParserForType()
Returns
TypeDescription
Parser<ExportToCdwPipeline>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
float

The trainingSplitRatio.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ExportToCdwPipeline.Builder newBuilderForType()
Returns
TypeDescription
ExportToCdwPipeline.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ExportToCdwPipeline.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ExportToCdwPipeline.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ExportToCdwPipeline.Builder toBuilder()
Returns
TypeDescription
ExportToCdwPipeline.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException