public static final class UserInfo.Builder extends GeneratedMessageV3.Builder<UserInfo.Builder> implements UserInfoOrBuilder
Information of an end user.
Protobuf type google.cloud.discoveryengine.v1beta.UserInfo
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public UserInfo.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
Returns
buildPartial()
public UserInfo buildPartial()
Returns
clear()
public UserInfo.Builder clear()
Returns
Overrides
clearField(Descriptors.FieldDescriptor field)
public UserInfo.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Returns
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public UserInfo.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
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 = 2;
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;
clone()
public UserInfo.Builder clone()
Returns
Overrides
getDefaultInstanceForType()
public UserInfo getDefaultInstanceForType()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
Overrides
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 = 2;
| 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 = 2;
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;
| 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;
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeFrom(UserInfo other)
public UserInfo.Builder mergeFrom(UserInfo other)
Parameter
Returns
public UserInfo.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public UserInfo.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final UserInfo.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public UserInfo.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public UserInfo.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final UserInfo.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
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 = 2;
| Name | Description |
| value | String
The userAgent to set.
|
Returns
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 = 2;
| Name | Description |
| value | ByteString
The bytes for userAgent to set.
|
Returns
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;
| Name | Description |
| value | String
The userId to set.
|
Returns
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;
| Name | Description |
| value | ByteString
The bytes for userId to set.
|
Returns
