Class UserInfo (0.58.0)

public final class UserInfo extends GeneratedMessageV3 implements UserInfoOrBuilder

Information of end users.

Protobuf type google.cloud.recommendationengine.v1beta1.UserInfo

Implements

UserInfoOrBuilder

Static Fields

DIRECT_USER_REQUEST_FIELD_NUMBER

public static final int DIRECT_USER_REQUEST_FIELD_NUMBER
Field Value
Type Description
int

IP_ADDRESS_FIELD_NUMBER

public static final int IP_ADDRESS_FIELD_NUMBER
Field Value
Type Description
int

USER_AGENT_FIELD_NUMBER

public static final int USER_AGENT_FIELD_NUMBER
Field Value
Type Description
int

USER_ID_FIELD_NUMBER

public static final int USER_ID_FIELD_NUMBER
Field Value
Type Description
int

VISITOR_ID_FIELD_NUMBER

public static final int VISITOR_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static UserInfo getDefaultInstance()
Returns
Type Description
UserInfo

getDescriptor()

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

newBuilder()

public static UserInfo.Builder newBuilder()
Returns
Type Description
UserInfo.Builder

newBuilder(UserInfo prototype)

public static UserInfo.Builder newBuilder(UserInfo prototype)
Parameter
Name Description
prototype UserInfo
Returns
Type Description
UserInfo.Builder

parseDelimitedFrom(InputStream input)

public static UserInfo parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
UserInfo
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UserInfo parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UserInfo
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static UserInfo parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
UserInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static UserInfo parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UserInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static UserInfo parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
UserInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static UserInfo parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UserInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static UserInfo parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
UserInfo
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static UserInfo parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UserInfo
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static UserInfo parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
UserInfo
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UserInfo parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UserInfo
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static UserInfo parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
UserInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static UserInfo parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UserInfo
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<UserInfo> parser()
Returns
Type Description
Parser<UserInfo>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public UserInfo getDefaultInstanceForType()
Returns
Type Description
UserInfo

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];

Returns
Type Description
boolean

The directUserRequest.

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];

Returns
Type Description
String

The ipAddress.

getIpAddressBytes()

public 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];

Returns
Type Description
ByteString

The bytes for ipAddress.

getParserForType()

public Parser<UserInfo> getParserForType()
Returns
Type Description
Parser<UserInfo>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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];

Returns
Type Description
String

The userAgent.

getUserAgentBytes()

public 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];

Returns
Type Description
ByteString

The bytes for userAgent.

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];

Returns
Type Description
String

The userId.

getUserIdBytes()

public 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];

Returns
Type Description
ByteString

The bytes for userId.

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];

Returns
Type Description
String

The visitorId.

getVisitorIdBytes()

public 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];

Returns
Type Description
ByteString

The bytes for visitorId.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public UserInfo.Builder newBuilderForType()
Returns
Type Description
UserInfo.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected UserInfo.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
UserInfo.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public UserInfo.Builder toBuilder()
Returns
Type Description
UserInfo.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException