<?php
/*
 * Copyright 2014 Google Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

namespace Google\Service\CloudRetail;

class GoogleCloudRetailV2UserInfo extends \Google\Model
{
  /**
   * True if the request is made directly from the end user, in which case the
   * ip_address and 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.
   *
   * @var bool
   */
  public $directUserRequest;
  /**
   * 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. * using the JavaScript tag in
   * UserEventService.CollectUserEvent or if direct_user_request is set.
   *
   * @var string
   */
  public $ipAddress;
  /**
   * 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 or if direct_user_request is set.
   *
   * @var string
   */
  public $userAgent;
  /**
   * 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.
   *
   * @var string
   */
  public $userId;

  /**
   * True if the request is made directly from the end user, in which case the
   * ip_address and 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.
   *
   * @param bool $directUserRequest
   */
  public function setDirectUserRequest($directUserRequest)
  {
    $this->directUserRequest = $directUserRequest;
  }
  /**
   * @return bool
   */
  public function getDirectUserRequest()
  {
    return $this->directUserRequest;
  }
  /**
   * 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. * using the JavaScript tag in
   * UserEventService.CollectUserEvent or if direct_user_request is set.
   *
   * @param string $ipAddress
   */
  public function setIpAddress($ipAddress)
  {
    $this->ipAddress = $ipAddress;
  }
  /**
   * @return string
   */
  public function getIpAddress()
  {
    return $this->ipAddress;
  }
  /**
   * 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 or if direct_user_request is set.
   *
   * @param string $userAgent
   */
  public function setUserAgent($userAgent)
  {
    $this->userAgent = $userAgent;
  }
  /**
   * @return string
   */
  public function getUserAgent()
  {
    return $this->userAgent;
  }
  /**
   * 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.
   *
   * @param string $userId
   */
  public function setUserId($userId)
  {
    $this->userId = $userId;
  }
  /**
   * @return string
   */
  public function getUserId()
  {
    return $this->userId;
  }
}

// Adding a class alias for backwards compatibility with the previous class name.
class_alias(GoogleCloudRetailV2UserInfo::class, 'Google_Service_CloudRetail_GoogleCloudRetailV2UserInfo');
