Google Cloud Discovery Engine V1 Client - Class DocumentInfo (0.5.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
Name	Description
`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
Type	Description
`string`

hasId

setId

Required. The Document resource ID.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$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
Type	Description
`string`

hasName

setName

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$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
Type	Description
`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
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getPromotionIds

The promotion IDs associated with this Document.

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

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setPromotionIds

The promotion IDs associated with this Document.

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

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getDocumentDescriptor

Returns
Type	Description
`string`