Class GcsIngestPipeline (0.72.0)
Version 0.72.0keyboard_arrow_down
public final class GcsIngestPipeline extends GeneratedMessageV3 implements GcsIngestPipelineOrBuilder
The configuration of the Cloud Storage Ingestion pipeline.
Protobuf type google.cloud.contentwarehouse.v1.GcsIngestPipeline
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
INPUT_PATH_FIELD_NUMBER
public static final int INPUT_PATH_FIELD_NUMBER
Field Value
Type Description
int
PIPELINE_CONFIG_FIELD_NUMBER
public static final int PIPELINE_CONFIG_FIELD_NUMBER
Field Value
Type Description
int
PROCESSOR_TYPE_FIELD_NUMBER
public static final int PROCESSOR_TYPE_FIELD_NUMBER
Field Value
Type Description
int
SCHEMA_NAME_FIELD_NUMBER
public static final int SCHEMA_NAME_FIELD_NUMBER
Field Value
Type Description
int
SKIP_INGESTED_DOCUMENTS_FIELD_NUMBER
public static final int SKIP_INGESTED_DOCUMENTS_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static GcsIngestPipeline getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static GcsIngestPipeline . Builder newBuilder ()
newBuilder(GcsIngestPipeline prototype)
public static GcsIngestPipeline . Builder newBuilder ( GcsIngestPipeline prototype )
parseDelimitedFrom(InputStream input)
public static GcsIngestPipeline parseDelimitedFrom ( InputStream input )
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static GcsIngestPipeline parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static GcsIngestPipeline parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static GcsIngestPipeline parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static GcsIngestPipeline parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static GcsIngestPipeline parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
parseFrom(CodedInputStream input)
public static GcsIngestPipeline parseFrom ( CodedInputStream input )
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static GcsIngestPipeline parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(InputStream input)
public static GcsIngestPipeline parseFrom ( InputStream input )
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static GcsIngestPipeline parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static GcsIngestPipeline parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static GcsIngestPipeline parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<GcsIngestPipeline> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
getDefaultInstanceForType()
public GcsIngestPipeline getDefaultInstanceForType ()
getInputPath()
public String getInputPath ()
The input Cloud Storage folder. All files under this folder will be
imported to Document Warehouse.
Format: gs://<bucket-name>/<folder-name>.
string input_path = 1;
Returns
Type Description
String The inputPath.
getInputPathBytes()
public ByteString getInputPathBytes ()
The input Cloud Storage folder. All files under this folder will be
imported to Document Warehouse.
Format: gs://<bucket-name>/<folder-name>.
string input_path = 1;
Returns
Type Description
ByteString The bytes for inputPath.
getParserForType()
public Parser<GcsIngestPipeline> getParserForType ()
Overrides
getPipelineConfig()
public IngestPipelineConfig getPipelineConfig ()
Optional. The config for the Cloud Storage Ingestion pipeline.
It provides additional customization options to run the pipeline and can be
skipped if it is not applicable.
.google.cloud.contentwarehouse.v1.IngestPipelineConfig pipeline_config = 5 [(.google.api.field_behavior) = OPTIONAL];
getPipelineConfigOrBuilder()
public IngestPipelineConfigOrBuilder getPipelineConfigOrBuilder ()
Optional. The config for the Cloud Storage Ingestion pipeline.
It provides additional customization options to run the pipeline and can be
skipped if it is not applicable.
.google.cloud.contentwarehouse.v1.IngestPipelineConfig pipeline_config = 5 [(.google.api.field_behavior) = OPTIONAL];
getProcessorType()
public String getProcessorType ()
The Doc AI processor type name. Only used when the format of ingested
files is Doc AI Document proto format.
string processor_type = 3;
Returns
Type Description
String The processorType.
getProcessorTypeBytes()
public ByteString getProcessorTypeBytes ()
The Doc AI processor type name. Only used when the format of ingested
files is Doc AI Document proto format.
string processor_type = 3;
Returns
Type Description
ByteString The bytes for processorType.
getSchemaName()
public String getSchemaName ()
The Document Warehouse schema resource name. All documents processed by
this pipeline will use this schema.
Format:
projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.
string schema_name = 2;
Returns
Type Description
String The schemaName.
getSchemaNameBytes()
public ByteString getSchemaNameBytes ()
The Document Warehouse schema resource name. All documents processed by
this pipeline will use this schema.
Format:
projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.
string schema_name = 2;
Returns
Type Description
ByteString The bytes for schemaName.
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
getSkipIngestedDocuments()
public boolean getSkipIngestedDocuments ()
The flag whether to skip ingested documents.
If it is set to true, documents in Cloud Storage contains key "status" with
value "status=ingested" in custom metadata will be skipped to ingest.
bool skip_ingested_documents = 4;
Returns
Type Description
boolean The skipIngestedDocuments.
hasPipelineConfig()
public boolean hasPipelineConfig ()
Optional. The config for the Cloud Storage Ingestion pipeline.
It provides additional customization options to run the pipeline and can be
skipped if it is not applicable.
.google.cloud.contentwarehouse.v1.IngestPipelineConfig pipeline_config = 5 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type Description
boolean Whether the pipelineConfig field is set.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public GcsIngestPipeline . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected GcsIngestPipeline . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public GcsIngestPipeline . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-28 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-28 UTC."],[],[]]
