Class RunPipelineRequest (0.29.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
TypeDescription
int

GCS_INGEST_PIPELINE_FIELD_NUMBER

public static final int GCS_INGEST_PIPELINE_FIELD_NUMBER
Field Value
TypeDescription
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
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

PROCESS_WITH_DOC_AI_PIPELINE_FIELD_NUMBER

public static final int PROCESS_WITH_DOC_AI_PIPELINE_FIELD_NUMBER
Field Value
TypeDescription
int

REQUEST_METADATA_FIELD_NUMBER

public static final int REQUEST_METADATA_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static RunPipelineRequest getDefaultInstance()
Returns
TypeDescription
RunPipelineRequest

getDescriptor()

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

newBuilder()

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

newBuilder(RunPipelineRequest prototype)

public static RunPipelineRequest.Builder newBuilder(RunPipelineRequest prototype)
Parameter
NameDescription
prototypeRunPipelineRequest
Returns
TypeDescription
RunPipelineRequest.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public RunPipelineRequest getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ExportToCdwPipelineOrBuilder

getGcsIngestPipeline()

public GcsIngestPipeline getGcsIngestPipeline()

Cloud Storage ingestion pipeline.

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

Returns
TypeDescription
GcsIngestPipeline

The gcsIngestPipeline.

getGcsIngestPipelineOrBuilder()

public GcsIngestPipelineOrBuilder getGcsIngestPipelineOrBuilder()

Cloud Storage ingestion pipeline.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for name.

getParserForType()

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

getPipelineCase()

public RunPipelineRequest.PipelineCase getPipelineCase()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
RequestMetadataOrBuilder

getSerializedSize()

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

Whether the requestMetadata field is set.

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 RunPipelineRequest.Builder newBuilderForType()
Returns
TypeDescription
RunPipelineRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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