public final class UserInfo extends GeneratedMessageV3 implements UserInfoOrBuilder
Information of end users.
Protobuf type google.cloud.recommendationengine.v1beta1.UserInfo
Static Fields
DIRECT_USER_REQUEST_FIELD_NUMBER
public static final int DIRECT_USER_REQUEST_FIELD_NUMBER
Field Value
IP_ADDRESS_FIELD_NUMBER
public static final int IP_ADDRESS_FIELD_NUMBER
Field Value
USER_AGENT_FIELD_NUMBER
public static final int USER_AGENT_FIELD_NUMBER
Field Value
USER_ID_FIELD_NUMBER
public static final int USER_ID_FIELD_NUMBER
Field Value
VISITOR_ID_FIELD_NUMBER
public static final int VISITOR_ID_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static UserInfo getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static UserInfo.Builder newBuilder()
Returns
newBuilder(UserInfo prototype)
public static UserInfo.Builder newBuilder(UserInfo prototype)
Parameter
Returns
public static UserInfo parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static UserInfo parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static UserInfo parseFrom(byte[] data)
Parameter
| Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static UserInfo parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static UserInfo parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static UserInfo parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static UserInfo parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static UserInfo parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static UserInfo parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static UserInfo parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static UserInfo parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static UserInfo parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<UserInfo> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstanceForType()
public UserInfo getDefaultInstanceForType()
Returns
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];
| 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];
| 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];
getParserForType()
public Parser<UserInfo> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
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];
| 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];
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];
| 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];
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];
| 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];
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public UserInfo.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected UserInfo.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public UserInfo.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
