Google Cloud Discovery Engine V1beta Client - Class GcsSource (0.4.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1beta Client class GcsSource.

Cloud Storage location for input content.

Generated from protobuf message google.cloud.discoveryengine.v1beta.GcsSource

Namespace

Google \ Cloud \ DiscoveryEngine \ V1beta

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ input_uris array

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).

↳ data_schema string

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. * csv: A CSV file with header conforming the defined Schema of the data store. Each entry after the header will be imported as a Document. 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.

getInputUris

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).

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setInputUris

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).

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

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.
  • csv: A CSV file with header conforming the defined Schema of the data store. Each entry after the header will be imported as a Document. 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.
Returns
TypeDescription
string

setDataSchema

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.
  • csv: A CSV file with header conforming the defined Schema of the data store. Each entry after the header will be imported as a Document. 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.
Parameter
NameDescription
var string
Returns
TypeDescription
$this