Google Cloud Retail V2 Client - Class GcsSource (1.0.1)

Reference documentation and code samples for the Google Cloud Retail V2 Client class GcsSource.

Google Cloud Storage location for input content.

Generated from protobuf message google.cloud.retail.v2.GcsSource

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ input_uris array

Required. Google 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, and each file can be up to 2 GB. See Importing product information for the expected file format and setup instructions.

↳ data_schema string

The schema to use when parsing the data from the source. Supported values for product imports: * product (default): One JSON Product per line. Each product must have a valid Product.id. * product_merchant_center: See Importing catalog data from Merchant Center. Supported values for user events imports: * user_event (default): One JSON UserEvent per line. * user_event_ga360: Using https://support.google.com/analytics/answer/3437719. Supported values for control imports: * control (default): One JSON Control per line. Supported values for catalog attribute imports: * catalog_attribute (default): One CSV CatalogAttribute per line.

getInputUris

Required. Google 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, and each file can be up to 2 GB. See Importing product information for the expected file format and setup instructions.

Generated from protobuf field repeated string input_uris = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setInputUris

Required. Google 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, and each file can be up to 2 GB. See Importing product information for the expected file format and setup instructions.

Generated from protobuf field repeated string input_uris = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getDataSchema

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

Supported values for product imports:

Generated from protobuf field string data_schema = 2;

Returns
TypeDescription
string

setDataSchema

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

Supported values for product imports:

Generated from protobuf field string data_schema = 2;

Parameter
NameDescription
var string
Returns
TypeDescription
$this