com.google.cloud.discoveryengine.v1

Class UserInfo.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessage.Builder<UserInfo.Builder>

com.google.cloud.discoveryengine.v1.UserInfo.Builder

All Implemented Interfaces:

UserInfoOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

UserInfo

public static final class UserInfo.Builder
extends com.google.protobuf.GeneratedMessage.Builder<UserInfo.Builder>
implements UserInfoOrBuilder

 Information of an end user.
 

Protobuf type google.cloud.discoveryengine.v1.UserInfo

Method Summary

Modifier and Type	Method and Description
UserInfo	build()
UserInfo	buildPartial()
UserInfo.Builder	clear()
UserInfo.Builder	clearTimeZone() Optional.
UserInfo.Builder	clearUserAgent() User agent as included in the HTTP header.
UserInfo.Builder	clearUserId() Highly recommended for logged-in users.
UserInfo	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getTimeZone() Optional.
com.google.protobuf.ByteString	getTimeZoneBytes() Optional.
String	getUserAgent() User agent as included in the HTTP header.
com.google.protobuf.ByteString	getUserAgentBytes() User agent as included in the HTTP header.
String	getUserId() Highly recommended for logged-in users.
com.google.protobuf.ByteString	getUserIdBytes() Highly recommended for logged-in users.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
UserInfo.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
UserInfo.Builder	mergeFrom(com.google.protobuf.Message other)
UserInfo.Builder	mergeFrom(UserInfo other)
UserInfo.Builder	setTimeZone(String value) Optional.
UserInfo.Builder	setTimeZoneBytes(com.google.protobuf.ByteString value) Optional.
UserInfo.Builder	setUserAgent(String value) User agent as included in the HTTP header.
UserInfo.Builder	setUserAgentBytes(com.google.protobuf.ByteString value) User agent as included in the HTTP header.
UserInfo.Builder	setUserId(String value) Highly recommended for logged-in users.
UserInfo.Builder	setUserIdBytes(com.google.protobuf.ByteString value) Highly recommended for logged-in users.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<UserInfo.Builder>

clear

public UserInfo.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessage.Builder<UserInfo.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<UserInfo.Builder>

getDefaultInstanceForType

public UserInfo getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public UserInfo build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public UserInfo buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom

public UserInfo.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<UserInfo.Builder>

mergeFrom

public UserInfo.Builder mergeFrom(UserInfo other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<UserInfo.Builder>

mergeFrom

public UserInfo.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<UserInfo.Builder>

Throws:

IOException

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;

Specified by:

getUserId in interface UserInfoOrBuilder

Returns:

The userId.

getUserIdBytes

public com.google.protobuf.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;

Specified by:

getUserIdBytes in interface UserInfoOrBuilder

Returns:

The bytes for userId.

setUserId

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;

Parameters:

value - The userId to set.

Returns:

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:

This builder for chaining.

setUserIdBytes

public UserInfo.Builder setUserIdBytes(com.google.protobuf.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;

Parameters:

value - The bytes for userId to set.

Returns:

This builder for chaining.

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][google.cloud.discoveryengine.v1.UserEventService.CollectUserEvent]
 or if
 [UserEvent.direct_user_request][google.cloud.discoveryengine.v1.UserEvent.direct_user_request]
 is set.
 

string user_agent = 2;

Specified by:

getUserAgent in interface UserInfoOrBuilder

Returns:

The userAgent.

getUserAgentBytes

public com.google.protobuf.ByteString getUserAgentBytes()

 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][google.cloud.discoveryengine.v1.UserEventService.CollectUserEvent]
 or if
 [UserEvent.direct_user_request][google.cloud.discoveryengine.v1.UserEvent.direct_user_request]
 is set.
 

string user_agent = 2;

Specified by:

getUserAgentBytes in interface UserInfoOrBuilder

Returns:

The bytes for userAgent.

setUserAgent

public UserInfo.Builder setUserAgent(String value)

 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][google.cloud.discoveryengine.v1.UserEventService.CollectUserEvent]
 or if
 [UserEvent.direct_user_request][google.cloud.discoveryengine.v1.UserEvent.direct_user_request]
 is set.
 

string user_agent = 2;

Parameters:

value - The userAgent to set.

Returns:

This builder for chaining.

clearUserAgent

public UserInfo.Builder clearUserAgent()

 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][google.cloud.discoveryengine.v1.UserEventService.CollectUserEvent]
 or if
 [UserEvent.direct_user_request][google.cloud.discoveryengine.v1.UserEvent.direct_user_request]
 is set.
 

string user_agent = 2;

Returns:

This builder for chaining.

setUserAgentBytes

public UserInfo.Builder setUserAgentBytes(com.google.protobuf.ByteString value)

 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][google.cloud.discoveryengine.v1.UserEventService.CollectUserEvent]
 or if
 [UserEvent.direct_user_request][google.cloud.discoveryengine.v1.UserEvent.direct_user_request]
 is set.
 

string user_agent = 2;

Parameters:

value - The bytes for userAgent to set.

Returns:

This builder for chaining.

getTimeZone

public String getTimeZone()

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

string time_zone = 3 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getTimeZone in interface UserInfoOrBuilder

Returns:

The timeZone.

getTimeZoneBytes

public com.google.protobuf.ByteString getTimeZoneBytes()

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

string time_zone = 3 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getTimeZoneBytes in interface UserInfoOrBuilder

Returns:

The bytes for timeZone.

setTimeZone

public UserInfo.Builder setTimeZone(String value)

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

string time_zone = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

value - The timeZone to set.

Returns:

This builder for chaining.

clearTimeZone

public UserInfo.Builder clearTimeZone()

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

string time_zone = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns:

This builder for chaining.

setTimeZoneBytes

public UserInfo.Builder setTimeZoneBytes(com.google.protobuf.ByteString value)

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

string time_zone = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

value - The bytes for timeZone to set.

Returns:

This builder for chaining.