Google Cloud Retail V2 Client - Class ImportMetadata (1.0.1)

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

Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.

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

Methods

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ create_time
Google\Protobuf\Timestamp

Operation create time.

↳ update_time
Google\Protobuf\Timestamp

Operation last update time. If the operation is done, this is also the finish time.

↳ success_count
int|string

Count of entries that were processed successfully.

↳ failure_count
int|string

Count of entries that encountered errors while processing.

↳ request_id
string

Deprecated. This field is never set.

↳ notification_pubsub_topic
string

Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification is sent to specified Pub/Sub topic. The message data is JSON string of a Operation . Format of the Pub/Sub topic is projects/{project}/topics/{topic} .

Operation create time.

Generated from protobuf field .google.protobuf.Timestamp create_time = 1;

Returns
Type
Description
Google\Protobuf\Timestamp|null

Operation create time.

Generated from protobuf field .google.protobuf.Timestamp create_time = 1;

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

Operation last update time. If the operation is done, this is also the finish time.

Generated from protobuf field .google.protobuf.Timestamp update_time = 2;

Returns
Type
Description
Google\Protobuf\Timestamp|null

Operation last update time. If the operation is done, this is also the finish time.

Generated from protobuf field .google.protobuf.Timestamp update_time = 2;

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

Count of entries that were processed successfully.

Generated from protobuf field int64 success_count = 3;

Returns
Type
Description
int|string

Count of entries that were processed successfully.

Generated from protobuf field int64 success_count = 3;

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

Count of entries that encountered errors while processing.

Generated from protobuf field int64 failure_count = 4;

Returns
Type
Description
int|string

Count of entries that encountered errors while processing.

Generated from protobuf field int64 failure_count = 4;

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

Deprecated. This field is never set.

Generated from protobuf field string request_id = 5 [deprecated = true];

Returns
Type
Description
string

Deprecated. This field is never set.

Generated from protobuf field string request_id = 5 [deprecated = true];

Parameter
Name
Description
var
string
Returns
Type
Description
$this

Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification is sent to specified Pub/Sub topic. The message data is JSON string of a Operation .

Format of the Pub/Sub topic is projects/{project}/topics/{topic} .

Generated from protobuf field string notification_pubsub_topic = 6;

Returns
Type
Description
string

Pub/Sub topic for receiving notification. If this field is set, when the import is finished, a notification is sent to specified Pub/Sub topic. The message data is JSON string of a Operation .

Format of the Pub/Sub topic is projects/{project}/topics/{topic} .

Generated from protobuf field string notification_pubsub_topic = 6;

Parameter
Name
Description
var
string
Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: