Class RunPipelineRequest

  • All Implemented Interfaces:
    RunPipelineRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class RunPipelineRequest
    extends com.google.protobuf.GeneratedMessageV3
    implements RunPipelineRequestOrBuilder
     Request message for DocumentService.RunPipeline.
     
    Protobuf type google.cloud.contentwarehouse.v1.RunPipelineRequest
    See Also:
    Serialized Form
    • Field Detail

      • GCS_INGEST_PIPELINE_FIELD_NUMBER

        public static final int GCS_INGEST_PIPELINE_FIELD_NUMBER
        See Also:
        Constant Field Values
      • GCS_INGEST_WITH_DOC_AI_PROCESSORS_PIPELINE_FIELD_NUMBER

        public static final int GCS_INGEST_WITH_DOC_AI_PROCESSORS_PIPELINE_FIELD_NUMBER
        See Also:
        Constant Field Values
      • EXPORT_CDW_PIPELINE_FIELD_NUMBER

        public static final int EXPORT_CDW_PIPELINE_FIELD_NUMBER
        See Also:
        Constant Field Values
      • PROCESS_WITH_DOC_AI_PIPELINE_FIELD_NUMBER

        public static final int PROCESS_WITH_DOC_AI_PIPELINE_FIELD_NUMBER
        See Also:
        Constant Field Values
      • REQUEST_METADATA_FIELD_NUMBER

        public static final int REQUEST_METADATA_FIELD_NUMBER
        See Also:
        Constant Field Values
    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3
      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
      • 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) = { ... }
        Specified by:
        getName in interface RunPipelineRequestOrBuilder
        Returns:
        The name.
      • getNameBytes

        public com.google.protobuf.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) = { ... }
        Specified by:
        getNameBytes in interface RunPipelineRequestOrBuilder
        Returns:
        The bytes for name.
      • hasGcsIngestPipeline

        public boolean hasGcsIngestPipeline()
         Cloud Storage ingestion pipeline.
         
        .google.cloud.contentwarehouse.v1.GcsIngestPipeline gcs_ingest_pipeline = 2;
        Specified by:
        hasGcsIngestPipeline in interface RunPipelineRequestOrBuilder
        Returns:
        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;
        Specified by:
        hasGcsIngestWithDocAiProcessorsPipeline in interface RunPipelineRequestOrBuilder
        Returns:
        Whether the gcsIngestWithDocAiProcessorsPipeline field is set.
      • hasExportCdwPipeline

        public boolean hasExportCdwPipeline()
         Export docuemnts from Document Warehouse to CDW for training purpose.
         
        .google.cloud.contentwarehouse.v1.ExportToCdwPipeline export_cdw_pipeline = 4;
        Specified by:
        hasExportCdwPipeline in interface RunPipelineRequestOrBuilder
        Returns:
        Whether the exportCdwPipeline field is set.
      • getExportCdwPipeline

        public ExportToCdwPipeline getExportCdwPipeline()
         Export docuemnts from Document Warehouse to CDW for training purpose.
         
        .google.cloud.contentwarehouse.v1.ExportToCdwPipeline export_cdw_pipeline = 4;
        Specified by:
        getExportCdwPipeline in interface RunPipelineRequestOrBuilder
        Returns:
        The exportCdwPipeline.
      • 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;
        Specified by:
        hasProcessWithDocAiPipeline in interface RunPipelineRequestOrBuilder
        Returns:
        Whether the processWithDocAiPipeline field is set.
      • 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;
        Specified by:
        getProcessWithDocAiPipeline in interface RunPipelineRequestOrBuilder
        Returns:
        The processWithDocAiPipeline.
      • 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;
        Specified by:
        hasRequestMetadata in interface RunPipelineRequestOrBuilder
        Returns:
        Whether the requestMetadata field is set.
      • 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;
        Specified by:
        getRequestMetadata in interface RunPipelineRequestOrBuilder
        Returns:
        The requestMetadata.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3
      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
                     throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3
      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage
      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage
      • parseFrom

        public static RunPipelineRequest parseFrom​(ByteBuffer data)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static RunPipelineRequest parseFrom​(ByteBuffer data,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static RunPipelineRequest parseFrom​(com.google.protobuf.ByteString data)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static RunPipelineRequest parseFrom​(com.google.protobuf.ByteString data,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static RunPipelineRequest parseFrom​(byte[] data)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static RunPipelineRequest parseFrom​(byte[] data,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

        public static RunPipelineRequest parseFrom​(com.google.protobuf.CodedInputStream input,
                                                   com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                            throws IOException
        Throws:
        IOException
      • newBuilderForType

        public RunPipelineRequest.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite
      • toBuilder

        public RunPipelineRequest.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite
      • newBuilderForType

        protected RunPipelineRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getParserForType

        public com.google.protobuf.Parser<RunPipelineRequest> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3
      • getDefaultInstanceForType

        public RunPipelineRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder