Google Shopping Merchant DataSources V1 Client - Class FileUpload (1.1.1)

Reference documentation and code samples for the Google Shopping Merchant DataSources V1 Client class FileUpload.

The file upload of a specific data source, that is, the result of the retrieval of the data source at a certain timestamp computed asynchronously when the data source processing is finished. Only applicable to file data sources.

Generated from protobuf message google.shopping.merchant.datasources.v1.FileUpload

Namespace

Google \ Shopping \ Merchant \ DataSources \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Identifier. The name of the data source file upload. Format: {datasource.name=accounts/{account}/dataSources/{datasource}/fileUploads/{fileupload}}
↳ data_source_id int|string

Output only. The data source id.
↳ processing_state int

Output only. The processing state of the data source.
↳ issues array<FileUpload\Issue>

Output only. The list of issues occurring in the data source.
↳ items_total int|string

Output only. The number of items in the data source that were processed.
↳ items_created int|string

Output only. The number of items in the data source that were created.
↳ items_updated int|string

Output only. The number of items in the data source that were updated.
↳ upload_time Google\Protobuf\Timestamp

Output only. The date at which the file of the data source was uploaded.

getName

Identifier. The name of the data source file upload.

Format: {datasource.name=accounts/{account}/dataSources/{datasource}/fileUploads/{fileupload}}

Returns
Type Description
string

setName

Identifier. The name of the data source file upload.

Format: {datasource.name=accounts/{account}/dataSources/{datasource}/fileUploads/{fileupload}}

Parameter
Name Description
var string
Returns
Type Description
$this

getDataSourceId

Output only. The data source id.

Returns
Type Description
int|string

setDataSourceId

Output only. The data source id.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getProcessingState

Output only. The processing state of the data source.

Returns
Type Description
int Enum of type ProcessingState.

setProcessingState

Output only. The processing state of the data source.

Parameter
Name Description
var int

Enum of type ProcessingState.

Returns
Type Description
$this

getIssues

Output only. The list of issues occurring in the data source.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setIssues

Output only. The list of issues occurring in the data source.

Parameter
Name Description
var array<FileUpload\Issue>
Returns
Type Description
$this

getItemsTotal

Output only. The number of items in the data source that were processed.

Returns
Type Description
int|string

setItemsTotal

Output only. The number of items in the data source that were processed.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getItemsCreated

Output only. The number of items in the data source that were created.

Returns
Type Description
int|string

setItemsCreated

Output only. The number of items in the data source that were created.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getItemsUpdated

Output only. The number of items in the data source that were updated.

Returns
Type Description
int|string

setItemsUpdated

Output only. The number of items in the data source that were updated.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getUploadTime

Output only. The date at which the file of the data source was uploaded.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUploadTime

clearUploadTime

setUploadTime

Output only. The date at which the file of the data source was uploaded.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this