Google Cloud Discovery Engine V1 Client - Class DocumentInfo (0.4.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class DocumentInfo.

Detailed document information associated with a user event.

Generated from protobuf message google.cloud.discoveryengine.v1.DocumentInfo

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ id string

Required. The Document resource ID.

↳ name string

Required. The Document resource full name, of the form: projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}

↳ quantity int

Quantity of the Document associated with the user event. Defaults to 1. For example, this field will be 2 if two quantities of the same Document are involved in a add-to-cart event. Required for events of the following event types: * add-to-cart * purchase

↳ promotion_ids array

The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID.

getId

Required. The Document resource ID.

Returns
TypeDescription
string

hasId

setId

Required. The Document resource ID.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getName

Required. The Document resource full name, of the form: projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}

Returns
TypeDescription
string

hasName

setName

Required. The Document resource full name, of the form: projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getQuantity

Quantity of the Document associated with the user event. Defaults to 1.

For example, this field will be 2 if two quantities of the same Document are involved in a add-to-cart event. Required for events of the following event types:

  • add-to-cart
  • purchase
Returns
TypeDescription
int

hasQuantity

clearQuantity

setQuantity

Quantity of the Document associated with the user event. Defaults to 1.

For example, this field will be 2 if two quantities of the same Document are involved in a add-to-cart event. Required for events of the following event types:

  • add-to-cart
  • purchase
Parameter
NameDescription
var int
Returns
TypeDescription
$this

getPromotionIds

The promotion IDs associated with this Document.

Currently, this field is restricted to at most one ID.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setPromotionIds

The promotion IDs associated with this Document.

Currently, this field is restricted to at most one ID.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getDocumentDescriptor

Returns
TypeDescription
string