- 0.60.0 (latest)
- 0.59.0
- 0.58.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.34.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.4
- 0.8.10
public static final class UserInfo.Builder extends GeneratedMessageV3.Builder<UserInfo.Builder> implements UserInfoOrBuilderInformation of end users.
Protobuf type google.cloud.recommendationengine.v1beta1.UserInfo
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > UserInfo.BuilderImplements
UserInfoOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public UserInfo.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
UserInfo.Builder | |
build()
public UserInfo build()| Returns | |
|---|---|
| Type | Description |
UserInfo | |
buildPartial()
public UserInfo buildPartial()| Returns | |
|---|---|
| Type | Description |
UserInfo | |
clear()
public UserInfo.Builder clear()| Returns | |
|---|---|
| Type | Description |
UserInfo.Builder | |
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 | |
|---|---|
| Type | Description |
UserInfo.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public UserInfo.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field | FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
UserInfo.Builder | |
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 | |
|---|---|
| Type | Description |
UserInfo.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public UserInfo.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof | OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
UserInfo.Builder | |
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 | |
|---|---|
| Type | Description |
UserInfo.Builder | 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 | |
|---|---|
| Type | Description |
UserInfo.Builder | 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 | |
|---|---|
| Type | Description |
UserInfo.Builder | This builder for chaining. |
clone()
public UserInfo.Builder clone()| Returns | |
|---|---|
| Type | Description |
UserInfo.Builder | |
getDefaultInstanceForType()
public UserInfo getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
UserInfo | |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
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. |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
mergeFrom(UserInfo other)
public UserInfo.Builder mergeFrom(UserInfo other)| Parameter | |
|---|---|
| Name | Description |
other | UserInfo |
| Returns | |
|---|---|
| Type | Description |
UserInfo.Builder | |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public UserInfo.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
UserInfo.Builder | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
mergeFrom(Message other)
public UserInfo.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other | Message |
| Returns | |
|---|---|
| Type | Description |
UserInfo.Builder | |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final UserInfo.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
UserInfo.Builder | |
setDirectUserRequest(boolean value)
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];
| Parameter | |
|---|---|
| Name | Description |
value | booleanThe directUserRequest to set. |
| Returns | |
|---|---|
| Type | Description |
UserInfo.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public UserInfo.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
value | Object |
| Returns | |
|---|---|
| Type | Description |
UserInfo.Builder | |
setIpAddress(String value)
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];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe ipAddress to set. |
| Returns | |
|---|---|
| Type | Description |
UserInfo.Builder | This builder for chaining. |
setIpAddressBytes(ByteString value)
public UserInfo.Builder setIpAddressBytes(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];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for ipAddress to set. |
| Returns | |
|---|---|
| Type | Description |
UserInfo.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public UserInfo.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field | FieldDescriptor |
index | int |
value | Object |
| Returns | |
|---|---|
| Type | Description |
UserInfo.Builder | |
setUnknownFields(UnknownFieldSet unknownFields)
public final UserInfo.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields | UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
UserInfo.Builder | |
setUserAgent(String value)
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];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe userAgent to set. |
| Returns | |
|---|---|
| Type | Description |
UserInfo.Builder | This builder for chaining. |
setUserAgentBytes(ByteString value)
public UserInfo.Builder setUserAgentBytes(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];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for userAgent to set. |
| Returns | |
|---|---|
| Type | Description |
UserInfo.Builder | This builder for chaining. |
setUserId(String value)
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];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe userId to set. |
| Returns | |
|---|---|
| Type | Description |
UserInfo.Builder | This builder for chaining. |
setUserIdBytes(ByteString value)
public UserInfo.Builder setUserIdBytes(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];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for userId to set. |
| Returns | |
|---|---|
| Type | Description |
UserInfo.Builder | This builder for chaining. |
setVisitorId(String value)
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];
| Parameter | |
|---|---|
| Name | Description |
value | StringThe visitorId to set. |
| Returns | |
|---|---|
| Type | Description |
UserInfo.Builder | This builder for chaining. |
setVisitorIdBytes(ByteString value)
public UserInfo.Builder setVisitorIdBytes(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];
| Parameter | |
|---|---|
| Name | Description |
value | ByteStringThe bytes for visitorId to set. |
| Returns | |
|---|---|
| Type | Description |
UserInfo.Builder | This builder for chaining. |