Reference documentation and code samples for the Google Cloud Tasks V2beta2 Client class TaskStatus.
Status of the task.
Generated from protobuf message google.cloud.tasks.v2beta2.TaskStatus
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ attempt_dispatch_count |
int
Output only. The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response. |
↳ attempt_response_count |
int
Output only. The number of attempts which have received a response. This field is not calculated for pull tasks. |
↳ first_attempt_status |
Google\Cloud\Tasks\V2beta2\AttemptStatus
Output only. The status of the task's first attempt. Only dispatch_time will be set. The other AttemptStatus information is not retained by Cloud Tasks. This field is not calculated for pull tasks. |
↳ last_attempt_status |
Google\Cloud\Tasks\V2beta2\AttemptStatus
Output only. The status of the task's last attempt. This field is not calculated for pull tasks. |
getAttemptDispatchCount
Output only. The number of attempts dispatched.
This count includes attempts which have been dispatched but haven't received a response.
| Returns | |
|---|---|
| Type | Description |
int | |
setAttemptDispatchCount
Output only. The number of attempts dispatched.
This count includes attempts which have been dispatched but haven't received a response.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getAttemptResponseCount
Output only. The number of attempts which have received a response.
This field is not calculated for pull tasks.
| Returns | |
|---|---|
| Type | Description |
int | |
setAttemptResponseCount
Output only. The number of attempts which have received a response.
This field is not calculated for pull tasks.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFirstAttemptStatus
Output only. The status of the task's first attempt.
Only dispatch_time will be set. The other AttemptStatus information is not retained by Cloud Tasks. This field is not calculated for pull tasks.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Tasks\V2beta2\AttemptStatus|null | |
hasFirstAttemptStatus
clearFirstAttemptStatus
setFirstAttemptStatus
Output only. The status of the task's first attempt.
Only dispatch_time will be set. The other AttemptStatus information is not retained by Cloud Tasks. This field is not calculated for pull tasks.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Tasks\V2beta2\AttemptStatus
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLastAttemptStatus
Output only. The status of the task's last attempt.
This field is not calculated for pull tasks.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Tasks\V2beta2\AttemptStatus|null | |
hasLastAttemptStatus
clearLastAttemptStatus
setLastAttemptStatus
Output only. The status of the task's last attempt.
This field is not calculated for pull tasks.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Tasks\V2beta2\AttemptStatus
|
| Returns | |
|---|---|
| Type | Description |
$this | |