Class RunPipelineRequest (0.42.0)

public final class RunPipelineRequest extends GeneratedMessageV3 implements RunPipelineRequestOrBuilder

Request message for DocumentService.RunPipeline.

Protobuf type google.cloud.contentwarehouse.v1.RunPipelineRequest

Static Fields

EXPORT_CDW_PIPELINE_FIELD_NUMBER

public static final int EXPORT_CDW_PIPELINE_FIELD_NUMBER
Field Value
Type Description
int

GCS_INGEST_PIPELINE_FIELD_NUMBER

public static final int GCS_INGEST_PIPELINE_FIELD_NUMBER
Field Value
Type Description
int

GCS_INGEST_WITH_DOC_AI_PROCESSORS_PIPELINE_FIELD_NUMBER

public static final int GCS_INGEST_WITH_DOC_AI_PROCESSORS_PIPELINE_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PROCESS_WITH_DOC_AI_PIPELINE_FIELD_NUMBER

public static final int PROCESS_WITH_DOC_AI_PIPELINE_FIELD_NUMBER
Field Value
Type Description
int

REQUEST_METADATA_FIELD_NUMBER

public static final int REQUEST_METADATA_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RunPipelineRequest getDefaultInstance()
Returns
Type Description
RunPipelineRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static RunPipelineRequest.Builder newBuilder()
Returns
Type Description
RunPipelineRequest.Builder

newBuilder(RunPipelineRequest prototype)

public static RunPipelineRequest.Builder newBuilder(RunPipelineRequest prototype)
Parameter
Name Description
prototype RunPipelineRequest
Returns
Type Description
RunPipelineRequest.Builder

parseDelimitedFrom(InputStream input)

public static RunPipelineRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RunPipelineRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RunPipelineRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunPipelineRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static RunPipelineRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
RunPipelineRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RunPipelineRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunPipelineRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RunPipelineRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RunPipelineRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RunPipelineRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunPipelineRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RunPipelineRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RunPipelineRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RunPipelineRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunPipelineRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static RunPipelineRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RunPipelineRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RunPipelineRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunPipelineRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static RunPipelineRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RunPipelineRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RunPipelineRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunPipelineRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<RunPipelineRequest> parser()
Returns
Type Description
Parser<RunPipelineRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public RunPipelineRequest getDefaultInstanceForType()
Returns
Type Description
RunPipelineRequest

getExportCdwPipeline()

public ExportToCdwPipeline getExportCdwPipeline()

Export docuemnts from Document Warehouse to CDW for training purpose.

.google.cloud.contentwarehouse.v1.ExportToCdwPipeline export_cdw_pipeline = 4;

Returns
Type Description
ExportToCdwPipeline

The exportCdwPipeline.

getExportCdwPipelineOrBuilder()

public ExportToCdwPipelineOrBuilder getExportCdwPipelineOrBuilder()

Export docuemnts from Document Warehouse to CDW for training purpose.

.google.cloud.contentwarehouse.v1.ExportToCdwPipeline export_cdw_pipeline = 4;

Returns
Type Description
ExportToCdwPipelineOrBuilder

getGcsIngestPipeline()

public GcsIngestPipeline getGcsIngestPipeline()

Cloud Storage ingestion pipeline.

.google.cloud.contentwarehouse.v1.GcsIngestPipeline gcs_ingest_pipeline = 2;

Returns
Type Description
GcsIngestPipeline

The gcsIngestPipeline.

getGcsIngestPipelineOrBuilder()

public GcsIngestPipelineOrBuilder getGcsIngestPipelineOrBuilder()

Cloud Storage ingestion pipeline.

.google.cloud.contentwarehouse.v1.GcsIngestPipeline gcs_ingest_pipeline = 2;

Returns
Type Description
GcsIngestPipelineOrBuilder

getGcsIngestWithDocAiProcessorsPipeline()

public GcsIngestWithDocAiProcessorsPipeline getGcsIngestWithDocAiProcessorsPipeline()

Use DocAI processors to process documents in Cloud Storage and ingest them to Document Warehouse.

.google.cloud.contentwarehouse.v1.GcsIngestWithDocAiProcessorsPipeline gcs_ingest_with_doc_ai_processors_pipeline = 3;

Returns
Type Description
GcsIngestWithDocAiProcessorsPipeline

The gcsIngestWithDocAiProcessorsPipeline.

getGcsIngestWithDocAiProcessorsPipelineOrBuilder()

public GcsIngestWithDocAiProcessorsPipelineOrBuilder getGcsIngestWithDocAiProcessorsPipelineOrBuilder()

Use DocAI processors to process documents in Cloud Storage and ingest them to Document Warehouse.

.google.cloud.contentwarehouse.v1.GcsIngestWithDocAiProcessorsPipeline gcs_ingest_with_doc_ai_processors_pipeline = 3;

Returns
Type Description
GcsIngestWithDocAiProcessorsPipelineOrBuilder

getName()

public String getName()

Required. The resource name which owns the resources of the pipeline. Format: projects/{project_number}/locations/{location}.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Required. The resource name which owns the resources of the pipeline. Format: projects/{project_number}/locations/{location}.

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<RunPipelineRequest> getParserForType()
Returns
Type Description
Parser<RunPipelineRequest>
Overrides

getPipelineCase()

public RunPipelineRequest.PipelineCase getPipelineCase()
Returns
Type Description
RunPipelineRequest.PipelineCase

getProcessWithDocAiPipeline()

public ProcessWithDocAiPipeline getProcessWithDocAiPipeline()

Use a DocAI processor to process documents in Document Warehouse, and re-ingest the updated results into Document Warehouse.

.google.cloud.contentwarehouse.v1.ProcessWithDocAiPipeline process_with_doc_ai_pipeline = 5;

Returns
Type Description
ProcessWithDocAiPipeline

The processWithDocAiPipeline.

getProcessWithDocAiPipelineOrBuilder()

public ProcessWithDocAiPipelineOrBuilder getProcessWithDocAiPipelineOrBuilder()

Use a DocAI processor to process documents in Document Warehouse, and re-ingest the updated results into Document Warehouse.

.google.cloud.contentwarehouse.v1.ProcessWithDocAiPipeline process_with_doc_ai_pipeline = 5;

Returns
Type Description
ProcessWithDocAiPipelineOrBuilder

getRequestMetadata()

public RequestMetadata getRequestMetadata()

The meta information collected about the end user, used to enforce access control for the service.

.google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 6;

Returns
Type Description
RequestMetadata

The requestMetadata.

getRequestMetadataOrBuilder()

public RequestMetadataOrBuilder getRequestMetadataOrBuilder()

The meta information collected about the end user, used to enforce access control for the service.

.google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 6;

Returns
Type Description
RequestMetadataOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasExportCdwPipeline()

public boolean hasExportCdwPipeline()

Export docuemnts from Document Warehouse to CDW for training purpose.

.google.cloud.contentwarehouse.v1.ExportToCdwPipeline export_cdw_pipeline = 4;

Returns
Type Description
boolean

Whether the exportCdwPipeline field is set.

hasGcsIngestPipeline()

public boolean hasGcsIngestPipeline()

Cloud Storage ingestion pipeline.

.google.cloud.contentwarehouse.v1.GcsIngestPipeline gcs_ingest_pipeline = 2;

Returns
Type Description
boolean

Whether the gcsIngestPipeline field is set.

hasGcsIngestWithDocAiProcessorsPipeline()

public boolean hasGcsIngestWithDocAiProcessorsPipeline()

Use DocAI processors to process documents in Cloud Storage and ingest them to Document Warehouse.

.google.cloud.contentwarehouse.v1.GcsIngestWithDocAiProcessorsPipeline gcs_ingest_with_doc_ai_processors_pipeline = 3;

Returns
Type Description
boolean

Whether the gcsIngestWithDocAiProcessorsPipeline field is set.

hasProcessWithDocAiPipeline()

public boolean hasProcessWithDocAiPipeline()

Use a DocAI processor to process documents in Document Warehouse, and re-ingest the updated results into Document Warehouse.

.google.cloud.contentwarehouse.v1.ProcessWithDocAiPipeline process_with_doc_ai_pipeline = 5;

Returns
Type Description
boolean

Whether the processWithDocAiPipeline field is set.

hasRequestMetadata()

public boolean hasRequestMetadata()

The meta information collected about the end user, used to enforce access control for the service.

.google.cloud.contentwarehouse.v1.RequestMetadata request_metadata = 6;

Returns
Type Description
boolean

Whether the requestMetadata field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public RunPipelineRequest.Builder newBuilderForType()
Returns
Type Description
RunPipelineRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected RunPipelineRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RunPipelineRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public RunPipelineRequest.Builder toBuilder()
Returns
Type Description
RunPipelineRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException