/*
 * Copyright 2020 Google LLC
 *
 * 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
 *
 *     https://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.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/cloud/recommendationengine/v1beta1/user_event.proto

package com.google.cloud.recommendationengine.v1beta1;

public interface EventDetailOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.recommendationengine.v1beta1.EventDetail)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   * <pre>
   * Optional. Complete url (window.location.href) of the user's current page.
   * When using the JavaScript pixel, this value is filled in automatically.
   * Maximum length 5KB.
   * </pre>
   *
   * <code>string uri = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
   *
   * @return The uri.
   */
  java.lang.String getUri();
  /**
   *
   *
   * <pre>
   * Optional. Complete url (window.location.href) of the user's current page.
   * When using the JavaScript pixel, this value is filled in automatically.
   * Maximum length 5KB.
   * </pre>
   *
   * <code>string uri = 1 [(.google.api.field_behavior) = OPTIONAL];</code>
   *
   * @return The bytes for uri.
   */
  com.google.protobuf.ByteString getUriBytes();

  /**
   *
   *
   * <pre>
   * Optional. The referrer url of the current page. When using
   * the JavaScript pixel, this value is filled in automatically.
   * </pre>
   *
   * <code>string referrer_uri = 6 [(.google.api.field_behavior) = OPTIONAL];</code>
   *
   * @return The referrerUri.
   */
  java.lang.String getReferrerUri();
  /**
   *
   *
   * <pre>
   * Optional. The referrer url of the current page. When using
   * the JavaScript pixel, this value is filled in automatically.
   * </pre>
   *
   * <code>string referrer_uri = 6 [(.google.api.field_behavior) = OPTIONAL];</code>
   *
   * @return The bytes for referrerUri.
   */
  com.google.protobuf.ByteString getReferrerUriBytes();

  /**
   *
   *
   * <pre>
   * Optional. A unique id of a web page view.
   * This should be kept the same for all user events triggered from the same
   * pageview. For example, an item detail page view could trigger multiple
   * events as the user is browsing the page.
   * The `pageViewId` property should be kept the same for all these events so
   * that they can be grouped together properly. This `pageViewId` will be
   * automatically generated if using the JavaScript pixel.
   * </pre>
   *
   * <code>string page_view_id = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
   *
   * @return The pageViewId.
   */
  java.lang.String getPageViewId();
  /**
   *
   *
   * <pre>
   * Optional. A unique id of a web page view.
   * This should be kept the same for all user events triggered from the same
   * pageview. For example, an item detail page view could trigger multiple
   * events as the user is browsing the page.
   * The `pageViewId` property should be kept the same for all these events so
   * that they can be grouped together properly. This `pageViewId` will be
   * automatically generated if using the JavaScript pixel.
   * </pre>
   *
   * <code>string page_view_id = 2 [(.google.api.field_behavior) = OPTIONAL];</code>
   *
   * @return The bytes for pageViewId.
   */
  com.google.protobuf.ByteString getPageViewIdBytes();

  /**
   *
   *
   * <pre>
   * Optional. A list of identifiers for the independent experiment groups
   * this user event belongs to. This is used to distinguish between user events
   * associated with different experiment setups (e.g. using Recommendation
   * Engine system, using different recommendation models).
   * </pre>
   *
   * <code>repeated string experiment_ids = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
   *
   * @return A list containing the experimentIds.
   */
  java.util.List<java.lang.String> getExperimentIdsList();
  /**
   *
   *
   * <pre>
   * Optional. A list of identifiers for the independent experiment groups
   * this user event belongs to. This is used to distinguish between user events
   * associated with different experiment setups (e.g. using Recommendation
   * Engine system, using different recommendation models).
   * </pre>
   *
   * <code>repeated string experiment_ids = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
   *
   * @return The count of experimentIds.
   */
  int getExperimentIdsCount();
  /**
   *
   *
   * <pre>
   * Optional. A list of identifiers for the independent experiment groups
   * this user event belongs to. This is used to distinguish between user events
   * associated with different experiment setups (e.g. using Recommendation
   * Engine system, using different recommendation models).
   * </pre>
   *
   * <code>repeated string experiment_ids = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
   *
   * @param index The index of the element to return.
   * @return The experimentIds at the given index.
   */
  java.lang.String getExperimentIds(int index);
  /**
   *
   *
   * <pre>
   * Optional. A list of identifiers for the independent experiment groups
   * this user event belongs to. This is used to distinguish between user events
   * associated with different experiment setups (e.g. using Recommendation
   * Engine system, using different recommendation models).
   * </pre>
   *
   * <code>repeated string experiment_ids = 3 [(.google.api.field_behavior) = OPTIONAL];</code>
   *
   * @param index The index of the value to return.
   * @return The bytes of the experimentIds at the given index.
   */
  com.google.protobuf.ByteString getExperimentIdsBytes(int index);

  /**
   *
   *
   * <pre>
   * Optional. Recommendation token included in the recommendation prediction
   * response.
   * This field enables accurate attribution of recommendation model
   * performance.
   * This token enables us to accurately attribute page view or purchase back to
   * the event and the particular predict response containing this
   * clicked/purchased item. If user clicks on product K in the recommendation
   * results, pass the `PredictResponse.recommendationToken` property as a url
   * parameter to product K's page. When recording events on product K's page,
   * log the PredictResponse.recommendation_token to this field.
   * Optional, but highly encouraged for user events that are the result of a
   * recommendation prediction query.
   * </pre>
   *
   * <code>string recommendation_token = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
   *
   * @return The recommendationToken.
   */
  java.lang.String getRecommendationToken();
  /**
   *
   *
   * <pre>
   * Optional. Recommendation token included in the recommendation prediction
   * response.
   * This field enables accurate attribution of recommendation model
   * performance.
   * This token enables us to accurately attribute page view or purchase back to
   * the event and the particular predict response containing this
   * clicked/purchased item. If user clicks on product K in the recommendation
   * results, pass the `PredictResponse.recommendationToken` property as a url
   * parameter to product K's page. When recording events on product K's page,
   * log the PredictResponse.recommendation_token to this field.
   * Optional, but highly encouraged for user events that are the result of a
   * recommendation prediction query.
   * </pre>
   *
   * <code>string recommendation_token = 4 [(.google.api.field_behavior) = OPTIONAL];</code>
   *
   * @return The bytes for recommendationToken.
   */
  com.google.protobuf.ByteString getRecommendationTokenBytes();

  /**
   *
   *
   * <pre>
   * Optional. Extra user event features to include in the recommendation
   * model.
   * For product recommendation, an example of extra user information is
   * traffic_channel, i.e. how user arrives at the site. Users can arrive
   * at the site by coming to the site directly, or coming through Google
   * search, and etc.
   * </pre>
   *
   * <code>
   * .google.cloud.recommendationengine.v1beta1.FeatureMap event_attributes = 5 [(.google.api.field_behavior) = OPTIONAL];
   * </code>
   *
   * @return Whether the eventAttributes field is set.
   */
  boolean hasEventAttributes();
  /**
   *
   *
   * <pre>
   * Optional. Extra user event features to include in the recommendation
   * model.
   * For product recommendation, an example of extra user information is
   * traffic_channel, i.e. how user arrives at the site. Users can arrive
   * at the site by coming to the site directly, or coming through Google
   * search, and etc.
   * </pre>
   *
   * <code>
   * .google.cloud.recommendationengine.v1beta1.FeatureMap event_attributes = 5 [(.google.api.field_behavior) = OPTIONAL];
   * </code>
   *
   * @return The eventAttributes.
   */
  com.google.cloud.recommendationengine.v1beta1.FeatureMap getEventAttributes();
  /**
   *
   *
   * <pre>
   * Optional. Extra user event features to include in the recommendation
   * model.
   * For product recommendation, an example of extra user information is
   * traffic_channel, i.e. how user arrives at the site. Users can arrive
   * at the site by coming to the site directly, or coming through Google
   * search, and etc.
   * </pre>
   *
   * <code>
   * .google.cloud.recommendationengine.v1beta1.FeatureMap event_attributes = 5 [(.google.api.field_behavior) = OPTIONAL];
   * </code>
   */
  com.google.cloud.recommendationengine.v1beta1.FeatureMapOrBuilder getEventAttributesOrBuilder();
}