Class GcsSource.Builder (0.18.0)

public static final class GcsSource.Builder extends GeneratedMessageV3.Builder<GcsSource.Builder> implements GcsSourceOrBuilder

Cloud Storage location for input content.

Protobuf type google.cloud.discoveryengine.v1.GcsSource

Inheritance

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

Implements

GcsSourceOrBuilder

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

addAllInputUris(Iterable<String> values)

public GcsSource.Builder addAllInputUris(Iterable<String> values)

Required. Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, gs://bucket/directory/object.json) or a pattern matching one or more files, such as gs://bucket/directory/*.json.

A request can contain at most 100 files (or 100,000 files if data_schema is content). Each file can be up to 2 GB (or 100 MB if data_schema is content).

repeated string input_uris = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`values`	`Iterable<String>` The inputUris to add.

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

addInputUris(String value)

public GcsSource.Builder addInputUris(String value)

A request can contain at most 100 files (or 100,000 files if data_schema is content). Each file can be up to 2 GB (or 100 MB if data_schema is content).

repeated string input_uris = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`value`	`String` The inputUris to add.

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

addInputUrisBytes(ByteString value)

public GcsSource.Builder addInputUrisBytes(ByteString value)

A request can contain at most 100 files (or 100,000 files if data_schema is content). Each file can be up to 2 GB (or 100 MB if data_schema is content).

repeated string input_uris = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`value`	`ByteString` The bytes of the inputUris to add.

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

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

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

Returns
Type	Description
`GcsSource.Builder`

Overrides

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

build()

public GcsSource build()

Returns
Type	Description
`GcsSource`

buildPartial()

public GcsSource buildPartial()

Returns
Type	Description
`GcsSource`

clear()

public GcsSource.Builder clear()

Returns
Type	Description
`GcsSource.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearDataSchema()

public GcsSource.Builder clearDataSchema()

The schema to use when parsing the data from the source.

Supported values for document imports:

document (default): One JSON Document per line. Each document must have a valid Document.id.
content: Unstructured data (e.g. PDF, HTML). Each file matched by input_uris will become a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string.
custom: One custom data JSON per row in arbitrary format that conforms the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical.

Supported values for user even imports:
user_event (default): One JSON UserEvent per line.

string data_schema = 2;

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

clearField(Descriptors.FieldDescriptor field)

public GcsSource.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`GcsSource.Builder`

Overrides

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

clearInputUris()

public GcsSource.Builder clearInputUris()

A request can contain at most 100 files (or 100,000 files if data_schema is content). Each file can be up to 2 GB (or 100 MB if data_schema is content).

repeated string input_uris = 1 [(.google.api.field_behavior) = REQUIRED];

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

clearOneof(Descriptors.OneofDescriptor oneof)

public GcsSource.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`GcsSource.Builder`

Overrides

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

clone()

public GcsSource.Builder clone()

Returns
Type	Description
`GcsSource.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDataSchema()

public String getDataSchema()

The schema to use when parsing the data from the source.

Supported values for document imports:

document (default): One JSON Document per line. Each document must have a valid Document.id.
content: Unstructured data (e.g. PDF, HTML). Each file matched by input_uris will become a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string.
custom: One custom data JSON per row in arbitrary format that conforms the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical.

Supported values for user even imports:
user_event (default): One JSON UserEvent per line.

string data_schema = 2;

Returns
Type	Description
`String`	The dataSchema.

getDataSchemaBytes()

public ByteString getDataSchemaBytes()

The schema to use when parsing the data from the source.

Supported values for document imports:

document (default): One JSON Document per line. Each document must have a valid Document.id.
content: Unstructured data (e.g. PDF, HTML). Each file matched by input_uris will become a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string.
custom: One custom data JSON per row in arbitrary format that conforms the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical.

Supported values for user even imports:
user_event (default): One JSON UserEvent per line.

string data_schema = 2;

Returns
Type	Description
`ByteString`	The bytes for dataSchema.

getDefaultInstanceForType()

public GcsSource getDefaultInstanceForType()

Returns
Type	Description
`GcsSource`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getInputUris(int index)

public String getInputUris(int index)

A request can contain at most 100 files (or 100,000 files if data_schema is content). Each file can be up to 2 GB (or 100 MB if data_schema is content).

repeated string input_uris = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`index`	`int` The index of the element to return.

Returns
Type	Description
`String`	The inputUris at the given index.

getInputUrisBytes(int index)

public ByteString getInputUrisBytes(int index)

A request can contain at most 100 files (or 100,000 files if data_schema is content). Each file can be up to 2 GB (or 100 MB if data_schema is content).

repeated string input_uris = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`index`	`int` The index of the value to return.

Returns
Type	Description
`ByteString`	The bytes of the inputUris at the given index.

getInputUrisCount()

public int getInputUrisCount()

A request can contain at most 100 files (or 100,000 files if data_schema is content). Each file can be up to 2 GB (or 100 MB if data_schema is content).

repeated string input_uris = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`int`	The count of inputUris.

getInputUrisList()

public ProtocolStringList getInputUrisList()

A request can contain at most 100 files (or 100,000 files if data_schema is content). Each file can be up to 2 GB (or 100 MB if data_schema is content).

repeated string input_uris = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`ProtocolStringList`	A list containing the inputUris.

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

public GcsSource.Builder mergeFrom(GcsSource other)

Parameter
Name	Description
`other`	`GcsSource`

Returns
Type	Description
`GcsSource.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

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

Returns
Type	Description
`GcsSource.Builder`

Overrides

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

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public GcsSource.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`GcsSource.Builder`

Overrides

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final GcsSource.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`GcsSource.Builder`

Overrides

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

setDataSchema(String value)

public GcsSource.Builder setDataSchema(String value)

The schema to use when parsing the data from the source.

Supported values for document imports:

document (default): One JSON Document per line. Each document must have a valid Document.id.
content: Unstructured data (e.g. PDF, HTML). Each file matched by input_uris will become a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string.
custom: One custom data JSON per row in arbitrary format that conforms the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical.

Supported values for user even imports:
user_event (default): One JSON UserEvent per line.

string data_schema = 2;

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

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

setDataSchemaBytes(ByteString value)

public GcsSource.Builder setDataSchemaBytes(ByteString value)

The schema to use when parsing the data from the source.

Supported values for document imports:

document (default): One JSON Document per line. Each document must have a valid Document.id.
content: Unstructured data (e.g. PDF, HTML). Each file matched by input_uris will become a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string.
custom: One custom data JSON per row in arbitrary format that conforms the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical.

Supported values for user even imports:
user_event (default): One JSON UserEvent per line.

string data_schema = 2;

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

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

setField(Descriptors.FieldDescriptor field, Object value)

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

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

Returns
Type	Description
`GcsSource.Builder`

Overrides

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

setInputUris(int index, String value)

public GcsSource.Builder setInputUris(int index, String value)

A request can contain at most 100 files (or 100,000 files if data_schema is content). Each file can be up to 2 GB (or 100 MB if data_schema is content).

repeated string input_uris = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters
Name	Description
`index`	`int` The index to set the value at.
`value`	`String` The inputUris to set.

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

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

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

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

Returns
Type	Description
`GcsSource.Builder`

Overrides

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

setUnknownFields(UnknownFieldSet unknownFields)

public final GcsSource.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`GcsSource.Builder`

Overrides

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