Class GcsIngestPipeline (0.23.0)

Version 0.23.0

• 0.49.0 (latest)
• 0.48.0
• 0.47.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public final class GcsIngestPipeline extends GeneratedMessageV3 implements GcsIngestPipelineOrBuilder

The configuration of the Cloud Storage Ingestion pipeline.

Protobuf type google.cloud.contentwarehouse.v1.GcsIngestPipeline

Inheritance

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

Implements

GcsIngestPipelineOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

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

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,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()

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

AbstractMessage.equals(Object other)

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

GeneratedMessageV3.getParserForType()

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

GeneratedMessageV3.getSerializedSize()

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

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

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

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public GcsIngestPipeline.Builder toBuilder()

Returns
Type	Description
GcsIngestPipeline.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException