Class GcsIngestPipeline (0.39.0)

public final class GcsIngestPipeline extends GeneratedMessageV3 implements GcsIngestPipelineOrBuilder

The configuration of the Cloud Storage Ingestion pipeline.

Protobuf type google.cloud.contentwarehouse.v1.GcsIngestPipeline

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()
Returns
Type Description
GcsIngestPipeline

getDescriptor()

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

newBuilder()

public static GcsIngestPipeline.Builder newBuilder()
Returns
Type Description
GcsIngestPipeline.Builder

newBuilder(GcsIngestPipeline prototype)

public static GcsIngestPipeline.Builder newBuilder(GcsIngestPipeline prototype)
Parameter
Name Description
prototype GcsIngestPipeline
Returns
Type Description
GcsIngestPipeline.Builder

parseDelimitedFrom(InputStream input)

public static GcsIngestPipeline parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GcsIngestPipeline
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GcsIngestPipeline parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GcsIngestPipeline
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static GcsIngestPipeline parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
GcsIngestPipeline
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static GcsIngestPipeline parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GcsIngestPipeline
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static GcsIngestPipeline parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
GcsIngestPipeline
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static GcsIngestPipeline parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GcsIngestPipeline
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static GcsIngestPipeline parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
GcsIngestPipeline
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static GcsIngestPipeline parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GcsIngestPipeline
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static GcsIngestPipeline parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
GcsIngestPipeline
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GcsIngestPipeline parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GcsIngestPipeline
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static GcsIngestPipeline parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
GcsIngestPipeline
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static GcsIngestPipeline parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
GcsIngestPipeline
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<GcsIngestPipeline> parser()
Returns
Type Description
Parser<GcsIngestPipeline>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public GcsIngestPipeline getDefaultInstanceForType()
Returns
Type Description
GcsIngestPipeline

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()
Returns
Type Description
Parser<GcsIngestPipeline>
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];

Returns
Type Description
IngestPipelineConfig

The pipelineConfig.

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];

Returns
Type Description
IngestPipelineConfigOrBuilder

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()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public GcsIngestPipeline.Builder newBuilderForType()
Returns
Type Description
GcsIngestPipeline.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected GcsIngestPipeline.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
GcsIngestPipeline.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public GcsIngestPipeline.Builder toBuilder()
Returns
Type Description
GcsIngestPipeline.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException