Console
    Contact Us Start free

    Google Cloud Tasks V2 Client - Class Task (2.0.2)

    Reference documentation and code samples for the Google Cloud Tasks V2 Client class Task.

    A unit of scheduled work.

    Generated from protobuf message google.cloud.tasks.v2.Task

    Namespace

    Google \ Cloud \ Tasks \ V2

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ name
    string

    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.

    ↳ app_engine_http_request
    AppEngineHttpRequest

    HTTP request that is sent to the App Engine app handler. An App Engine task is a task that has AppEngineHttpRequest set.

    ↳ http_request
    HttpRequest

    HTTP request that is sent to the worker. An HTTP task is a task that has HttpRequest set.

    ↳ schedule_time
    Google\Protobuf\Timestamp

    The time when the task is scheduled to be attempted or retried. schedule_time will be truncated to the nearest microsecond.

    ↳ create_time
    Google\Protobuf\Timestamp

    Output only. The time that the task was created. create_time will be truncated to the nearest second.

    ↳ dispatch_deadline
    Google\Protobuf\Duration

    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.

    ↳ dispatch_count
    int

    Output only. The number of attempts dispatched. This count includes attempts which have been dispatched but haven't received a response.

    ↳ response_count
    int

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

    ↳ first_attempt
    Attempt

    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.

    ↳ last_attempt
    Attempt

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

    ↳ view
    int

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

    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
    • 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
    Type
    Description
    string

    setName

    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.
    Parameter
    Name
    Description
    var
    string
    Returns
    Type
    Description
    $this

    getAppEngineHttpRequest

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

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

    Returns
    Type
    Description
    AppEngineHttpRequest |null

    hasAppEngineHttpRequest

    setAppEngineHttpRequest

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

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

    Parameter
    Name
    Description
    var
    AppEngineHttpRequest
    Returns
    Type
    Description
    $this

    getHttpRequest

    HTTP request that is sent to the worker.

    An HTTP task is a task that has HttpRequest set.

    Returns
    Type
    Description
    HttpRequest |null

    hasHttpRequest

    setHttpRequest

    HTTP request that is sent to the worker.

    An HTTP task is a task that has HttpRequest set.

    Parameter
    Name
    Description
    var
    HttpRequest
    Returns
    Type
    Description
    $this

    getScheduleTime

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

    schedule_time will be truncated to the nearest microsecond.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasScheduleTime

    clearScheduleTime

    setScheduleTime

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

    schedule_time will be truncated to the nearest microsecond.

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getCreateTime

    Output only. The time that the task was created.

    create_time will be truncated to the nearest second.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasCreateTime

    clearCreateTime

    setCreateTime

    Output only. The time that the task was created.

    create_time will be truncated to the nearest second.

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    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 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.
    Returns
    Type
    Description
    Google\Protobuf\Duration |null

    hasDispatchDeadline

    clearDispatchDeadline

    setDispatchDeadline

    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.
    Parameter
    Name
    Description
    var
    Google\Protobuf\Duration
    Returns
    Type
    Description
    $this

    getDispatchCount

    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

    setDispatchCount

    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

    getResponseCount

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

    Returns
    Type
    Description
    int

    setResponseCount

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

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    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
    Type
    Description
    Attempt |null

    hasFirstAttempt

    clearFirstAttempt

    setFirstAttempt

    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.

    Parameter
    Name
    Description
    var
    Attempt
    Returns
    Type
    Description
    $this

    getLastAttempt

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

    Returns
    Type
    Description
    Attempt |null

    hasLastAttempt

    clearLastAttempt

    setLastAttempt

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

    Parameter
    Name
    Description
    var
    Attempt
    Returns
    Type
    Description
    $this

    getView

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

    Returns
    Type
    Description
    int

    setView

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

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getMessageType

    Returns
    Type
    Description
    string
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: