Google Cloud Discovery Engine V1beta Client - Class DocumentInfo (0.11.3)

Version 0.11.3

• 1.3.1 (latest)
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.11.3
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.1

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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

Detailed document information associated with a user event.

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

Namespace

Google \ Cloud \ DiscoveryEngine \ V1beta

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ id	string The Document resource ID.
↳ name	string 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}
↳ uri	string The Document URI - only allowed for website data stores.
↳ quantity	int Quantity of the Document associated with the user event. Defaults to 1. For example, this field is 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

The Document resource ID.

Returns
Type	Description
string

hasId

setId

The Document resource ID.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getName

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

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
Name	Description
var	string

Returns
Type	Description
$this

getUri

The Document URI - only allowed for website data stores.

Returns
Type	Description
string

hasUri

setUri

The Document URI - only allowed for website data stores.

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 is 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 is 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