Class Task (2.51.0)

publicfinalclass TaskextendsGeneratedMessageV3implementsTaskOrBuilder

A unit of scheduled work.

Protobuf type google.cloud.tasks.v2.Task

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Task

Implements

TaskOrBuilder

Inherited Members

publicstaticfinalintAPP_ENGINE_HTTP_REQUEST_FIELD_NUMBER

publicstaticfinalintCREATE_TIME_FIELD_NUMBER

publicstaticfinalintDISPATCH_COUNT_FIELD_NUMBER

publicstaticfinalintDISPATCH_DEADLINE_FIELD_NUMBER

publicstaticfinalintFIRST_ATTEMPT_FIELD_NUMBER

publicstaticfinalintHTTP_REQUEST_FIELD_NUMBER

publicstaticfinalintLAST_ATTEMPT_FIELD_NUMBER

publicstaticfinalintNAME_FIELD_NUMBER

publicstaticfinalintRESPONSE_COUNT_FIELD_NUMBER

publicstaticfinalintSCHEDULE_TIME_FIELD_NUMBER

publicstaticfinalintVIEW_FIELD_NUMBER

publicstaticTaskgetDefaultInstance()

publicstaticfinalDescriptors.DescriptorgetDescriptor()

publicstaticTask.BuildernewBuilder()

publicstaticTask.BuildernewBuilder(Taskprototype)

publicstaticTaskparseDelimitedFrom(InputStreaminput)

publicstaticTaskparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticTaskparseFrom(byte[]data)

publicstaticTaskparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)

publicstaticTaskparseFrom(ByteStringdata)

publicstaticTaskparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)

publicstaticTaskparseFrom(CodedInputStreaminput)

publicstaticTaskparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticTaskparseFrom(InputStreaminput)

publicstaticTaskparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)

publicstaticTaskparseFrom(ByteBufferdata)

publicstaticTaskparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)

publicstaticParser<Task>parser()

publicbooleanequals(Objectobj)

AbstractMessage.equals(Object other)

publicAppEngineHttpRequestgetAppEngineHttpRequest()

HTTP request that is sent to the App Engine app handler.

An App Engine task is a task that has AppEngineHttpRequest set.

.google.cloud.tasks.v2.AppEngineHttpRequest app_engine_http_request = 2;

publicAppEngineHttpRequestOrBuildergetAppEngineHttpRequestOrBuilder()

HTTP request that is sent to the App Engine app handler.

An App Engine task is a task that has AppEngineHttpRequest set.

.google.cloud.tasks.v2.AppEngineHttpRequest app_engine_http_request = 2;

publicTimestampgetCreateTime()

Output only. The time that the task was created.

create_time will be truncated to the nearest second.

.google.protobuf.Timestamp create_time = 5;

publicTimestampOrBuildergetCreateTimeOrBuilder()

Output only. The time that the task was created.

create_time will be truncated to the nearest second.

.google.protobuf.Timestamp create_time = 5;

publicTaskgetDefaultInstanceForType()

publicintgetDispatchCount()

Output only. The number of attempts dispatched.

This count includes attempts which have been dispatched but haven't received a response.

int32 dispatch_count = 7;

publicDurationgetDispatchDeadline()

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 listening 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 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.

  dispatch_deadline will be truncated to the nearest millisecond. The deadline is an approximate deadline.

.google.protobuf.Duration dispatch_deadline = 6;

publicDurationOrBuildergetDispatchDeadlineOrBuilder()

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 listening 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 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.

  dispatch_deadline will be truncated to the nearest millisecond. The deadline is an approximate deadline.

.google.protobuf.Duration dispatch_deadline = 6;

publicAttemptgetFirstAttempt()

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.

.google.cloud.tasks.v2.Attempt first_attempt = 9;

publicAttemptOrBuildergetFirstAttemptOrBuilder()

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.

.google.cloud.tasks.v2.Attempt first_attempt = 9;

publicHttpRequestgetHttpRequest()

HTTP request that is sent to the worker.

An HTTP task is a task that has HttpRequest set.

.google.cloud.tasks.v2.HttpRequest http_request = 3;

publicHttpRequestOrBuildergetHttpRequestOrBuilder()

HTTP request that is sent to the worker.

An HTTP task is a task that has HttpRequest set.

.google.cloud.tasks.v2.HttpRequest http_request = 3;

publicAttemptgetLastAttempt()

Output only. The status of the task's last attempt.

.google.cloud.tasks.v2.Attempt last_attempt = 10;

publicAttemptOrBuildergetLastAttemptOrBuilder()

Output only. The status of the task's last attempt.

.google.cloud.tasks.v2.Attempt last_attempt = 10;

publicTask.MessageTypeCasegetMessageTypeCase()

publicStringgetName()

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
• 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.

string name = 1;

publicByteStringgetNameBytes()

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
• 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.

string name = 1;

publicParser<Task>getParserForType()

GeneratedMessageV3.getParserForType()

publicintgetResponseCount()

Output only. The number of attempts which have received a response.

int32 response_count = 8;

publicTimestampgetScheduleTime()

The time when the task is scheduled to be attempted or retried.

schedule_time will be truncated to the nearest microsecond.

.google.protobuf.Timestamp schedule_time = 4;

publicTimestampOrBuildergetScheduleTimeOrBuilder()

The time when the task is scheduled to be attempted or retried.

schedule_time will be truncated to the nearest microsecond.

.google.protobuf.Timestamp schedule_time = 4;

publicintgetSerializedSize()

GeneratedMessageV3.getSerializedSize()

publicTask.ViewgetView()

Output only. The view specifies which subset of the Task has been returned.

.google.cloud.tasks.v2.Task.View view = 11;

publicintgetViewValue()

Output only. The view specifies which subset of the Task has been returned.

.google.cloud.tasks.v2.Task.View view = 11;

publicbooleanhasAppEngineHttpRequest()

HTTP request that is sent to the App Engine app handler.

An App Engine task is a task that has AppEngineHttpRequest set.

.google.cloud.tasks.v2.AppEngineHttpRequest app_engine_http_request = 2;

publicbooleanhasCreateTime()

Output only. The time that the task was created.

create_time will be truncated to the nearest second.

.google.protobuf.Timestamp create_time = 5;

publicbooleanhasDispatchDeadline()

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 listening 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 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.

  dispatch_deadline will be truncated to the nearest millisecond. The deadline is an approximate deadline.

.google.protobuf.Duration dispatch_deadline = 6;

publicbooleanhasFirstAttempt()

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.

.google.cloud.tasks.v2.Attempt first_attempt = 9;

publicbooleanhasHttpRequest()

HTTP request that is sent to the worker.

An HTTP task is a task that has HttpRequest set.

.google.cloud.tasks.v2.HttpRequest http_request = 3;

publicbooleanhasLastAttempt()

Output only. The status of the task's last attempt.

.google.cloud.tasks.v2.Attempt last_attempt = 10;

publicbooleanhasScheduleTime()

The time when the task is scheduled to be attempted or retried.

schedule_time will be truncated to the nearest microsecond.

.google.protobuf.Timestamp schedule_time = 4;

publicinthashCode()

AbstractMessage.hashCode()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()

GeneratedMessageV3.internalGetFieldAccessorTable()

publicfinalbooleanisInitialized()

GeneratedMessageV3.isInitialized()

publicTask.BuildernewBuilderForType()

protectedTask.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

publicTask.BuildertoBuilder()

publicvoidwriteTo(CodedOutputStreamoutput)

GeneratedMessageV3.writeTo(CodedOutputStream output)