Package com.google.cloud.recommendationengine.v1beta1

Class UserInfo.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

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

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

com.google.cloud.recommendationengine.v1beta1.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.GeneratedMessageV3.Builder<UserInfo.Builder>
implements UserInfoOrBuilder

 Information of end users.
 

Protobuf type google.cloud.recommendationengine.v1beta1.UserInfo

Method Summary

Modifier and Type	Method	Description
UserInfo.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
UserInfo	build()
UserInfo	buildPartial()
UserInfo.Builder	clear()
UserInfo.Builder	clearDirectUserRequest()	Optional.
UserInfo.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
UserInfo.Builder	clearIpAddress()	Optional.
UserInfo.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
UserInfo.Builder	clearUserAgent()	Optional.
UserInfo.Builder	clearUserId()	Optional.
UserInfo.Builder	clearVisitorId()	Required.
UserInfo.Builder	clone()
UserInfo	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
boolean	getDirectUserRequest()	Optional.
String	getIpAddress()	Optional.
com.google.protobuf.ByteString	getIpAddressBytes()	Optional.
String	getUserAgent()	Optional.
com.google.protobuf.ByteString	getUserAgentBytes()	Optional.
String	getUserId()	Optional.
com.google.protobuf.ByteString	getUserIdBytes()	Optional.
String	getVisitorId()	Required.
com.google.protobuf.ByteString	getVisitorIdBytes()	Required.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
UserInfo.Builder	mergeFrom(UserInfo other)
UserInfo.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
UserInfo.Builder	mergeFrom(com.google.protobuf.Message other)
UserInfo.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
UserInfo.Builder	setDirectUserRequest(boolean value)	Optional.
UserInfo.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
UserInfo.Builder	setIpAddress(String value)	Optional.
UserInfo.Builder	setIpAddressBytes(com.google.protobuf.ByteString value)	Optional.
UserInfo.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
UserInfo.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
UserInfo.Builder	setUserAgent(String value)	Optional.
UserInfo.Builder	setUserAgentBytes(com.google.protobuf.ByteString value)	Optional.
UserInfo.Builder	setUserId(String value)	Optional.
UserInfo.Builder	setUserIdBytes(com.google.protobuf.ByteString value)	Optional.
UserInfo.Builder	setVisitorId(String value)	Required.
UserInfo.Builder	setVisitorIdBytes(com.google.protobuf.ByteString value)	Required.

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

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, 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.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

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

mergeFrom

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Method Detail

getDescriptor

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

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.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.GeneratedMessageV3.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.GeneratedMessageV3.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

clone

public UserInfo.Builder clone()

Specified by:

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

Specified by:

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

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<UserInfo.Builder>

setField

public UserInfo.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                 Object value)

Specified by:

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

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<UserInfo.Builder>

clearField

public UserInfo.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

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

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<UserInfo.Builder>

clearOneof

public UserInfo.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

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

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<UserInfo.Builder>

setRepeatedField

public UserInfo.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                         int index,
                                         Object value)

Specified by:

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

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<UserInfo.Builder>

addRepeatedField

public UserInfo.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                         Object value)

Specified by:

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

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<UserInfo.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.GeneratedMessageV3.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

getVisitorId

public String getVisitorId()

 Required. A unique identifier for tracking visitors with a length limit of
 128 bytes.

 For example, this could be implemented with a http cookie, which should be
 able to uniquely identify a visitor on a single device. This unique
 identifier should not change if the visitor log in/out of the website.
 Maximum length 128 bytes. Cannot be empty.
 

string visitor_id = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getVisitorId in interface UserInfoOrBuilder

Returns:

The visitorId.

getVisitorIdBytes

public com.google.protobuf.ByteString getVisitorIdBytes()

 Required. A unique identifier for tracking visitors with a length limit of
 128 bytes.

 For example, this could be implemented with a http cookie, which should be
 able to uniquely identify a visitor on a single device. This unique
 identifier should not change if the visitor log in/out of the website.
 Maximum length 128 bytes. Cannot be empty.
 

string visitor_id = 1 [(.google.api.field_behavior) = REQUIRED];

Specified by:

getVisitorIdBytes in interface UserInfoOrBuilder

Returns:

The bytes for visitorId.

setVisitorId

public UserInfo.Builder setVisitorId(String value)

 Required. A unique identifier for tracking visitors with a length limit of
 128 bytes.

 For example, this could be implemented with a http cookie, which should be
 able to uniquely identify a visitor on a single device. This unique
 identifier should not change if the visitor log in/out of the website.
 Maximum length 128 bytes. Cannot be empty.
 

string visitor_id = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters:

value - The visitorId to set.

Returns:

This builder for chaining.

clearVisitorId

public UserInfo.Builder clearVisitorId()

 Required. A unique identifier for tracking visitors with a length limit of
 128 bytes.

 For example, this could be implemented with a http cookie, which should be
 able to uniquely identify a visitor on a single device. This unique
 identifier should not change if the visitor log in/out of the website.
 Maximum length 128 bytes. Cannot be empty.
 

string visitor_id = 1 [(.google.api.field_behavior) = REQUIRED];

Returns:

This builder for chaining.

setVisitorIdBytes

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

 Required. A unique identifier for tracking visitors with a length limit of
 128 bytes.

 For example, this could be implemented with a http cookie, which should be
 able to uniquely identify a visitor on a single device. This unique
 identifier should not change if the visitor log in/out of the website.
 Maximum length 128 bytes. Cannot be empty.
 

string visitor_id = 1 [(.google.api.field_behavior) = REQUIRED];

Parameters:

value - The bytes for visitorId to set.

Returns:

This builder for chaining.

getUserId

public String getUserId()

 Optional. Unique identifier for logged-in user with a length limit of 128
 bytes. Required only for logged-in users.
 

string user_id = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getUserId in interface UserInfoOrBuilder

Returns:

The userId.

getUserIdBytes

public com.google.protobuf.ByteString getUserIdBytes()

 Optional. Unique identifier for logged-in user with a length limit of 128
 bytes. Required only for logged-in users.
 

string user_id = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getUserIdBytes in interface UserInfoOrBuilder

Returns:

The bytes for userId.

setUserId

public UserInfo.Builder setUserId(String value)

 Optional. Unique identifier for logged-in user with a length limit of 128
 bytes. Required only for logged-in users.
 

string user_id = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

value - The userId to set.

Returns:

This builder for chaining.

clearUserId

public UserInfo.Builder clearUserId()

 Optional. Unique identifier for logged-in user with a length limit of 128
 bytes. Required only for logged-in users.
 

string user_id = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns:

This builder for chaining.

setUserIdBytes

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

 Optional. Unique identifier for logged-in user with a length limit of 128
 bytes. Required only for logged-in users.
 

string user_id = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

value - The bytes for userId to set.

Returns:

This builder for chaining.

getIpAddress

public String getIpAddress()

 Optional. IP address of the user. This could be either IPv4 (e.g. 104.133.9.80) or
 IPv6 (e.g. 2001:0db8:85a3:0000:0000:8a2e:0370:7334). This should *not* be
 set when using the javascript pixel or if `direct_user_request` is set.
 Used to extract location information for personalization.
 

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

Specified by:

getIpAddress in interface UserInfoOrBuilder

Returns:

The ipAddress.

getIpAddressBytes

public com.google.protobuf.ByteString getIpAddressBytes()

 Optional. IP address of the user. This could be either IPv4 (e.g. 104.133.9.80) or
 IPv6 (e.g. 2001:0db8:85a3:0000:0000:8a2e:0370:7334). This should *not* be
 set when using the javascript pixel or if `direct_user_request` is set.
 Used to extract location information for personalization.
 

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

Specified by:

getIpAddressBytes in interface UserInfoOrBuilder

Returns:

The bytes for ipAddress.

setIpAddress

public UserInfo.Builder setIpAddress(String value)

 Optional. IP address of the user. This could be either IPv4 (e.g. 104.133.9.80) or
 IPv6 (e.g. 2001:0db8:85a3:0000:0000:8a2e:0370:7334). This should *not* be
 set when using the javascript pixel or if `direct_user_request` is set.
 Used to extract location information for personalization.
 

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

Parameters:

value - The ipAddress to set.

Returns:

This builder for chaining.

clearIpAddress

public UserInfo.Builder clearIpAddress()

 Optional. IP address of the user. This could be either IPv4 (e.g. 104.133.9.80) or
 IPv6 (e.g. 2001:0db8:85a3:0000:0000:8a2e:0370:7334). This should *not* be
 set when using the javascript pixel or if `direct_user_request` is set.
 Used to extract location information for personalization.
 

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

Returns:

This builder for chaining.

setIpAddressBytes

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

 Optional. IP address of the user. This could be either IPv4 (e.g. 104.133.9.80) or
 IPv6 (e.g. 2001:0db8:85a3:0000:0000:8a2e:0370:7334). This should *not* be
 set when using the javascript pixel or if `direct_user_request` is set.
 Used to extract location information for personalization.
 

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

Parameters:

value - The bytes for ipAddress to set.

Returns:

This builder for chaining.

getUserAgent

public String getUserAgent()

 Optional. User agent as included in the HTTP header. UTF-8 encoded string
 with a length limit of 1 KiB.

 This should *not* be set when using the JavaScript pixel or if
 `directUserRequest` is set.
 

string user_agent = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getUserAgent in interface UserInfoOrBuilder

Returns:

The userAgent.

getUserAgentBytes

public com.google.protobuf.ByteString getUserAgentBytes()

 Optional. User agent as included in the HTTP header. UTF-8 encoded string
 with a length limit of 1 KiB.

 This should *not* be set when using the JavaScript pixel or if
 `directUserRequest` is set.
 

string user_agent = 4 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getUserAgentBytes in interface UserInfoOrBuilder

Returns:

The bytes for userAgent.

setUserAgent

public UserInfo.Builder setUserAgent(String value)

 Optional. User agent as included in the HTTP header. UTF-8 encoded string
 with a length limit of 1 KiB.

 This should *not* be set when using the JavaScript pixel or if
 `directUserRequest` is set.
 

string user_agent = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

value - The userAgent to set.

Returns:

This builder for chaining.

clearUserAgent

public UserInfo.Builder clearUserAgent()

 Optional. User agent as included in the HTTP header. UTF-8 encoded string
 with a length limit of 1 KiB.

 This should *not* be set when using the JavaScript pixel or if
 `directUserRequest` is set.
 

string user_agent = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns:

This builder for chaining.

setUserAgentBytes

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

 Optional. User agent as included in the HTTP header. UTF-8 encoded string
 with a length limit of 1 KiB.

 This should *not* be set when using the JavaScript pixel or if
 `directUserRequest` is set.
 

string user_agent = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

value - The bytes for userAgent to set.

Returns:

This builder for chaining.

getDirectUserRequest

public boolean getDirectUserRequest()

 Optional. Indicates if the request is made directly from the end user
 in which case the user_agent and ip_address fields can be populated
 from the HTTP request. This should *not* be set when using the javascript
 pixel. 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).
 

bool direct_user_request = 5 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getDirectUserRequest in interface UserInfoOrBuilder

Returns:

The directUserRequest.

setDirectUserRequest

public UserInfo.Builder setDirectUserRequest(boolean value)

 Optional. Indicates if the request is made directly from the end user
 in which case the user_agent and ip_address fields can be populated
 from the HTTP request. This should *not* be set when using the javascript
 pixel. 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).
 

bool direct_user_request = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters:

value - The directUserRequest to set.

Returns:

This builder for chaining.

clearDirectUserRequest

public UserInfo.Builder clearDirectUserRequest()

 Optional. Indicates if the request is made directly from the end user
 in which case the user_agent and ip_address fields can be populated
 from the HTTP request. This should *not* be set when using the javascript
 pixel. 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).
 

bool direct_user_request = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns:

This builder for chaining.

setUnknownFields

public final UserInfo.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

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

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<UserInfo.Builder>

mergeUnknownFields

public final UserInfo.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

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

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<UserInfo.Builder>