Class RunPipelineRequest (0.26.0)

Version 0.26.0

• 0.49.0 (latest)
• 0.48.0
• 0.47.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public final class RunPipelineRequest extends GeneratedMessageV3 implements RunPipelineRequestOrBuilder

Request message for DocumentService.RunPipeline.

Protobuf type google.cloud.contentwarehouse.v1.RunPipelineRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > RunPipelineRequest

Implements

RunPipelineRequestOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

AbstractMessage.equals(Object other)

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

GeneratedMessageV3.getParserForType()

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

GeneratedMessageV3.getSerializedSize()

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

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

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

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public RunPipelineRequest.Builder toBuilder()

Returns
Type	Description
RunPipelineRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException