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/tasks/v2beta2/task.proto 18 19 package com.google.cloud.tasks.v2beta2; 20 21 public interface TaskOrBuilder 22 extends 23 // @@protoc_insertion_point(interface_extends:google.cloud.tasks.v2beta2.Task) 24 com.google.protobuf.MessageOrBuilder { 25 26 /** 27 * 28 * 29 * <pre> 30 * Optionally caller-specified in 31 * [CreateTask][google.cloud.tasks.v2beta2.CloudTasks.CreateTask]. 32 * The task name. 33 * The task name must have the following format: 34 * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` 35 * * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), 36 * hyphens (-), colons (:), or periods (.). 37 * For more information, see 38 * [Identifying 39 * projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) 40 * * `LOCATION_ID` is the canonical ID for the task's location. 41 * The list of available locations can be obtained by calling 42 * [ListLocations][google.cloud.location.Locations.ListLocations]. 43 * For more information, see https://cloud.google.com/about/locations/. 44 * * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or 45 * hyphens (-). The maximum length is 100 characters. 46 * * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), 47 * hyphens (-), or underscores (_). The maximum length is 500 characters. 48 * </pre> 49 * 50 * <code>string name = 1;</code> 51 * 52 * @return The name. 53 */ getName()54 java.lang.String getName(); 55 /** 56 * 57 * 58 * <pre> 59 * Optionally caller-specified in 60 * [CreateTask][google.cloud.tasks.v2beta2.CloudTasks.CreateTask]. 61 * The task name. 62 * The task name must have the following format: 63 * `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` 64 * * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), 65 * hyphens (-), colons (:), or periods (.). 66 * For more information, see 67 * [Identifying 68 * projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects) 69 * * `LOCATION_ID` is the canonical ID for the task's location. 70 * The list of available locations can be obtained by calling 71 * [ListLocations][google.cloud.location.Locations.ListLocations]. 72 * For more information, see https://cloud.google.com/about/locations/. 73 * * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or 74 * hyphens (-). The maximum length is 100 characters. 75 * * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), 76 * hyphens (-), or underscores (_). The maximum length is 500 characters. 77 * </pre> 78 * 79 * <code>string name = 1;</code> 80 * 81 * @return The bytes for name. 82 */ getNameBytes()83 com.google.protobuf.ByteString getNameBytes(); 84 85 /** 86 * 87 * 88 * <pre> 89 * App Engine HTTP request that is sent to the task's target. Can 90 * be set only if 91 * [app_engine_http_target][google.cloud.tasks.v2beta2.Queue.app_engine_http_target] 92 * is set on the queue. 93 * An App Engine task is a task that has 94 * [AppEngineHttpRequest][google.cloud.tasks.v2beta2.AppEngineHttpRequest] 95 * set. 96 * </pre> 97 * 98 * <code>.google.cloud.tasks.v2beta2.AppEngineHttpRequest app_engine_http_request = 3;</code> 99 * 100 * @return Whether the appEngineHttpRequest field is set. 101 */ hasAppEngineHttpRequest()102 boolean hasAppEngineHttpRequest(); 103 /** 104 * 105 * 106 * <pre> 107 * App Engine HTTP request that is sent to the task's target. Can 108 * be set only if 109 * [app_engine_http_target][google.cloud.tasks.v2beta2.Queue.app_engine_http_target] 110 * is set on the queue. 111 * An App Engine task is a task that has 112 * [AppEngineHttpRequest][google.cloud.tasks.v2beta2.AppEngineHttpRequest] 113 * set. 114 * </pre> 115 * 116 * <code>.google.cloud.tasks.v2beta2.AppEngineHttpRequest app_engine_http_request = 3;</code> 117 * 118 * @return The appEngineHttpRequest. 119 */ getAppEngineHttpRequest()120 com.google.cloud.tasks.v2beta2.AppEngineHttpRequest getAppEngineHttpRequest(); 121 /** 122 * 123 * 124 * <pre> 125 * App Engine HTTP request that is sent to the task's target. Can 126 * be set only if 127 * [app_engine_http_target][google.cloud.tasks.v2beta2.Queue.app_engine_http_target] 128 * is set on the queue. 129 * An App Engine task is a task that has 130 * [AppEngineHttpRequest][google.cloud.tasks.v2beta2.AppEngineHttpRequest] 131 * set. 132 * </pre> 133 * 134 * <code>.google.cloud.tasks.v2beta2.AppEngineHttpRequest app_engine_http_request = 3;</code> 135 */ getAppEngineHttpRequestOrBuilder()136 com.google.cloud.tasks.v2beta2.AppEngineHttpRequestOrBuilder getAppEngineHttpRequestOrBuilder(); 137 138 /** 139 * 140 * 141 * <pre> 142 * [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] to process 143 * the task. Can be set only if 144 * [pull_target][google.cloud.tasks.v2beta2.Queue.pull_target] is set on the 145 * queue. 146 * A pull task is a task that has 147 * [PullMessage][google.cloud.tasks.v2beta2.PullMessage] set. 148 * </pre> 149 * 150 * <code>.google.cloud.tasks.v2beta2.PullMessage pull_message = 4;</code> 151 * 152 * @return Whether the pullMessage field is set. 153 */ hasPullMessage()154 boolean hasPullMessage(); 155 /** 156 * 157 * 158 * <pre> 159 * [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] to process 160 * the task. Can be set only if 161 * [pull_target][google.cloud.tasks.v2beta2.Queue.pull_target] is set on the 162 * queue. 163 * A pull task is a task that has 164 * [PullMessage][google.cloud.tasks.v2beta2.PullMessage] set. 165 * </pre> 166 * 167 * <code>.google.cloud.tasks.v2beta2.PullMessage pull_message = 4;</code> 168 * 169 * @return The pullMessage. 170 */ getPullMessage()171 com.google.cloud.tasks.v2beta2.PullMessage getPullMessage(); 172 /** 173 * 174 * 175 * <pre> 176 * [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] to process 177 * the task. Can be set only if 178 * [pull_target][google.cloud.tasks.v2beta2.Queue.pull_target] is set on the 179 * queue. 180 * A pull task is a task that has 181 * [PullMessage][google.cloud.tasks.v2beta2.PullMessage] set. 182 * </pre> 183 * 184 * <code>.google.cloud.tasks.v2beta2.PullMessage pull_message = 4;</code> 185 */ getPullMessageOrBuilder()186 com.google.cloud.tasks.v2beta2.PullMessageOrBuilder getPullMessageOrBuilder(); 187 188 /** 189 * 190 * 191 * <pre> 192 * The time when the task is scheduled to be attempted. 193 * For App Engine queues, this is when the task will be attempted or retried. 194 * For pull queues, this is the time when the task is available to 195 * be leased; if a task is currently leased, this is the time when 196 * the current lease expires, that is, the time that the task was 197 * leased plus the 198 * [lease_duration][google.cloud.tasks.v2beta2.LeaseTasksRequest.lease_duration]. 199 * `schedule_time` will be truncated to the nearest microsecond. 200 * </pre> 201 * 202 * <code>.google.protobuf.Timestamp schedule_time = 5;</code> 203 * 204 * @return Whether the scheduleTime field is set. 205 */ hasScheduleTime()206 boolean hasScheduleTime(); 207 /** 208 * 209 * 210 * <pre> 211 * The time when the task is scheduled to be attempted. 212 * For App Engine queues, this is when the task will be attempted or retried. 213 * For pull queues, this is the time when the task is available to 214 * be leased; if a task is currently leased, this is the time when 215 * the current lease expires, that is, the time that the task was 216 * leased plus the 217 * [lease_duration][google.cloud.tasks.v2beta2.LeaseTasksRequest.lease_duration]. 218 * `schedule_time` will be truncated to the nearest microsecond. 219 * </pre> 220 * 221 * <code>.google.protobuf.Timestamp schedule_time = 5;</code> 222 * 223 * @return The scheduleTime. 224 */ getScheduleTime()225 com.google.protobuf.Timestamp getScheduleTime(); 226 /** 227 * 228 * 229 * <pre> 230 * The time when the task is scheduled to be attempted. 231 * For App Engine queues, this is when the task will be attempted or retried. 232 * For pull queues, this is the time when the task is available to 233 * be leased; if a task is currently leased, this is the time when 234 * the current lease expires, that is, the time that the task was 235 * leased plus the 236 * [lease_duration][google.cloud.tasks.v2beta2.LeaseTasksRequest.lease_duration]. 237 * `schedule_time` will be truncated to the nearest microsecond. 238 * </pre> 239 * 240 * <code>.google.protobuf.Timestamp schedule_time = 5;</code> 241 */ getScheduleTimeOrBuilder()242 com.google.protobuf.TimestampOrBuilder getScheduleTimeOrBuilder(); 243 244 /** 245 * 246 * 247 * <pre> 248 * Output only. The time that the task was created. 249 * `create_time` will be truncated to the nearest second. 250 * </pre> 251 * 252 * <code>.google.protobuf.Timestamp create_time = 6;</code> 253 * 254 * @return Whether the createTime field is set. 255 */ hasCreateTime()256 boolean hasCreateTime(); 257 /** 258 * 259 * 260 * <pre> 261 * Output only. The time that the task was created. 262 * `create_time` will be truncated to the nearest second. 263 * </pre> 264 * 265 * <code>.google.protobuf.Timestamp create_time = 6;</code> 266 * 267 * @return The createTime. 268 */ getCreateTime()269 com.google.protobuf.Timestamp getCreateTime(); 270 /** 271 * 272 * 273 * <pre> 274 * Output only. The time that the task was created. 275 * `create_time` will be truncated to the nearest second. 276 * </pre> 277 * 278 * <code>.google.protobuf.Timestamp create_time = 6;</code> 279 */ getCreateTimeOrBuilder()280 com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder(); 281 282 /** 283 * 284 * 285 * <pre> 286 * Output only. The task status. 287 * </pre> 288 * 289 * <code>.google.cloud.tasks.v2beta2.TaskStatus status = 7;</code> 290 * 291 * @return Whether the status field is set. 292 */ hasStatus()293 boolean hasStatus(); 294 /** 295 * 296 * 297 * <pre> 298 * Output only. The task status. 299 * </pre> 300 * 301 * <code>.google.cloud.tasks.v2beta2.TaskStatus status = 7;</code> 302 * 303 * @return The status. 304 */ getStatus()305 com.google.cloud.tasks.v2beta2.TaskStatus getStatus(); 306 /** 307 * 308 * 309 * <pre> 310 * Output only. The task status. 311 * </pre> 312 * 313 * <code>.google.cloud.tasks.v2beta2.TaskStatus status = 7;</code> 314 */ getStatusOrBuilder()315 com.google.cloud.tasks.v2beta2.TaskStatusOrBuilder getStatusOrBuilder(); 316 317 /** 318 * 319 * 320 * <pre> 321 * Output only. The view specifies which subset of the 322 * [Task][google.cloud.tasks.v2beta2.Task] has been returned. 323 * </pre> 324 * 325 * <code>.google.cloud.tasks.v2beta2.Task.View view = 8;</code> 326 * 327 * @return The enum numeric value on the wire for view. 328 */ getViewValue()329 int getViewValue(); 330 /** 331 * 332 * 333 * <pre> 334 * Output only. The view specifies which subset of the 335 * [Task][google.cloud.tasks.v2beta2.Task] has been returned. 336 * </pre> 337 * 338 * <code>.google.cloud.tasks.v2beta2.Task.View view = 8;</code> 339 * 340 * @return The view. 341 */ getView()342 com.google.cloud.tasks.v2beta2.Task.View getView(); 343 getPayloadTypeCase()344 public com.google.cloud.tasks.v2beta2.Task.PayloadTypeCase getPayloadTypeCase(); 345 } 346