Class RunPipelineRequest.Builder (0.42.0)

public static final class RunPipelineRequest.Builder extends GeneratedMessageV3.Builder<RunPipelineRequest.Builder> implements RunPipelineRequestOrBuilder

Request message for DocumentService.RunPipeline.

Protobuf type google.cloud.contentwarehouse.v1.RunPipelineRequest

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public RunPipelineRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RunPipelineRequest.Builder
Overrides

build()

public RunPipelineRequest build()
Returns
Type Description
RunPipelineRequest

buildPartial()

public RunPipelineRequest buildPartial()
Returns
Type Description
RunPipelineRequest

clear()

public RunPipelineRequest.Builder clear()
Returns
Type Description
RunPipelineRequest.Builder
Overrides

clearExportCdwPipeline()

public RunPipelineRequest.Builder clearExportCdwPipeline()

Export docuemnts from Document Warehouse to CDW for training purpose.

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

Returns
Type Description
RunPipelineRequest.Builder

clearField(Descriptors.FieldDescriptor field)

public RunPipelineRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
RunPipelineRequest.Builder
Overrides

clearGcsIngestPipeline()

public RunPipelineRequest.Builder clearGcsIngestPipeline()

Cloud Storage ingestion pipeline.

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

Returns
Type Description
RunPipelineRequest.Builder

clearGcsIngestWithDocAiProcessorsPipeline()

public RunPipelineRequest.Builder clearGcsIngestWithDocAiProcessorsPipeline()

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
RunPipelineRequest.Builder

clearName()

public RunPipelineRequest.Builder clearName()

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
RunPipelineRequest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public RunPipelineRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
RunPipelineRequest.Builder
Overrides

clearPipeline()

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

clearProcessWithDocAiPipeline()

public RunPipelineRequest.Builder clearProcessWithDocAiPipeline()

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
RunPipelineRequest.Builder

clearRequestMetadata()

public RunPipelineRequest.Builder clearRequestMetadata()

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
RunPipelineRequest.Builder

clone()

public RunPipelineRequest.Builder clone()
Returns
Type Description
RunPipelineRequest.Builder
Overrides

getDefaultInstanceForType()

public RunPipelineRequest getDefaultInstanceForType()
Returns
Type Description
RunPipelineRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getExportCdwPipelineBuilder()

public ExportToCdwPipeline.Builder getExportCdwPipelineBuilder()

Export docuemnts from Document Warehouse to CDW for training purpose.

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

Returns
Type Description
ExportToCdwPipeline.Builder

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.

getGcsIngestPipelineBuilder()

public GcsIngestPipeline.Builder getGcsIngestPipelineBuilder()

Cloud Storage ingestion pipeline.

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

Returns
Type Description
GcsIngestPipeline.Builder

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.

getGcsIngestWithDocAiProcessorsPipelineBuilder()

public GcsIngestWithDocAiProcessorsPipeline.Builder getGcsIngestWithDocAiProcessorsPipelineBuilder()

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.Builder

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.

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.

getProcessWithDocAiPipelineBuilder()

public ProcessWithDocAiPipeline.Builder getProcessWithDocAiPipelineBuilder()

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.Builder

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.

getRequestMetadataBuilder()

public RequestMetadata.Builder getRequestMetadataBuilder()

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.Builder

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

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeExportCdwPipeline(ExportToCdwPipeline value)

public RunPipelineRequest.Builder mergeExportCdwPipeline(ExportToCdwPipeline value)

Export docuemnts from Document Warehouse to CDW for training purpose.

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

Parameter
Name Description
value ExportToCdwPipeline
Returns
Type Description
RunPipelineRequest.Builder

mergeFrom(RunPipelineRequest other)

public RunPipelineRequest.Builder mergeFrom(RunPipelineRequest other)
Parameter
Name Description
other RunPipelineRequest
Returns
Type Description
RunPipelineRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public RunPipelineRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RunPipelineRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public RunPipelineRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
RunPipelineRequest.Builder
Overrides

mergeGcsIngestPipeline(GcsIngestPipeline value)

public RunPipelineRequest.Builder mergeGcsIngestPipeline(GcsIngestPipeline value)

Cloud Storage ingestion pipeline.

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

Parameter
Name Description
value GcsIngestPipeline
Returns
Type Description
RunPipelineRequest.Builder

mergeGcsIngestWithDocAiProcessorsPipeline(GcsIngestWithDocAiProcessorsPipeline value)

public RunPipelineRequest.Builder mergeGcsIngestWithDocAiProcessorsPipeline(GcsIngestWithDocAiProcessorsPipeline value)

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;

Parameter
Name Description
value GcsIngestWithDocAiProcessorsPipeline
Returns
Type Description
RunPipelineRequest.Builder

mergeProcessWithDocAiPipeline(ProcessWithDocAiPipeline value)

public RunPipelineRequest.Builder mergeProcessWithDocAiPipeline(ProcessWithDocAiPipeline value)

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;

Parameter
Name Description
value ProcessWithDocAiPipeline
Returns
Type Description
RunPipelineRequest.Builder

mergeRequestMetadata(RequestMetadata value)

public RunPipelineRequest.Builder mergeRequestMetadata(RequestMetadata value)

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

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

Parameter
Name Description
value RequestMetadata
Returns
Type Description
RunPipelineRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final RunPipelineRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RunPipelineRequest.Builder
Overrides

setExportCdwPipeline(ExportToCdwPipeline value)

public RunPipelineRequest.Builder setExportCdwPipeline(ExportToCdwPipeline value)

Export docuemnts from Document Warehouse to CDW for training purpose.

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

Parameter
Name Description
value ExportToCdwPipeline
Returns
Type Description
RunPipelineRequest.Builder

setExportCdwPipeline(ExportToCdwPipeline.Builder builderForValue)

public RunPipelineRequest.Builder setExportCdwPipeline(ExportToCdwPipeline.Builder builderForValue)

Export docuemnts from Document Warehouse to CDW for training purpose.

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

Parameter
Name Description
builderForValue ExportToCdwPipeline.Builder
Returns
Type Description
RunPipelineRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public RunPipelineRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
RunPipelineRequest.Builder
Overrides

setGcsIngestPipeline(GcsIngestPipeline value)

public RunPipelineRequest.Builder setGcsIngestPipeline(GcsIngestPipeline value)

Cloud Storage ingestion pipeline.

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

Parameter
Name Description
value GcsIngestPipeline
Returns
Type Description
RunPipelineRequest.Builder

setGcsIngestPipeline(GcsIngestPipeline.Builder builderForValue)

public RunPipelineRequest.Builder setGcsIngestPipeline(GcsIngestPipeline.Builder builderForValue)

Cloud Storage ingestion pipeline.

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

Parameter
Name Description
builderForValue GcsIngestPipeline.Builder
Returns
Type Description
RunPipelineRequest.Builder

setGcsIngestWithDocAiProcessorsPipeline(GcsIngestWithDocAiProcessorsPipeline value)

public RunPipelineRequest.Builder setGcsIngestWithDocAiProcessorsPipeline(GcsIngestWithDocAiProcessorsPipeline value)

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;

Parameter
Name Description
value GcsIngestWithDocAiProcessorsPipeline
Returns
Type Description
RunPipelineRequest.Builder

setGcsIngestWithDocAiProcessorsPipeline(GcsIngestWithDocAiProcessorsPipeline.Builder builderForValue)

public RunPipelineRequest.Builder setGcsIngestWithDocAiProcessorsPipeline(GcsIngestWithDocAiProcessorsPipeline.Builder builderForValue)

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;

Parameter
Name Description
builderForValue GcsIngestWithDocAiProcessorsPipeline.Builder
Returns
Type Description
RunPipelineRequest.Builder

setName(String value)

public RunPipelineRequest.Builder setName(String value)

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) = { ... }

Parameter
Name Description
value String

The name to set.

Returns
Type Description
RunPipelineRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public RunPipelineRequest.Builder setNameBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
RunPipelineRequest.Builder

This builder for chaining.

setProcessWithDocAiPipeline(ProcessWithDocAiPipeline value)

public RunPipelineRequest.Builder setProcessWithDocAiPipeline(ProcessWithDocAiPipeline value)

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;

Parameter
Name Description
value ProcessWithDocAiPipeline
Returns
Type Description
RunPipelineRequest.Builder

setProcessWithDocAiPipeline(ProcessWithDocAiPipeline.Builder builderForValue)

public RunPipelineRequest.Builder setProcessWithDocAiPipeline(ProcessWithDocAiPipeline.Builder builderForValue)

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;

Parameter
Name Description
builderForValue ProcessWithDocAiPipeline.Builder
Returns
Type Description
RunPipelineRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public RunPipelineRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
RunPipelineRequest.Builder
Overrides

setRequestMetadata(RequestMetadata value)

public RunPipelineRequest.Builder setRequestMetadata(RequestMetadata value)

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

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

Parameter
Name Description
value RequestMetadata
Returns
Type Description
RunPipelineRequest.Builder

setRequestMetadata(RequestMetadata.Builder builderForValue)

public RunPipelineRequest.Builder setRequestMetadata(RequestMetadata.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue RequestMetadata.Builder
Returns
Type Description
RunPipelineRequest.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final RunPipelineRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
RunPipelineRequest.Builder
Overrides