com.google.cloud.retail.v2.CollectUserEventRequestOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-retail-v2 Show documentation
Proto library for google-cloud-retail
The newest version!
/*
 * Copyright 2024 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/retail/v2/user_event_service.proto

// Protobuf Java Version: 3.25.5
package com.google.cloud.retail.v2;

public interface CollectUserEventRequestOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.retail.v2.CollectUserEventRequest)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * The prebuilt rule name that can convert a specific type of raw_json.
   * For example: "ga4_bq" rule for the GA4 user event schema.
   * 
   *
   * string prebuilt_rule = 6;
   *
   * @return Whether the prebuiltRule field is set.
   */
  boolean hasPrebuiltRule();
  /**
   *
   *
   *    * The prebuilt rule name that can convert a specific type of raw_json.
   * For example: "ga4_bq" rule for the GA4 user event schema.
   * 
   *
   * string prebuilt_rule = 6;
   *
   * @return The prebuiltRule.
   */
  java.lang.String getPrebuiltRule();
  /**
   *
   *
   *    * The prebuilt rule name that can convert a specific type of raw_json.
   * For example: "ga4_bq" rule for the GA4 user event schema.
   * 
   *
   * string prebuilt_rule = 6;
   *
   * @return The bytes for prebuiltRule.
   */
  com.google.protobuf.ByteString getPrebuiltRuleBytes();

  /**
   *
   *
   *    * Required. The parent catalog name, such as
   * `projects/1234/locations/global/catalogs/default_catalog`.
   * 
   *
   * string parent = 1 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The parent.
   */
  java.lang.String getParent();
  /**
   *
   *
   *    * Required. The parent catalog name, such as
   * `projects/1234/locations/global/catalogs/default_catalog`.
   * 
   *
   * string parent = 1 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The bytes for parent.
   */
  com.google.protobuf.ByteString getParentBytes();

  /**
   *
   *
   *    * Required. URL encoded UserEvent proto with a length limit of 2,000,000
   * characters.
   * 
   *
   * string user_event = 2 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The userEvent.
   */
  java.lang.String getUserEvent();
  /**
   *
   *
   *    * Required. URL encoded UserEvent proto with a length limit of 2,000,000
   * characters.
   * 
   *
   * string user_event = 2 [(.google.api.field_behavior) = REQUIRED];
   *
   * @return The bytes for userEvent.
   */
  com.google.protobuf.ByteString getUserEventBytes();

  /**
   *
   *
   *    * The URL including cgi-parameters but excluding the hash fragment with a
   * length limit of 5,000 characters. This is often more useful than the
   * referer URL, because many browsers only send the domain for 3rd party
   * requests.
   * 
   *
   * string uri = 3;
   *
   * @return The uri.
   */
  java.lang.String getUri();
  /**
   *
   *
   *    * The URL including cgi-parameters but excluding the hash fragment with a
   * length limit of 5,000 characters. This is often more useful than the
   * referer URL, because many browsers only send the domain for 3rd party
   * requests.
   * 
   *
   * string uri = 3;
   *
   * @return The bytes for uri.
   */
  com.google.protobuf.ByteString getUriBytes();

  /**
   *
   *
   *    * The event timestamp in milliseconds. This prevents browser caching of
   * otherwise identical get requests. The name is abbreviated to reduce the
   * payload bytes.
   * 
   *
   * int64 ets = 4;
   *
   * @return The ets.
   */
  long getEts();

  /**
   *
   *
   *    * An arbitrary serialized JSON string that contains necessary information
   * that can comprise a user event. When this field is specified, the
   * user_event field will be ignored. Note: line-delimited JSON is not
   * supported, a single JSON only.
   * 
   *
   * string raw_json = 5;
   *
   * @return The rawJson.
   */
  java.lang.String getRawJson();
  /**
   *
   *
   *    * An arbitrary serialized JSON string that contains necessary information
   * that can comprise a user event. When this field is specified, the
   * user_event field will be ignored. Note: line-delimited JSON is not
   * supported, a single JSON only.
   * 
   *
   * string raw_json = 5;
   *
   * @return The bytes for rawJson.
   */
  com.google.protobuf.ByteString getRawJsonBytes();

  com.google.cloud.retail.v2.CollectUserEventRequest.ConversionRuleCase getConversionRuleCase();
}