Package com.google.cloud.recommendationengine.v1beta1

Class UserInfo

  • All Implemented Interfaces:
    UserInfoOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class UserInfo
extends com.google.protobuf.GeneratedMessageV3
implements UserInfoOrBuilder
     Information of end users.
    Protobuf type google.cloud.recommendationengine.v1beta1.UserInfo
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  UserInfo.Builder
      Information of end users.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • 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

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

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

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

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

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

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static UserInfo parseFrom​(ByteBuffer data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static UserInfo parseFrom​(ByteBuffer data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static UserInfo parseFrom​(com.google.protobuf.ByteString data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static UserInfo parseFrom​(com.google.protobuf.ByteString data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static UserInfo parseFrom​(byte[] data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static UserInfo parseFrom​(byte[] data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static UserInfo parseFrom​(com.google.protobuf.CodedInputStream input,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws IOException
        Throws:
        IOException

      • newBuilderForType

        public UserInfo.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public UserInfo.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected UserInfo.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static UserInfo getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<UserInfo> parser()

      • getParserForType

        public com.google.protobuf.Parser<UserInfo> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public UserInfo getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder