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/discoveryengine/v1beta/user_event.proto 18 19 package com.google.cloud.discoveryengine.v1beta; 20 21 public interface DocumentInfoOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.discoveryengine.v1beta.DocumentInfo) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Required. The Document resource ID. 31 * </pre> 32 * 33 * <code>string id = 1 [(.google.api.field_behavior) = REQUIRED];</code> 34 * 35 * @return Whether the id field is set. 36 */ hasId()37 boolean hasId(); 38 /** 39 * 40 * 41 * <pre> 42 * Required. The Document resource ID. 43 * </pre> 44 * 45 * <code>string id = 1 [(.google.api.field_behavior) = REQUIRED];</code> 46 * 47 * @return The id. 48 */ getId()49 java.lang.String getId(); 50 /** 51 * 52 * 53 * <pre> 54 * Required. The Document resource ID. 55 * </pre> 56 * 57 * <code>string id = 1 [(.google.api.field_behavior) = REQUIRED];</code> 58 * 59 * @return The bytes for id. 60 */ getIdBytes()61 com.google.protobuf.ByteString getIdBytes(); 62 63 /** 64 * 65 * 66 * <pre> 67 * Required. The Document resource full name, of the form: 68 * `projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}` 69 * </pre> 70 * 71 * <code> 72 * string name = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... } 73 * </code> 74 * 75 * @return Whether the name field is set. 76 */ hasName()77 boolean hasName(); 78 /** 79 * 80 * 81 * <pre> 82 * Required. The Document resource full name, of the form: 83 * `projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}` 84 * </pre> 85 * 86 * <code> 87 * string name = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... } 88 * </code> 89 * 90 * @return The name. 91 */ getName()92 java.lang.String getName(); 93 /** 94 * 95 * 96 * <pre> 97 * Required. The Document resource full name, of the form: 98 * `projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}` 99 * </pre> 100 * 101 * <code> 102 * string name = 2 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... } 103 * </code> 104 * 105 * @return The bytes for name. 106 */ getNameBytes()107 com.google.protobuf.ByteString getNameBytes(); 108 109 /** 110 * 111 * 112 * <pre> 113 * Quantity of the Document associated with the user event. Defaults to 1. 114 * For example, this field will be 2 if two quantities of the same Document 115 * are involved in a `add-to-cart` event. 116 * Required for events of the following event types: 117 * * `add-to-cart` 118 * * `purchase` 119 * </pre> 120 * 121 * <code>optional int32 quantity = 3;</code> 122 * 123 * @return Whether the quantity field is set. 124 */ hasQuantity()125 boolean hasQuantity(); 126 /** 127 * 128 * 129 * <pre> 130 * Quantity of the Document associated with the user event. Defaults to 1. 131 * For example, this field will be 2 if two quantities of the same Document 132 * are involved in a `add-to-cart` event. 133 * Required for events of the following event types: 134 * * `add-to-cart` 135 * * `purchase` 136 * </pre> 137 * 138 * <code>optional int32 quantity = 3;</code> 139 * 140 * @return The quantity. 141 */ getQuantity()142 int getQuantity(); 143 144 /** 145 * 146 * 147 * <pre> 148 * The promotion IDs associated with this Document. 149 * Currently, this field is restricted to at most one ID. 150 * </pre> 151 * 152 * <code>repeated string promotion_ids = 4;</code> 153 * 154 * @return A list containing the promotionIds. 155 */ getPromotionIdsList()156 java.util.List<java.lang.String> getPromotionIdsList(); 157 /** 158 * 159 * 160 * <pre> 161 * The promotion IDs associated with this Document. 162 * Currently, this field is restricted to at most one ID. 163 * </pre> 164 * 165 * <code>repeated string promotion_ids = 4;</code> 166 * 167 * @return The count of promotionIds. 168 */ getPromotionIdsCount()169 int getPromotionIdsCount(); 170 /** 171 * 172 * 173 * <pre> 174 * The promotion IDs associated with this Document. 175 * Currently, this field is restricted to at most one ID. 176 * </pre> 177 * 178 * <code>repeated string promotion_ids = 4;</code> 179 * 180 * @param index The index of the element to return. 181 * @return The promotionIds at the given index. 182 */ getPromotionIds(int index)183 java.lang.String getPromotionIds(int index); 184 /** 185 * 186 * 187 * <pre> 188 * The promotion IDs associated with this Document. 189 * Currently, this field is restricted to at most one ID. 190 * </pre> 191 * 192 * <code>repeated string promotion_ids = 4;</code> 193 * 194 * @param index The index of the value to return. 195 * @return The bytes of the promotionIds at the given index. 196 */ getPromotionIdsBytes(int index)197 com.google.protobuf.ByteString getPromotionIdsBytes(int index); 198 199 public com.google.cloud.discoveryengine.v1beta.DocumentInfo.DocumentDescriptorCase getDocumentDescriptorCase()200 getDocumentDescriptorCase(); 201 } 202