Class UserInfo.Builder (2.56.0) 

public static final class UserInfo.Builder extends GeneratedMessageV3.Builder<UserInfo.Builder> implements UserInfoOrBuilder

Information of an end user.

Protobuf type google.cloud.retail.v2alpha.UserInfo

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > UserInfo.Builder

Implements

UserInfoOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public UserInfo.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
UserInfo.Builder
Overrides

build()

public UserInfo build()
Returns
Type Description
UserInfo

buildPartial()

public UserInfo buildPartial()
Returns
Type Description
UserInfo

clear()

public UserInfo.Builder clear()
Returns
Type Description
UserInfo.Builder
Overrides

clearDirectUserRequest()

public UserInfo.Builder clearDirectUserRequest()

True if the request is made directly from the end user, in which case the ip_address and user_agent can be populated from the HTTP request. This flag should be set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events).

This should not be set when using the JavaScript tag in UserEventService.CollectUserEvent.

bool direct_user_request = 4;

Returns
Type Description
UserInfo.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public UserInfo.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
UserInfo.Builder
Overrides

clearIpAddress()

public UserInfo.Builder clearIpAddress()

The end user's IP address. This field is used to extract location information for personalization.

This field must be either an IPv4 address (e.g. "104.133.9.80") or an IPv6 address (e.g. "2001:0db8:85a3:0000:0000:8a2e:0370:7334"). Otherwise, an INVALID_ARGUMENT error is returned.

This should not be set when:

  • setting SearchRequest.user_info.
  • using the JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set.

string ip_address = 2;

Returns
Type Description
UserInfo.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public UserInfo.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
UserInfo.Builder
Overrides

clearUserAgent()

public UserInfo.Builder clearUserAgent()

User agent as included in the HTTP header. Required for getting SearchResponse.sponsored_results.

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 direct_user_request is set.

string user_agent = 3;

Returns
Type Description
UserInfo.Builder

This builder for chaining.

clearUserId()

public UserInfo.Builder clearUserId()

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.

string user_id = 1;

Returns
Type Description
UserInfo.Builder

This builder for chaining.

clone()

public UserInfo.Builder clone()
Returns
Type Description
UserInfo.Builder
Overrides

getDefaultInstanceForType()

public UserInfo getDefaultInstanceForType()
Returns
Type Description
UserInfo

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDirectUserRequest()

public boolean getDirectUserRequest()

True if the request is made directly from the end user, in which case the ip_address and user_agent can be populated from the HTTP request. This flag should be set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events).

This should not be set when using the JavaScript tag in UserEventService.CollectUserEvent.

bool direct_user_request = 4;

Returns
Type Description
boolean

The directUserRequest.

getIpAddress()

public String getIpAddress()

The end user's IP address. This field is used to extract location information for personalization.

This field must be either an IPv4 address (e.g. "104.133.9.80") or an IPv6 address (e.g. "2001:0db8:85a3:0000:0000:8a2e:0370:7334"). Otherwise, an INVALID_ARGUMENT error is returned.

This should not be set when:

  • setting SearchRequest.user_info.
  • using the JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set.

string ip_address = 2;

Returns
Type Description
String

The ipAddress.

getIpAddressBytes()

public ByteString getIpAddressBytes()

The end user's IP address. This field is used to extract location information for personalization.

This field must be either an IPv4 address (e.g. "104.133.9.80") or an IPv6 address (e.g. "2001:0db8:85a3:0000:0000:8a2e:0370:7334"). Otherwise, an INVALID_ARGUMENT error is returned.

This should not be set when:

  • setting SearchRequest.user_info.
  • using the JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set.

string ip_address = 2;

Returns
Type Description
ByteString

The bytes for ipAddress.

getUserAgent()

public String getUserAgent()

User agent as included in the HTTP header. Required for getting SearchResponse.sponsored_results.

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 direct_user_request is set.

string user_agent = 3;

Returns
Type Description
String

The userAgent.

getUserAgentBytes()

public ByteString getUserAgentBytes()

User agent as included in the HTTP header. Required for getting SearchResponse.sponsored_results.

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 direct_user_request is set.

string user_agent = 3;

Returns
Type Description
ByteString

The bytes for userAgent.

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.

string user_id = 1;

Returns
Type Description
String

The userId.

getUserIdBytes()

public ByteString getUserIdBytes()

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.

string user_id = 1;

Returns
Type Description
ByteString

The bytes for userId.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(UserInfo other)

public UserInfo.Builder mergeFrom(UserInfo other)
Parameter
Name Description
other UserInfo
Returns
Type Description
UserInfo.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public UserInfo.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UserInfo.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public UserInfo.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
UserInfo.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final UserInfo.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
UserInfo.Builder
Overrides

setDirectUserRequest(boolean value)

public UserInfo.Builder setDirectUserRequest(boolean value)

True if the request is made directly from the end user, in which case the ip_address and user_agent can be populated from the HTTP request. This flag should be set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events).

This should not be set when using the JavaScript tag in UserEventService.CollectUserEvent.

bool direct_user_request = 4;

Parameter
Name Description
value boolean

The directUserRequest to set.
Returns
Type Description
UserInfo.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public UserInfo.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
UserInfo.Builder
Overrides

setIpAddress(String value)

public UserInfo.Builder setIpAddress(String value)

The end user's IP address. This field is used to extract location information for personalization.

This field must be either an IPv4 address (e.g. "104.133.9.80") or an IPv6 address (e.g. "2001:0db8:85a3:0000:0000:8a2e:0370:7334"). Otherwise, an INVALID_ARGUMENT error is returned.

This should not be set when:

  • setting SearchRequest.user_info.
  • using the JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set.

string ip_address = 2;

Parameter
Name Description
value String

The ipAddress to set.
Returns
Type Description
UserInfo.Builder

This builder for chaining.

setIpAddressBytes(ByteString value)

public UserInfo.Builder setIpAddressBytes(ByteString value)

The end user's IP address. This field is used to extract location information for personalization.

This field must be either an IPv4 address (e.g. "104.133.9.80") or an IPv6 address (e.g. "2001:0db8:85a3:0000:0000:8a2e:0370:7334"). Otherwise, an INVALID_ARGUMENT error is returned.

This should not be set when:

  • setting SearchRequest.user_info.
  • using the JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set.

string ip_address = 2;

Parameter
Name Description
value ByteString

The bytes for ipAddress to set.
Returns
Type Description
UserInfo.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public UserInfo.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
UserInfo.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final UserInfo.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
UserInfo.Builder
Overrides

setUserAgent(String value)

public UserInfo.Builder setUserAgent(String value)

User agent as included in the HTTP header. Required for getting SearchResponse.sponsored_results.

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 direct_user_request is set.

string user_agent = 3;

Parameter
Name Description
value String

The userAgent to set.
Returns
Type Description
UserInfo.Builder

This builder for chaining.

setUserAgentBytes(ByteString value)

public UserInfo.Builder setUserAgentBytes(ByteString value)

User agent as included in the HTTP header. Required for getting SearchResponse.sponsored_results.

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 direct_user_request is set.

string user_agent = 3;

Parameter
Name Description
value ByteString

The bytes for userAgent to set.
Returns
Type Description
UserInfo.Builder

This builder for chaining.

setUserId(String value)

public UserInfo.Builder setUserId(String value)

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.

string user_id = 1;

Parameter
Name Description
value String

The userId to set.
Returns
Type Description
UserInfo.Builder

This builder for chaining.

setUserIdBytes(ByteString value)

public UserInfo.Builder setUserIdBytes(ByteString value)

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.

string user_id = 1;

Parameter
Name Description
value ByteString

The bytes for userId to set.
Returns
Type Description
UserInfo.Builder

This builder for chaining.