com.google.api.services.discoveryengine.v1.model

Class GoogleCloudDiscoveryengineV1DocumentInfo

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.discoveryengine.v1.model.GoogleCloudDiscoveryengineV1DocumentInfo

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class GoogleCloudDiscoveryengineV1DocumentInfo
extends com.google.api.client.json.GenericJson

Detailed document information associated with a user event.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Discovery Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
GoogleCloudDiscoveryengineV1DocumentInfo()

Method Summary

Modifier and Type	Method and Description
GoogleCloudDiscoveryengineV1DocumentInfo	clone()
Float	getConversionValue() Optional.
String	getId() The Document resource ID.
Boolean	getJoined() Output only.
String	getName() The Document resource full name, of the form: `projects/{project}/locations/{location}/collecti ons/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`
List<String>	getPromotionIds() The promotion IDs associated with this Document.
Integer	getQuantity() Quantity of the Document associated with the user event.
String	getUri() The Document URI - only allowed for website data stores.
GoogleCloudDiscoveryengineV1DocumentInfo	set(String fieldName, Object value)
GoogleCloudDiscoveryengineV1DocumentInfo	setConversionValue(Float conversionValue) Optional.
GoogleCloudDiscoveryengineV1DocumentInfo	setId(String id) The Document resource ID.
GoogleCloudDiscoveryengineV1DocumentInfo	setJoined(Boolean joined) Output only.
GoogleCloudDiscoveryengineV1DocumentInfo	setName(String name) The Document resource full name, of the form: `projects/{project}/locations/{location}/collecti ons/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`
GoogleCloudDiscoveryengineV1DocumentInfo	setPromotionIds(List<String> promotionIds) The promotion IDs associated with this Document.
GoogleCloudDiscoveryengineV1DocumentInfo	setQuantity(Integer quantity) Quantity of the Document associated with the user event.
GoogleCloudDiscoveryengineV1DocumentInfo	setUri(String uri) The Document URI - only allowed for website data stores.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

GoogleCloudDiscoveryengineV1DocumentInfo

public GoogleCloudDiscoveryengineV1DocumentInfo()

Method Detail

getConversionValue

public Float getConversionValue()

Optional. The conversion value associated with this Document. Must be set if UserEvent.event_type is "conversion". For example, a value of 1000 signifies that 1000 seconds were spent viewing a Document for the `watch` conversion type.

Returns:

value or null for none

setConversionValue

public GoogleCloudDiscoveryengineV1DocumentInfo setConversionValue(Float conversionValue)

Optional. The conversion value associated with this Document. Must be set if UserEvent.event_type is "conversion". For example, a value of 1000 signifies that 1000 seconds were spent viewing a Document for the `watch` conversion type.

Parameters:

conversionValue - conversionValue or null for none

getId

public String getId()

The Document resource ID.

Returns:

value or null for none

setId

public GoogleCloudDiscoveryengineV1DocumentInfo setId(String id)

The Document resource ID.

Parameters:

id - id or null for none

getJoined

public Boolean getJoined()

Output only. Whether the referenced Document can be found in the data store.

Returns:

value or null for none

setJoined

public GoogleCloudDiscoveryengineV1DocumentInfo setJoined(Boolean joined)

Output only. Whether the referenced Document can be found in the data store.

Parameters:

joined - joined or null for none

getName

public String getName()

The Document resource full name, of the form: `projects/{project}/locations/{location}/collecti ons/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`

Returns:

value or null for none

setName

public GoogleCloudDiscoveryengineV1DocumentInfo setName(String name)

The Document resource full name, of the form: `projects/{project}/locations/{location}/collecti ons/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`

Parameters:

name - name or null for none

getPromotionIds

public List<String> getPromotionIds()

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

Returns:

value or null for none

setPromotionIds

public GoogleCloudDiscoveryengineV1DocumentInfo setPromotionIds(List<String> promotionIds)

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

Parameters:

promotionIds - promotionIds or null for none

getQuantity

public Integer 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:

value or null for none

setQuantity

public GoogleCloudDiscoveryengineV1DocumentInfo setQuantity(Integer quantity)

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`

Parameters:

quantity - quantity or null for none

getUri

public String getUri()

The Document URI - only allowed for website data stores.

Returns:

value or null for none

setUri

public GoogleCloudDiscoveryengineV1DocumentInfo setUri(String uri)

The Document URI - only allowed for website data stores.

Parameters:

uri - uri or null for none

set

public GoogleCloudDiscoveryengineV1DocumentInfo set(String fieldName,
                                                    Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public GoogleCloudDiscoveryengineV1DocumentInfo clone()

Overrides:

clone in class com.google.api.client.json.GenericJson