Package com.google.cloud.retail.v2beta

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 an end user.
    Protobuf type google.cloud.retail.v2beta.UserInfo
    See Also:
    Serialized Form

    • Nested Class Summary

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

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

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(Object obj)  
      static UserInfo getDefaultInstance()  
      UserInfo getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      boolean getDirectUserRequest()
      True if the request is made directly from the end user, in which case the [ip_address][google.cloud.retail.v2beta.UserInfo.ip_address] and [user_agent][google.cloud.retail.v2beta.UserInfo.user_agent] can be populated from the HTTP request.
      String getIpAddress()
      The end user's IP address.
      com.google.protobuf.ByteString getIpAddressBytes()
      The end user's IP address.
      com.google.protobuf.Parser<UserInfo> getParserForType()  
      int getSerializedSize()  
      String getUserAgent()
      User agent as included in the HTTP header.
      com.google.protobuf.ByteString getUserAgentBytes()
      User agent as included in the HTTP header.
      String getUserId()
      Highly recommended for logged-in users.
      com.google.protobuf.ByteString getUserIdBytes()
      Highly recommended for logged-in users.
      int hashCode()  
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static UserInfo.Builder newBuilder()  
      static UserInfo.Builder newBuilder​(UserInfo prototype)  
      UserInfo.Builder newBuilderForType()  
      protected UserInfo.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static UserInfo parseDelimitedFrom​(InputStream input)  
      static UserInfo parseDelimitedFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static UserInfo parseFrom​(byte[] data)  
      static UserInfo parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static UserInfo parseFrom​(com.google.protobuf.ByteString data)  
      static UserInfo parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static UserInfo parseFrom​(com.google.protobuf.CodedInputStream input)  
      static UserInfo parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static UserInfo parseFrom​(InputStream input)  
      static UserInfo parseFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static UserInfo parseFrom​(ByteBuffer data)  
      static UserInfo parseFrom​(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<UserInfo> parser()  
      UserInfo.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Field Detail

      • IP_ADDRESS_FIELD_NUMBER

        public static final int IP_ADDRESS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • USER_AGENT_FIELD_NUMBER

        public static final int USER_AGENT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DIRECT_USER_REQUEST_FIELD_NUMBER

        public static final int DIRECT_USER_REQUEST_FIELD_NUMBER
        See Also:
        Constant Field Values

    • 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

      • getUserId

        public String getUserId()
         Highly recommended for logged-in users. Unique identifier for logged-in
 user, such as a user name. Don't set for anonymous users.

 Always use a hashed value for this ID.

 Don't set the field to the same fixed ID for different users. This mixes
 the event history of those users together, which results in degraded
 model quality.

 The field must be a UTF-8 encoded string with a length limit of 128
 characters. Otherwise, an INVALID_ARGUMENT error is returned.
        string user_id = 1;
        Specified by:
        getUserId in interface UserInfoOrBuilder
        Returns:
        The userId.

      • getUserIdBytes

        public com.google.protobuf.ByteString getUserIdBytes()
         Highly recommended for logged-in users. Unique identifier for logged-in
 user, such as a user name. Don't set for anonymous users.

 Always use a hashed value for this ID.

 Don't set the field to the same fixed ID for different users. This mixes
 the event history of those users together, which results in degraded
 model quality.

 The field must be a UTF-8 encoded string with a length limit of 128
 characters. Otherwise, an INVALID_ARGUMENT error is returned.
        string user_id = 1;
        Specified by:
        getUserIdBytes in interface UserInfoOrBuilder
        Returns:
        The bytes for userId.

      • getIpAddress

        public String getIpAddress()
         The end user's IP address. This field is used to extract location
 information for personalization.

 This field must be either an IPv4 address (e.g. "104.133.9.80") or an IPv6
 address (e.g. "2001:0db8:85a3:0000:0000:8a2e:0370:7334"). Otherwise, an
 INVALID_ARGUMENT error is returned.

 This should not be set when:

 * setting
 [SearchRequest.user_info][google.cloud.retail.v2beta.SearchRequest.user_info].
 * using the JavaScript tag in
 [UserEventService.CollectUserEvent][google.cloud.retail.v2beta.UserEventService.CollectUserEvent]
 or if
 [direct_user_request][google.cloud.retail.v2beta.UserInfo.direct_user_request]
 is set.
        string ip_address = 2;
        Specified by:
        getIpAddress in interface UserInfoOrBuilder
        Returns:
        The ipAddress.

      • getIpAddressBytes

        public com.google.protobuf.ByteString getIpAddressBytes()
         The end user's IP address. This field is used to extract location
 information for personalization.

 This field must be either an IPv4 address (e.g. "104.133.9.80") or an IPv6
 address (e.g. "2001:0db8:85a3:0000:0000:8a2e:0370:7334"). Otherwise, an
 INVALID_ARGUMENT error is returned.

 This should not be set when:

 * setting
 [SearchRequest.user_info][google.cloud.retail.v2beta.SearchRequest.user_info].
 * using the JavaScript tag in
 [UserEventService.CollectUserEvent][google.cloud.retail.v2beta.UserEventService.CollectUserEvent]
 or if
 [direct_user_request][google.cloud.retail.v2beta.UserInfo.direct_user_request]
 is set.
        string ip_address = 2;
        Specified by:
        getIpAddressBytes in interface UserInfoOrBuilder
        Returns:
        The bytes for ipAddress.

      • getUserAgent

        public String getUserAgent()
         User agent as included in the HTTP header. Required for getting
 [SearchResponse.sponsored_results][google.cloud.retail.v2beta.SearchResponse.sponsored_results].

 The field must be a UTF-8 encoded string with a length limit of 1,000
 characters. Otherwise, an INVALID_ARGUMENT error is returned.

 This should not be set when using the client side event reporting with
 GTM or JavaScript tag in
 [UserEventService.CollectUserEvent][google.cloud.retail.v2beta.UserEventService.CollectUserEvent]
 or if
 [direct_user_request][google.cloud.retail.v2beta.UserInfo.direct_user_request]
 is set.
        string user_agent = 3;
        Specified by:
        getUserAgent in interface UserInfoOrBuilder
        Returns:
        The userAgent.

      • getUserAgentBytes

        public com.google.protobuf.ByteString getUserAgentBytes()
         User agent as included in the HTTP header. Required for getting
 [SearchResponse.sponsored_results][google.cloud.retail.v2beta.SearchResponse.sponsored_results].

 The field must be a UTF-8 encoded string with a length limit of 1,000
 characters. Otherwise, an INVALID_ARGUMENT error is returned.

 This should not be set when using the client side event reporting with
 GTM or JavaScript tag in
 [UserEventService.CollectUserEvent][google.cloud.retail.v2beta.UserEventService.CollectUserEvent]
 or if
 [direct_user_request][google.cloud.retail.v2beta.UserInfo.direct_user_request]
 is set.
        string user_agent = 3;
        Specified by:
        getUserAgentBytes in interface UserInfoOrBuilder
        Returns:
        The bytes for userAgent.

      • getDirectUserRequest

        public boolean getDirectUserRequest()
         True if the request is made directly from the end user, in which case the
 [ip_address][google.cloud.retail.v2beta.UserInfo.ip_address] and
 [user_agent][google.cloud.retail.v2beta.UserInfo.user_agent] can be
 populated from the HTTP request. 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).

 This should not be set when using the JavaScript tag in
 [UserEventService.CollectUserEvent][google.cloud.retail.v2beta.UserEventService.CollectUserEvent].
        bool direct_user_request = 4;
        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