Google Cloud Retail V2 Client - Class ImportCompletionDataRequest (1.0.1)

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

Request message for ImportCompletionData methods.

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

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The catalog which the suggestions dataset belongs to. Format: projects/1234/locations/global/catalogs/default_catalog.

↳ input_config Google\Cloud\Retail\V2\CompletionDataInputConfig

Required. The desired input location of the data.

↳ 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}.

getParent

Required. The catalog which the suggestions dataset belongs to.

Format: projects/1234/locations/global/catalogs/default_catalog.

Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Returns
TypeDescription
string

setParent

Required. The catalog which the suggestions dataset belongs to.

Format: projects/1234/locations/global/catalogs/default_catalog.

Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getInputConfig

Required. The desired input location of the data.

Generated from protobuf field .google.cloud.retail.v2.CompletionDataInputConfig input_config = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
Google\Cloud\Retail\V2\CompletionDataInputConfig|null

hasInputConfig

clearInputConfig

setInputConfig

Required. The desired input location of the data.

Generated from protobuf field .google.cloud.retail.v2.CompletionDataInputConfig input_config = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
NameDescription
var Google\Cloud\Retail\V2\CompletionDataInputConfig
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 = 3;

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 = 3;

Parameter
NameDescription
var string
Returns
TypeDescription
$this