1 /* 2 * Copyright 2020 Google LLC 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * https://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 // Generated by the protocol buffer compiler. DO NOT EDIT! 17 // source: google/cloud/retail/v2/prediction_service.proto 18 19 package com.google.cloud.retail.v2; 20 21 public interface PredictResponseOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.retail.v2.PredictResponse) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * A list of recommended products. The order represents the ranking (from the 31 * most relevant product to the least). 32 * </pre> 33 * 34 * <code>repeated .google.cloud.retail.v2.PredictResponse.PredictionResult results = 1;</code> 35 */ getResultsList()36 java.util.List<com.google.cloud.retail.v2.PredictResponse.PredictionResult> getResultsList(); 37 /** 38 * 39 * 40 * <pre> 41 * A list of recommended products. The order represents the ranking (from the 42 * most relevant product to the least). 43 * </pre> 44 * 45 * <code>repeated .google.cloud.retail.v2.PredictResponse.PredictionResult results = 1;</code> 46 */ getResults(int index)47 com.google.cloud.retail.v2.PredictResponse.PredictionResult getResults(int index); 48 /** 49 * 50 * 51 * <pre> 52 * A list of recommended products. The order represents the ranking (from the 53 * most relevant product to the least). 54 * </pre> 55 * 56 * <code>repeated .google.cloud.retail.v2.PredictResponse.PredictionResult results = 1;</code> 57 */ getResultsCount()58 int getResultsCount(); 59 /** 60 * 61 * 62 * <pre> 63 * A list of recommended products. The order represents the ranking (from the 64 * most relevant product to the least). 65 * </pre> 66 * 67 * <code>repeated .google.cloud.retail.v2.PredictResponse.PredictionResult results = 1;</code> 68 */ 69 java.util.List<? extends com.google.cloud.retail.v2.PredictResponse.PredictionResultOrBuilder> getResultsOrBuilderList()70 getResultsOrBuilderList(); 71 /** 72 * 73 * 74 * <pre> 75 * A list of recommended products. The order represents the ranking (from the 76 * most relevant product to the least). 77 * </pre> 78 * 79 * <code>repeated .google.cloud.retail.v2.PredictResponse.PredictionResult results = 1;</code> 80 */ getResultsOrBuilder( int index)81 com.google.cloud.retail.v2.PredictResponse.PredictionResultOrBuilder getResultsOrBuilder( 82 int index); 83 84 /** 85 * 86 * 87 * <pre> 88 * A unique attribution token. This should be included in the 89 * [UserEvent][google.cloud.retail.v2.UserEvent] logs resulting from this 90 * recommendation, which enables accurate attribution of recommendation model 91 * performance. 92 * </pre> 93 * 94 * <code>string attribution_token = 2;</code> 95 * 96 * @return The attributionToken. 97 */ getAttributionToken()98 java.lang.String getAttributionToken(); 99 /** 100 * 101 * 102 * <pre> 103 * A unique attribution token. This should be included in the 104 * [UserEvent][google.cloud.retail.v2.UserEvent] logs resulting from this 105 * recommendation, which enables accurate attribution of recommendation model 106 * performance. 107 * </pre> 108 * 109 * <code>string attribution_token = 2;</code> 110 * 111 * @return The bytes for attributionToken. 112 */ getAttributionTokenBytes()113 com.google.protobuf.ByteString getAttributionTokenBytes(); 114 115 /** 116 * 117 * 118 * <pre> 119 * IDs of products in the request that were missing from the inventory. 120 * </pre> 121 * 122 * <code>repeated string missing_ids = 3;</code> 123 * 124 * @return A list containing the missingIds. 125 */ getMissingIdsList()126 java.util.List<java.lang.String> getMissingIdsList(); 127 /** 128 * 129 * 130 * <pre> 131 * IDs of products in the request that were missing from the inventory. 132 * </pre> 133 * 134 * <code>repeated string missing_ids = 3;</code> 135 * 136 * @return The count of missingIds. 137 */ getMissingIdsCount()138 int getMissingIdsCount(); 139 /** 140 * 141 * 142 * <pre> 143 * IDs of products in the request that were missing from the inventory. 144 * </pre> 145 * 146 * <code>repeated string missing_ids = 3;</code> 147 * 148 * @param index The index of the element to return. 149 * @return The missingIds at the given index. 150 */ getMissingIds(int index)151 java.lang.String getMissingIds(int index); 152 /** 153 * 154 * 155 * <pre> 156 * IDs of products in the request that were missing from the inventory. 157 * </pre> 158 * 159 * <code>repeated string missing_ids = 3;</code> 160 * 161 * @param index The index of the value to return. 162 * @return The bytes of the missingIds at the given index. 163 */ getMissingIdsBytes(int index)164 com.google.protobuf.ByteString getMissingIdsBytes(int index); 165 166 /** 167 * 168 * 169 * <pre> 170 * True if the validateOnly property was set in the request. 171 * </pre> 172 * 173 * <code>bool validate_only = 4;</code> 174 * 175 * @return The validateOnly. 176 */ getValidateOnly()177 boolean getValidateOnly(); 178 } 179