Class GcsIngestPipeline.Builder (0.31.0)

public static final class GcsIngestPipeline.Builder extends GeneratedMessageV3.Builder<GcsIngestPipeline.Builder> implements GcsIngestPipelineOrBuilder

The configuration of the Cloud Storage Ingestion pipeline.

Protobuf type google.cloud.contentwarehouse.v1.GcsIngestPipeline

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public GcsIngestPipeline.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
GcsIngestPipeline.Builder
Overrides

build()

public GcsIngestPipeline build()
Returns
TypeDescription
GcsIngestPipeline

buildPartial()

public GcsIngestPipeline buildPartial()
Returns
TypeDescription
GcsIngestPipeline

clear()

public GcsIngestPipeline.Builder clear()
Returns
TypeDescription
GcsIngestPipeline.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public GcsIngestPipeline.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
GcsIngestPipeline.Builder
Overrides

clearInputPath()

public GcsIngestPipeline.Builder clearInputPath()

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

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public GcsIngestPipeline.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
GcsIngestPipeline.Builder
Overrides

clearPipelineConfig()

public GcsIngestPipeline.Builder clearPipelineConfig()

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

clearProcessorType()

public GcsIngestPipeline.Builder clearProcessorType()

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

This builder for chaining.

clearSchemaName()

public GcsIngestPipeline.Builder clearSchemaName()

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

This builder for chaining.

clearSkipIngestedDocuments()

public GcsIngestPipeline.Builder clearSkipIngestedDocuments()

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

This builder for chaining.

clone()

public GcsIngestPipeline.Builder clone()
Returns
TypeDescription
GcsIngestPipeline.Builder
Overrides

getDefaultInstanceForType()

public GcsIngestPipeline getDefaultInstanceForType()
Returns
TypeDescription
GcsIngestPipeline

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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
TypeDescription
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
TypeDescription
ByteString

The bytes for inputPath.

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
TypeDescription
IngestPipelineConfig

The pipelineConfig.

getPipelineConfigBuilder()

public IngestPipelineConfig.Builder getPipelineConfigBuilder()

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

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for schemaName.

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
TypeDescription
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
TypeDescription
boolean

Whether the pipelineConfig field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(GcsIngestPipeline other)

public GcsIngestPipeline.Builder mergeFrom(GcsIngestPipeline other)
Parameter
NameDescription
otherGcsIngestPipeline
Returns
TypeDescription
GcsIngestPipeline.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public GcsIngestPipeline.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
GcsIngestPipeline.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public GcsIngestPipeline.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
GcsIngestPipeline.Builder
Overrides

mergePipelineConfig(IngestPipelineConfig value)

public GcsIngestPipeline.Builder mergePipelineConfig(IngestPipelineConfig value)

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

Parameter
NameDescription
valueIngestPipelineConfig
Returns
TypeDescription
GcsIngestPipeline.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final GcsIngestPipeline.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
GcsIngestPipeline.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public GcsIngestPipeline.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
GcsIngestPipeline.Builder
Overrides

setInputPath(String value)

public GcsIngestPipeline.Builder setInputPath(String value)

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;

Parameter
NameDescription
valueString

The inputPath to set.

Returns
TypeDescription
GcsIngestPipeline.Builder

This builder for chaining.

setInputPathBytes(ByteString value)

public GcsIngestPipeline.Builder setInputPathBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for inputPath to set.

Returns
TypeDescription
GcsIngestPipeline.Builder

This builder for chaining.

setPipelineConfig(IngestPipelineConfig value)

public GcsIngestPipeline.Builder setPipelineConfig(IngestPipelineConfig value)

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

Parameter
NameDescription
valueIngestPipelineConfig
Returns
TypeDescription
GcsIngestPipeline.Builder

setPipelineConfig(IngestPipelineConfig.Builder builderForValue)

public GcsIngestPipeline.Builder setPipelineConfig(IngestPipelineConfig.Builder builderForValue)

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

Parameter
NameDescription
builderForValueIngestPipelineConfig.Builder
Returns
TypeDescription
GcsIngestPipeline.Builder

setProcessorType(String value)

public GcsIngestPipeline.Builder setProcessorType(String value)

The Doc AI processor type name. Only used when the format of ingested files is Doc AI Document proto format.

string processor_type = 3;

Parameter
NameDescription
valueString

The processorType to set.

Returns
TypeDescription
GcsIngestPipeline.Builder

This builder for chaining.

setProcessorTypeBytes(ByteString value)

public GcsIngestPipeline.Builder setProcessorTypeBytes(ByteString value)

The Doc AI processor type name. Only used when the format of ingested files is Doc AI Document proto format.

string processor_type = 3;

Parameter
NameDescription
valueByteString

The bytes for processorType to set.

Returns
TypeDescription
GcsIngestPipeline.Builder

This builder for chaining.

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

public GcsIngestPipeline.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
GcsIngestPipeline.Builder
Overrides

setSchemaName(String value)

public GcsIngestPipeline.Builder setSchemaName(String value)

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;

Parameter
NameDescription
valueString

The schemaName to set.

Returns
TypeDescription
GcsIngestPipeline.Builder

This builder for chaining.

setSchemaNameBytes(ByteString value)

public GcsIngestPipeline.Builder setSchemaNameBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for schemaName to set.

Returns
TypeDescription
GcsIngestPipeline.Builder

This builder for chaining.

setSkipIngestedDocuments(boolean value)

public GcsIngestPipeline.Builder setSkipIngestedDocuments(boolean value)

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;

Parameter
NameDescription
valueboolean

The skipIngestedDocuments to set.

Returns
TypeDescription
GcsIngestPipeline.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final GcsIngestPipeline.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
GcsIngestPipeline.Builder
Overrides