Class GcsSource.Builder (0.33.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

Implements

GcsSourceOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
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
NameDescription
valuesIterable<String>

The inputUris to add.

Returns
TypeDescription
GcsSource.Builder

This builder for chaining.

addInputUris(String value)

public GcsSource.Builder addInputUris(String value)

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
NameDescription
valueString

The inputUris to add.

Returns
TypeDescription
GcsSource.Builder

This builder for chaining.

addInputUrisBytes(ByteString value)

public GcsSource.Builder addInputUrisBytes(ByteString value)

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
NameDescription
valueByteString

The bytes of the inputUris to add.

Returns
TypeDescription
GcsSource.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public GcsSource build()
Returns
TypeDescription
GcsSource

buildPartial()

public GcsSource buildPartial()
Returns
TypeDescription
GcsSource

clear()

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

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 becomes 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 to the defined Schema of the data store. This can only be used by Gen App Builder.
  • csv: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by Gen App Builder.

    Supported values for user even imports:

  • user_event (default): One JSON UserEvent per line.

string data_schema = 2;

Returns
TypeDescription
GcsSource.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearInputUris()

public GcsSource.Builder clearInputUris()

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

Returns
TypeDescription
GcsSource.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clone()

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

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 becomes 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 to the defined Schema of the data store. This can only be used by Gen App Builder.
  • csv: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by Gen App Builder.

    Supported values for user even imports:

  • user_event (default): One JSON UserEvent per line.

string data_schema = 2;

Returns
TypeDescription
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 becomes 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 to the defined Schema of the data store. This can only be used by Gen App Builder.
  • csv: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by Gen App Builder.

    Supported values for user even imports:

  • user_event (default): One JSON UserEvent per line.

string data_schema = 2;

Returns
TypeDescription
ByteString

The bytes for dataSchema.

getDefaultInstanceForType()

public GcsSource getDefaultInstanceForType()
Returns
TypeDescription
GcsSource

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getInputUris(int index)

public String getInputUris(int index)

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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The inputUris at the given index.

getInputUrisBytes(int index)

public ByteString getInputUrisBytes(int index)

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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the inputUris at the given index.

getInputUrisCount()

public int getInputUrisCount()

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

Returns
TypeDescription
int

The count of inputUris.

getInputUrisList()

public ProtocolStringList getInputUrisList()

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

Returns
TypeDescription
ProtocolStringList

A list containing the inputUris.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(GcsSource other)

public GcsSource.Builder mergeFrom(GcsSource other)
Parameter
NameDescription
otherGcsSource
Returns
TypeDescription
GcsSource.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

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 becomes 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 to the defined Schema of the data store. This can only be used by Gen App Builder.
  • csv: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by Gen App Builder.

    Supported values for user even imports:

  • user_event (default): One JSON UserEvent per line.

string data_schema = 2;

Parameter
NameDescription
valueString

The dataSchema to set.

Returns
TypeDescription
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 becomes 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 to the defined Schema of the data store. This can only be used by Gen App Builder.
  • csv: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by Gen App Builder.

    Supported values for user even imports:

  • user_event (default): One JSON UserEvent per line.

string data_schema = 2;

Parameter
NameDescription
valueByteString

The bytes for dataSchema to set.

Returns
TypeDescription
GcsSource.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setInputUris(int index, String value)

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

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

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The inputUris to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
GcsSource.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

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