ai.promoted.proto.delivery.InsertionOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of deliveryclient Show documentation
A Java Client to contact the Promoted.ai Delivery API.
There is a newer version: 3.2.0
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: proto/delivery/delivery.proto

package ai.promoted.proto.delivery;

public interface InsertionOrBuilder extends
    // @@protoc_insertion_point(interface_extends:delivery.Insertion)
    com.google.protobuf.MessageOrBuilder {

  /**
   * uint64 platform_id = 1 [json_name = "platformId"];
   * @return The platformId.
   */
  long getPlatformId();

  /**
   * .common.UserInfo user_info = 2 [json_name = "userInfo"];
   * @return Whether the userInfo field is set.
   */
  boolean hasUserInfo();
  /**
   * .common.UserInfo user_info = 2 [json_name = "userInfo"];
   * @return The userInfo.
   */
  ai.promoted.proto.common.UserInfo getUserInfo();
  /**
   * .common.UserInfo user_info = 2 [json_name = "userInfo"];
   */
  ai.promoted.proto.common.UserInfoOrBuilder getUserInfoOrBuilder();

  /**
   * .common.Timing timing = 3 [json_name = "timing"];
   * @return Whether the timing field is set.
   */
  boolean hasTiming();
  /**
   * .common.Timing timing = 3 [json_name = "timing"];
   * @return The timing.
   */
  ai.promoted.proto.common.Timing getTiming();
  /**
   * .common.Timing timing = 3 [json_name = "timing"];
   */
  ai.promoted.proto.common.TimingOrBuilder getTimingOrBuilder();

  /**
   * .common.ClientInfo client_info = 4 [json_name = "clientInfo"];
   * @return Whether the clientInfo field is set.
   */
  boolean hasClientInfo();
  /**
   * .common.ClientInfo client_info = 4 [json_name = "clientInfo"];
   * @return The clientInfo.
   */
  ai.promoted.proto.common.ClientInfo getClientInfo();
  /**
   * .common.ClientInfo client_info = 4 [json_name = "clientInfo"];
   */
  ai.promoted.proto.common.ClientInfoOrBuilder getClientInfoOrBuilder();

  /**
   * string insertion_id = 6 [json_name = "insertionId"];
   * @return The insertionId.
   */
  java.lang.String getInsertionId();
  /**
   * string insertion_id = 6 [json_name = "insertionId"];
   * @return The bytes for insertionId.
   */
  com.google.protobuf.ByteString
      getInsertionIdBytes();

  /**
   * string request_id = 7 [json_name = "requestId"];
   * @return The requestId.
   */
  java.lang.String getRequestId();
  /**
   * string request_id = 7 [json_name = "requestId"];
   * @return The bytes for requestId.
   */
  com.google.protobuf.ByteString
      getRequestIdBytes();

  /**
   * string view_id = 9 [json_name = "viewId"];
   * @return The viewId.
   */
  java.lang.String getViewId();
  /**
   * string view_id = 9 [json_name = "viewId"];
   * @return The bytes for viewId.
   */
  com.google.protobuf.ByteString
      getViewIdBytes();

  /**
   * string auto_view_id = 21 [json_name = "autoViewId"];
   * @return The autoViewId.
   */
  java.lang.String getAutoViewId();
  /**
   * string auto_view_id = 21 [json_name = "autoViewId"];
   * @return The bytes for autoViewId.
   */
  com.google.protobuf.ByteString
      getAutoViewIdBytes();

  /**
   * string session_id = 8 [json_name = "sessionId"];
   * @return The sessionId.
   */
  java.lang.String getSessionId();
  /**
   * string session_id = 8 [json_name = "sessionId"];
   * @return The bytes for sessionId.
   */
  com.google.protobuf.ByteString
      getSessionIdBytes();

  /**
   * string content_id = 10 [json_name = "contentId"];
   * @return The contentId.
   */
  java.lang.String getContentId();
  /**
   * string content_id = 10 [json_name = "contentId"];
   * @return The bytes for contentId.
   */
  com.google.protobuf.ByteString
      getContentIdBytes();

  /**
   * uint64 position = 12 [json_name = "position"];
   * @return Whether the position field is set.
   */
  boolean hasPosition();
  /**
   * uint64 position = 12 [json_name = "position"];
   * @return The position.
   */
  long getPosition();

  /**
   * .common.Properties properties = 13 [json_name = "properties"];
   * @return Whether the properties field is set.
   */
  boolean hasProperties();
  /**
   * .common.Properties properties = 13 [json_name = "properties"];
   * @return The properties.
   */
  ai.promoted.proto.common.Properties getProperties();
  /**
   * .common.Properties properties = 13 [json_name = "properties"];
   */
  ai.promoted.proto.common.PropertiesOrBuilder getPropertiesOrBuilder();

  /**
   * uint64 retrieval_rank = 19 [json_name = "retrievalRank"];
   * @return Whether the retrievalRank field is set.
   */
  boolean hasRetrievalRank();
  /**
   * uint64 retrieval_rank = 19 [json_name = "retrievalRank"];
   * @return The retrievalRank.
   */
  long getRetrievalRank();

  /**
   * float retrieval_score = 20 [json_name = "retrievalScore"];
   * @return Whether the retrievalScore field is set.
   */
  boolean hasRetrievalScore();
  /**
   * float retrieval_score = 20 [json_name = "retrievalScore"];
   * @return The retrievalScore.
   */
  float getRetrievalScore();
}