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.GeneratedMessage.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.GeneratedMessage.Builder<UserInfo.Builder> implements UserInfoOrBuilder
 Information of end users.
Protobuf type google.cloud.recommendationengine.v1beta1.UserInfo

  • Method Details

    • 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

    • 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.