Class GcsIngestPipeline.Builder (0.25.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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > GcsIngestPipeline.Builder

Implements

GcsIngestPipelineOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

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

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

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public GcsIngestPipeline.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`GcsIngestPipeline.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public GcsIngestPipeline build()

Returns
Type	Description
`GcsIngestPipeline`

buildPartial()

public GcsIngestPipeline buildPartial()

Returns
Type	Description
`GcsIngestPipeline`

clear()

public GcsIngestPipeline.Builder clear()

Returns
Type	Description
`GcsIngestPipeline.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public GcsIngestPipeline.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`GcsIngestPipeline.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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
Type	Description
`GcsIngestPipeline.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public GcsIngestPipeline.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`GcsIngestPipeline.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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
Type	Description
`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
Type	Description
`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
Type	Description
`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
Type	Description
`GcsIngestPipeline.Builder`	This builder for chaining.

clone()

public GcsIngestPipeline.Builder clone()

Returns
Type	Description
`GcsIngestPipeline.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public GcsIngestPipeline getDefaultInstanceForType()

Returns
Type	Description
`GcsIngestPipeline`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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.

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.

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

string schema_name = 2;

Returns
Type	Description
`String`	The schemaName.

getSchemaNameBytes()

public ByteString getSchemaNameBytes()

string schema_name = 2;

Returns
Type	Description
`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
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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(GcsIngestPipeline other)

public GcsIngestPipeline.Builder mergeFrom(GcsIngestPipeline other)

Parameter
Name	Description
`other`	`GcsIngestPipeline`

Returns
Type	Description
`GcsIngestPipeline.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public GcsIngestPipeline.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`GcsIngestPipeline.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public GcsIngestPipeline.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`GcsIngestPipeline.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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
Name	Description
`value`	`IngestPipelineConfig`

Returns
Type	Description
`GcsIngestPipeline.Builder`

mergeUnknownFields(UnknownFieldSet unknownFields)

public final GcsIngestPipeline.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`GcsIngestPipeline.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setField(Descriptors.FieldDescriptor field, Object value)

public GcsIngestPipeline.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`GcsIngestPipeline.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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
Name	Description
`value`	`String` The inputPath to set.

Returns
Type	Description
`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
Name	Description
`value`	`ByteString` The bytes for inputPath to set.

Returns
Type	Description
`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
Name	Description
`value`	`IngestPipelineConfig`

Returns
Type	Description
`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
Name	Description
`builderForValue`	`IngestPipelineConfig.Builder`

Returns
Type	Description
`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
Name	Description
`value`	`String` The processorType to set.

Returns
Type	Description
`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
Name	Description
`value`	`ByteString` The bytes for processorType to set.

Returns
Type	Description
`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
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`GcsIngestPipeline.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setSchemaName(String value)

public GcsIngestPipeline.Builder setSchemaName(String value)

string schema_name = 2;

Parameter
Name	Description
`value`	`String` The schemaName to set.

Returns
Type	Description
`GcsIngestPipeline.Builder`	This builder for chaining.

setSchemaNameBytes(ByteString value)

public GcsIngestPipeline.Builder setSchemaNameBytes(ByteString value)

string schema_name = 2;

Parameter
Name	Description
`value`	`ByteString` The bytes for schemaName to set.

Returns
Type	Description
`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
Name	Description
`value`	`boolean` The skipIngestedDocuments to set.

Returns
Type	Description
`GcsIngestPipeline.Builder`	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final GcsIngestPipeline.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`GcsIngestPipeline.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)