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/talent/v4/common.proto 18 19 package com.google.cloud.talent.v4; 20 21 public interface RequestMetadataOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.talent.v4.RequestMetadata) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Required if 31 * [allow_missing_ids][google.cloud.talent.v4.RequestMetadata.allow_missing_ids] 32 * is unset or `false`. 33 * The client-defined scope or source of the service call, which typically 34 * is the domain on 35 * which the service has been implemented and is currently being run. 36 * For example, if the service is being run by client <em>Foo, Inc.</em>, on 37 * job board www.foo.com and career site www.bar.com, then this field is 38 * set to "foo.com" for use on the job board, and "bar.com" for use on the 39 * career site. 40 * Note that any improvements to the model for a particular tenant site rely 41 * on this field being set correctly to a unique domain. 42 * The maximum number of allowed characters is 255. 43 * </pre> 44 * 45 * <code>string domain = 1;</code> 46 * 47 * @return The domain. 48 */ getDomain()49 java.lang.String getDomain(); 50 /** 51 * 52 * 53 * <pre> 54 * Required if 55 * [allow_missing_ids][google.cloud.talent.v4.RequestMetadata.allow_missing_ids] 56 * is unset or `false`. 57 * The client-defined scope or source of the service call, which typically 58 * is the domain on 59 * which the service has been implemented and is currently being run. 60 * For example, if the service is being run by client <em>Foo, Inc.</em>, on 61 * job board www.foo.com and career site www.bar.com, then this field is 62 * set to "foo.com" for use on the job board, and "bar.com" for use on the 63 * career site. 64 * Note that any improvements to the model for a particular tenant site rely 65 * on this field being set correctly to a unique domain. 66 * The maximum number of allowed characters is 255. 67 * </pre> 68 * 69 * <code>string domain = 1;</code> 70 * 71 * @return The bytes for domain. 72 */ getDomainBytes()73 com.google.protobuf.ByteString getDomainBytes(); 74 75 /** 76 * 77 * 78 * <pre> 79 * Required if 80 * [allow_missing_ids][google.cloud.talent.v4.RequestMetadata.allow_missing_ids] 81 * is unset or `false`. 82 * A unique session identification string. A session is defined as the 83 * duration of an end user's interaction with the service over a certain 84 * period. 85 * Obfuscate this field for privacy concerns before 86 * providing it to the service. 87 * Note that any improvements to the model for a particular tenant site rely 88 * on this field being set correctly to a unique session ID. 89 * The maximum number of allowed characters is 255. 90 * </pre> 91 * 92 * <code>string session_id = 2;</code> 93 * 94 * @return The sessionId. 95 */ getSessionId()96 java.lang.String getSessionId(); 97 /** 98 * 99 * 100 * <pre> 101 * Required if 102 * [allow_missing_ids][google.cloud.talent.v4.RequestMetadata.allow_missing_ids] 103 * is unset or `false`. 104 * A unique session identification string. A session is defined as the 105 * duration of an end user's interaction with the service over a certain 106 * period. 107 * Obfuscate this field for privacy concerns before 108 * providing it to the service. 109 * Note that any improvements to the model for a particular tenant site rely 110 * on this field being set correctly to a unique session ID. 111 * The maximum number of allowed characters is 255. 112 * </pre> 113 * 114 * <code>string session_id = 2;</code> 115 * 116 * @return The bytes for sessionId. 117 */ getSessionIdBytes()118 com.google.protobuf.ByteString getSessionIdBytes(); 119 120 /** 121 * 122 * 123 * <pre> 124 * Required if 125 * [allow_missing_ids][google.cloud.talent.v4.RequestMetadata.allow_missing_ids] 126 * is unset or `false`. 127 * A unique user identification string, as determined by the client. 128 * To have the strongest positive impact on search quality 129 * make sure the client-level is unique. 130 * Obfuscate this field for privacy concerns before 131 * providing it to the service. 132 * Note that any improvements to the model for a particular tenant site rely 133 * on this field being set correctly to a unique user ID. 134 * The maximum number of allowed characters is 255. 135 * </pre> 136 * 137 * <code>string user_id = 3;</code> 138 * 139 * @return The userId. 140 */ getUserId()141 java.lang.String getUserId(); 142 /** 143 * 144 * 145 * <pre> 146 * Required if 147 * [allow_missing_ids][google.cloud.talent.v4.RequestMetadata.allow_missing_ids] 148 * is unset or `false`. 149 * A unique user identification string, as determined by the client. 150 * To have the strongest positive impact on search quality 151 * make sure the client-level is unique. 152 * Obfuscate this field for privacy concerns before 153 * providing it to the service. 154 * Note that any improvements to the model for a particular tenant site rely 155 * on this field being set correctly to a unique user ID. 156 * The maximum number of allowed characters is 255. 157 * </pre> 158 * 159 * <code>string user_id = 3;</code> 160 * 161 * @return The bytes for userId. 162 */ getUserIdBytes()163 com.google.protobuf.ByteString getUserIdBytes(); 164 165 /** 166 * 167 * 168 * <pre> 169 * Only set when any of 170 * [domain][google.cloud.talent.v4.RequestMetadata.domain], 171 * [session_id][google.cloud.talent.v4.RequestMetadata.session_id] and 172 * [user_id][google.cloud.talent.v4.RequestMetadata.user_id] isn't available 173 * for some reason. It is highly recommended not to set this field and provide 174 * accurate [domain][google.cloud.talent.v4.RequestMetadata.domain], 175 * [session_id][google.cloud.talent.v4.RequestMetadata.session_id] and 176 * [user_id][google.cloud.talent.v4.RequestMetadata.user_id] for the best 177 * service experience. 178 * </pre> 179 * 180 * <code>bool allow_missing_ids = 4;</code> 181 * 182 * @return The allowMissingIds. 183 */ getAllowMissingIds()184 boolean getAllowMissingIds(); 185 186 /** 187 * 188 * 189 * <pre> 190 * The type of device used by the job seeker at the time of the call to the 191 * service. 192 * </pre> 193 * 194 * <code>.google.cloud.talent.v4.DeviceInfo device_info = 5;</code> 195 * 196 * @return Whether the deviceInfo field is set. 197 */ hasDeviceInfo()198 boolean hasDeviceInfo(); 199 /** 200 * 201 * 202 * <pre> 203 * The type of device used by the job seeker at the time of the call to the 204 * service. 205 * </pre> 206 * 207 * <code>.google.cloud.talent.v4.DeviceInfo device_info = 5;</code> 208 * 209 * @return The deviceInfo. 210 */ getDeviceInfo()211 com.google.cloud.talent.v4.DeviceInfo getDeviceInfo(); 212 /** 213 * 214 * 215 * <pre> 216 * The type of device used by the job seeker at the time of the call to the 217 * service. 218 * </pre> 219 * 220 * <code>.google.cloud.talent.v4.DeviceInfo device_info = 5;</code> 221 */ getDeviceInfoOrBuilder()222 com.google.cloud.talent.v4.DeviceInfoOrBuilder getDeviceInfoOrBuilder(); 223 } 224