Task (Cloud Tasks API v2beta3 (Rev. 33) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.cloudtasks.v2beta3.model.Task

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class Task
extends com.google.api.client.json.GenericJson
```
A unit of scheduled work.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Tasks API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Task()

Constructors
Constructor and Description
`Task()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Task`	`clone()`
`AppEngineHttpRequest`	`getAppEngineHttpRequest()` HTTP request that is sent to the App Engine app handler.
`java.lang.String`	`getCreateTime()` Output only.
`java.lang.Integer`	`getDispatchCount()` Output only.
`java.lang.String`	`getDispatchDeadline()` The deadline for requests sent to the worker.
`Attempt`	`getFirstAttempt()` Output only.
`HttpRequest`	`getHttpRequest()` HTTP request that is sent to the task's target.
`Attempt`	`getLastAttempt()` Output only.
`java.lang.String`	`getName()` Optionally caller-specified in CreateTask.
`java.lang.Integer`	`getResponseCount()` Output only.
`java.lang.String`	`getScheduleTime()` The time when the task is scheduled to be attempted.
`java.lang.String`	`getView()` Output only.
`Task`	`set(java.lang.String fieldName, java.lang.Object value)`
`Task`	`setAppEngineHttpRequest(AppEngineHttpRequest appEngineHttpRequest)` HTTP request that is sent to the App Engine app handler.
`Task`	`setCreateTime(java.lang.String createTime)` Output only.
`Task`	`setDispatchCount(java.lang.Integer dispatchCount)` Output only.
`Task`	`setDispatchDeadline(java.lang.String dispatchDeadline)` The deadline for requests sent to the worker.
`Task`	`setFirstAttempt(Attempt firstAttempt)` Output only.
`Task`	`setHttpRequest(HttpRequest httpRequest)` HTTP request that is sent to the task's target.
`Task`	`setLastAttempt(Attempt lastAttempt)` Output only.
`Task`	`setName(java.lang.String name)` Optionally caller-specified in CreateTask.
`Task`	`setResponseCount(java.lang.Integer responseCount)` Output only.
`Task`	`setScheduleTime(java.lang.String scheduleTime)` The time when the task is scheduled to be attempted.
`Task`	`setView(java.lang.String view)` Output only.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Task
```
public Task()
```
- Method Detail
  - getAppEngineHttpRequest
```
public AppEngineHttpRequest getAppEngineHttpRequest()
```
    HTTP request that is sent to the App Engine app handler. An App Engine task is a task that has AppEngineHttpRequest set.
    
    Returns:
    
    value or null for none
  - setAppEngineHttpRequest
```
public Task setAppEngineHttpRequest(AppEngineHttpRequest appEngineHttpRequest)
```
    HTTP request that is sent to the App Engine app handler. An App Engine task is a task that has AppEngineHttpRequest set.
    
    Parameters:
    
    appEngineHttpRequest - appEngineHttpRequest or null for none
  - getCreateTime
```
public java.lang.String getCreateTime()
```
    Output only. The time that the task was created. `create_time` will be truncated to the nearest second.
    
    Returns:
    
    value or null for none
  - setCreateTime
```
public Task setCreateTime(java.lang.String createTime)
```
    Output only. The time that the task was created. `create_time` will be truncated to the nearest second.
    
    Parameters:
    
    createTime - createTime or null for none
  - getDispatchCount
```
public java.lang.Integer getDispatchCount()
```
    Output only. The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response.
    
    Returns:
    
    value or null for none
  - setDispatchCount
```
public Task setDispatchCount(java.lang.Integer dispatchCount)
```
    Output only. The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response.
    
    Parameters:
    
    dispatchCount - dispatchCount or null for none
  - getDispatchDeadline
```
public java.lang.String getDispatchDeadline()
```
    The deadline for requests sent to the worker. If the worker does not respond by this deadline then the request is cancelled and the attempt is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the task according to the RetryConfig. Note that when the request is cancelled, Cloud Tasks will stop listing for the response, but whether the worker stops processing depends on the worker. For example, if the worker is stuck, it may not react to cancelled requests. The default and maximum values depend on the type of request: * For HTTP tasks, the default is 10 minutes. The deadline must be in the interval [15 seconds, 30 minutes]. * For App Engine tasks, 0 indicates that the request has the default deadline. The default deadline depends on the [scaling type](https://cloud.google.com/appengine/docs/standard/go /how-instances-are-managed#instance_scaling) of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds]. Regardless of the task's `dispatch_deadline`, the app handler will not run for longer than than the service's timeout. We recommend setting the `dispatch_deadline` to at most a few seconds more than the app handler's timeout. For more information see [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine- handlers#timeouts). `dispatch_deadline` will be truncated to the nearest millisecond. The deadline is an approximate deadline.
    
    Returns:
    
    value or null for none
  - setDispatchDeadline
```
public Task setDispatchDeadline(java.lang.String dispatchDeadline)
```
    The deadline for requests sent to the worker. If the worker does not respond by this deadline then the request is cancelled and the attempt is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the task according to the RetryConfig. Note that when the request is cancelled, Cloud Tasks will stop listing for the response, but whether the worker stops processing depends on the worker. For example, if the worker is stuck, it may not react to cancelled requests. The default and maximum values depend on the type of request: * For HTTP tasks, the default is 10 minutes. The deadline must be in the interval [15 seconds, 30 minutes]. * For App Engine tasks, 0 indicates that the request has the default deadline. The default deadline depends on the [scaling type](https://cloud.google.com/appengine/docs/standard/go /how-instances-are-managed#instance_scaling) of the service: 10 minutes for standard apps with automatic scaling, 24 hours for standard apps with manual and basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds]. Regardless of the task's `dispatch_deadline`, the app handler will not run for longer than than the service's timeout. We recommend setting the `dispatch_deadline` to at most a few seconds more than the app handler's timeout. For more information see [Timeouts](https://cloud.google.com/tasks/docs/creating-appengine- handlers#timeouts). `dispatch_deadline` will be truncated to the nearest millisecond. The deadline is an approximate deadline.
    
    Parameters:
    
    dispatchDeadline - dispatchDeadline or null for none
  - getFirstAttempt
```
public Attempt getFirstAttempt()
```
    Output only. The status of the task's first attempt. Only dispatch_time will be set. The other Attempt information is not retained by Cloud Tasks.
    
    Returns:
    
    value or null for none
  - setFirstAttempt
```
public Task setFirstAttempt(Attempt firstAttempt)
```
    Output only. The status of the task's first attempt. Only dispatch_time will be set. The other Attempt information is not retained by Cloud Tasks.
    
    Parameters:
    
    firstAttempt - firstAttempt or null for none
  - getHttpRequest
```
public HttpRequest getHttpRequest()
```
    HTTP request that is sent to the task's target. An HTTP task is a task that has HttpRequest set.
    
    Returns:
    
    value or null for none
  - setHttpRequest
```
public Task setHttpRequest(HttpRequest httpRequest)
```
    HTTP request that is sent to the task's target. An HTTP task is a task that has HttpRequest set.
    
    Parameters:
    
    httpRequest - httpRequest or null for none
  - getLastAttempt
```
public Attempt getLastAttempt()
```
    Output only. The status of the task's last attempt.
    
    Returns:
    
    value or null for none
  - setLastAttempt
```
public Task setLastAttempt(Attempt lastAttempt)
```
    Output only. The status of the task's last attempt.
    
    Parameters:
    
    lastAttempt - lastAttempt or null for none
  - getName
```
public java.lang.String getName()
```
    Optionally caller-specified in CreateTask. The task name. The task name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com /resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the task's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
    
    Returns:
    
    value or null for none
  - setName
```
public Task setName(java.lang.String name)
```
    Optionally caller-specified in CreateTask. The task name. The task name must have the following format: `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID` * `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying projects](https://cloud.google.com /resource-manager/docs/creating-managing-projects#identifying_projects) * `LOCATION_ID` is the canonical ID for the task's location. The list of available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or hyphens (-). The maximum length is 100 characters. * `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
    
    Parameters:
    
    name - name or null for none
  - getResponseCount
```
public java.lang.Integer getResponseCount()
```
    Output only. The number of attempts which have received a response.
    
    Returns:
    
    value or null for none
  - setResponseCount
```
public Task setResponseCount(java.lang.Integer responseCount)
```
    Output only. The number of attempts which have received a response.
    
    Parameters:
    
    responseCount - responseCount or null for none
  - getScheduleTime
```
public java.lang.String getScheduleTime()
```
    The time when the task is scheduled to be attempted. For App Engine queues, this is when the task will be attempted or retried. `schedule_time` will be truncated to the nearest microsecond.
    
    Returns:
    
    value or null for none
  - setScheduleTime
```
public Task setScheduleTime(java.lang.String scheduleTime)
```
    The time when the task is scheduled to be attempted. For App Engine queues, this is when the task will be attempted or retried. `schedule_time` will be truncated to the nearest microsecond.
    
    Parameters:
    
    scheduleTime - scheduleTime or null for none
  - getView
```
public java.lang.String getView()
```
    Output only. The view specifies which subset of the Task has been returned.
    
    Returns:
    
    value or null for none
  - setView
```
public Task setView(java.lang.String view)
```
    Output only. The view specifies which subset of the Task has been returned.
    
    Parameters:
    
    view - view or null for none
  - set
```
public Task set(java.lang.String fieldName,
                java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Task clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Cloud Tasks API v2beta3 (revision 33)

Class Task

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Task

Method Detail

getAppEngineHttpRequest

setAppEngineHttpRequest

getCreateTime

setCreateTime

getDispatchCount

setDispatchCount

getDispatchDeadline

setDispatchDeadline

getFirstAttempt

setFirstAttempt

getHttpRequest

setHttpRequest

getLastAttempt

setLastAttempt

getName

setName

getResponseCount

setResponseCount

getScheduleTime

setScheduleTime

getView

setView

set

clone