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

__construct

Constructor.

Parameters
NameDescription
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}.

getCreateTime

Operation create time.

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

Returns
TypeDescription
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Operation create time.

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

Parameter
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getUpdateTime

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
TypeDescription
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

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
NameDescription
var Google\Protobuf\Timestamp
Returns
TypeDescription
$this

getSuccessCount

Count of entries that were processed successfully.

Generated from protobuf field int64 success_count = 3;

Returns
TypeDescription
int|string

setSuccessCount

Count of entries that were processed successfully.

Generated from protobuf field int64 success_count = 3;

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getFailureCount

Count of entries that encountered errors while processing.

Generated from protobuf field int64 failure_count = 4;

Returns
TypeDescription
int|string

setFailureCount

Count of entries that encountered errors while processing.

Generated from protobuf field int64 failure_count = 4;

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getRequestId

Deprecated. This field is never set.

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

Returns
TypeDescription
string

setRequestId

Deprecated. This field is never set.

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getNotificationPubsubTopic

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
TypeDescription
string

setNotificationPubsubTopic

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
NameDescription
var string
Returns
TypeDescription
$this