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

Class GoogleCloudDiscoveryengineV1UserInfo

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.GoogleCloudDiscoveryengineV1UserInfo

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Information of an end user.

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
GoogleCloudDiscoveryengineV1UserInfo()

Method Summary

Modifier and Type	Method and Description
GoogleCloudDiscoveryengineV1UserInfo	clone()
GoogleCloudDiscoveryengineV1UserInfoPreciseLocation	getPreciseLocation() Optional.
String	getTimeZone() Optional.
String	getUserAgent() User agent as included in the HTTP header.
String	getUserId() Highly recommended for logged-in users.
GoogleCloudDiscoveryengineV1UserInfo	set(String fieldName, Object value)
GoogleCloudDiscoveryengineV1UserInfo	setPreciseLocation(GoogleCloudDiscoveryengineV1UserInfoPreciseLocation preciseLocation) Optional.
GoogleCloudDiscoveryengineV1UserInfo	setTimeZone(String timeZone) Optional.
GoogleCloudDiscoveryengineV1UserInfo	setUserAgent(String userAgent) User agent as included in the HTTP header.
GoogleCloudDiscoveryengineV1UserInfo	setUserId(String userId) Highly recommended for logged-in users.

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

GoogleCloudDiscoveryengineV1UserInfo

public GoogleCloudDiscoveryengineV1UserInfo()

Method Detail

getPreciseLocation

public GoogleCloudDiscoveryengineV1UserInfoPreciseLocation getPreciseLocation()

Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents.

Returns:

value or null for none

setPreciseLocation

public GoogleCloudDiscoveryengineV1UserInfo setPreciseLocation(GoogleCloudDiscoveryengineV1UserInfoPreciseLocation preciseLocation)

Optional. Input only. Precise location of the user. It is used in Custom Ranking to calculate the distance between the user and the relevant documents.

Parameters:

preciseLocation - preciseLocation or null for none

getTimeZone

public String getTimeZone()

Optional. IANA time zone, e.g. Europe/Budapest.

Returns:

value or null for none

setTimeZone

public GoogleCloudDiscoveryengineV1UserInfo setTimeZone(String timeZone)

Optional. IANA time zone, e.g. Europe/Budapest.

Parameters:

timeZone - timeZone or null for none

getUserAgent

public String getUserAgent()

User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.

Returns:

value or null for none

setUserAgent

public GoogleCloudDiscoveryengineV1UserInfo setUserAgent(String userAgent)

User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.

Parameters:

userAgent - userAgent or null for none

getUserId

public String getUserId()

Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded.

Returns:

value or null for none

setUserId

public GoogleCloudDiscoveryengineV1UserInfo setUserId(String userId)

Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. Represents an opaque ID to the Search API. The Search API doesn't interpret the value in any way. This field is used to associate events with a user across sessions if the events are being uploaded.

Parameters:

userId - userId or null for none

set

public GoogleCloudDiscoveryengineV1UserInfo set(String fieldName,
                                                Object value)

Overrides:

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

clone

public GoogleCloudDiscoveryengineV1UserInfo clone()

Overrides:

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