Package com.google.cloud.discoveryengine.v1beta

Interface UserInfoOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
UserInfo, UserInfo.Builder
@Generated public interface UserInfoOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    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.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Method Details

    • getUserId

      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;
      Returns:
      The userId.

    • getUserIdBytes

      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;
      Returns:
      The bytes for userId.

    • getUserAgent

      String getUserAgent()
       User agent as included in the HTTP header.

 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.discoveryengine.v1beta.UserEventService.CollectUserEvent]
 or if
 [UserEvent.direct_user_request][google.cloud.discoveryengine.v1beta.UserEvent.direct_user_request]
 is set.
      string user_agent = 2;
      Returns:
      The userAgent.

    • getUserAgentBytes

      com.google.protobuf.ByteString getUserAgentBytes()
       User agent as included in the HTTP header.

 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.discoveryengine.v1beta.UserEventService.CollectUserEvent]
 or if
 [UserEvent.direct_user_request][google.cloud.discoveryengine.v1beta.UserEvent.direct_user_request]
 is set.
      string user_agent = 2;
      Returns:
      The bytes for userAgent.