Package com.google.cloud.tasks.v2beta2

Interface TaskOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    Task, Task.Builder
    public interface TaskOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Detail

      • getName

        String getName()
         Optionally caller-specified in
 [CreateTask][google.cloud.tasks.v2beta2.CloudTasks.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][google.cloud.location.Locations.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;
        Returns:
        The name.

      • getNameBytes

        com.google.protobuf.ByteString getNameBytes()
         Optionally caller-specified in
 [CreateTask][google.cloud.tasks.v2beta2.CloudTasks.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][google.cloud.location.Locations.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;
        Returns:
        The bytes for name.

      • hasAppEngineHttpRequest

        boolean hasAppEngineHttpRequest()
         App Engine HTTP request that is sent to the task's target. Can
 be set only if
 [app_engine_http_target][google.cloud.tasks.v2beta2.Queue.app_engine_http_target]
 is set on the queue.

 An App Engine task is a task that has
 [AppEngineHttpRequest][google.cloud.tasks.v2beta2.AppEngineHttpRequest]
 set.
        .google.cloud.tasks.v2beta2.AppEngineHttpRequest app_engine_http_request = 3;
        Returns:
        Whether the appEngineHttpRequest field is set.

      • getAppEngineHttpRequest

        AppEngineHttpRequest getAppEngineHttpRequest()
         App Engine HTTP request that is sent to the task's target. Can
 be set only if
 [app_engine_http_target][google.cloud.tasks.v2beta2.Queue.app_engine_http_target]
 is set on the queue.

 An App Engine task is a task that has
 [AppEngineHttpRequest][google.cloud.tasks.v2beta2.AppEngineHttpRequest]
 set.
        .google.cloud.tasks.v2beta2.AppEngineHttpRequest app_engine_http_request = 3;
        Returns:
        The appEngineHttpRequest.

      • getAppEngineHttpRequestOrBuilder

        AppEngineHttpRequestOrBuilder getAppEngineHttpRequestOrBuilder()
         App Engine HTTP request that is sent to the task's target. Can
 be set only if
 [app_engine_http_target][google.cloud.tasks.v2beta2.Queue.app_engine_http_target]
 is set on the queue.

 An App Engine task is a task that has
 [AppEngineHttpRequest][google.cloud.tasks.v2beta2.AppEngineHttpRequest]
 set.
        .google.cloud.tasks.v2beta2.AppEngineHttpRequest app_engine_http_request = 3;

      • hasPullMessage

        boolean hasPullMessage()
         [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] to process
 the task. Can be set only if
 [pull_target][google.cloud.tasks.v2beta2.Queue.pull_target] is set on the
 queue.

 A pull task is a task that has
 [PullMessage][google.cloud.tasks.v2beta2.PullMessage] set.
        .google.cloud.tasks.v2beta2.PullMessage pull_message = 4;
        Returns:
        Whether the pullMessage field is set.

      • getPullMessage

        PullMessage getPullMessage()
         [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] to process
 the task. Can be set only if
 [pull_target][google.cloud.tasks.v2beta2.Queue.pull_target] is set on the
 queue.

 A pull task is a task that has
 [PullMessage][google.cloud.tasks.v2beta2.PullMessage] set.
        .google.cloud.tasks.v2beta2.PullMessage pull_message = 4;
        Returns:
        The pullMessage.

      • getPullMessageOrBuilder

        PullMessageOrBuilder getPullMessageOrBuilder()
         [LeaseTasks][google.cloud.tasks.v2beta2.CloudTasks.LeaseTasks] to process
 the task. Can be set only if
 [pull_target][google.cloud.tasks.v2beta2.Queue.pull_target] is set on the
 queue.

 A pull task is a task that has
 [PullMessage][google.cloud.tasks.v2beta2.PullMessage] set.
        .google.cloud.tasks.v2beta2.PullMessage pull_message = 4;

      • hasHttpRequest

        boolean hasHttpRequest()
         HTTP request that is sent to the task's target.

 An HTTP task is a task that has
 [HttpRequest][google.cloud.tasks.v2beta2.HttpRequest] set.
        .google.cloud.tasks.v2beta2.HttpRequest http_request = 13;
        Returns:
        Whether the httpRequest field is set.

      • getHttpRequest

        HttpRequest getHttpRequest()
         HTTP request that is sent to the task's target.

 An HTTP task is a task that has
 [HttpRequest][google.cloud.tasks.v2beta2.HttpRequest] set.
        .google.cloud.tasks.v2beta2.HttpRequest http_request = 13;
        Returns:
        The httpRequest.

      • getHttpRequestOrBuilder

        HttpRequestOrBuilder getHttpRequestOrBuilder()
         HTTP request that is sent to the task's target.

 An HTTP task is a task that has
 [HttpRequest][google.cloud.tasks.v2beta2.HttpRequest] set.
        .google.cloud.tasks.v2beta2.HttpRequest http_request = 13;

      • hasScheduleTime

        boolean hasScheduleTime()
         The time when the task is scheduled to be attempted.

 For App Engine queues, this is when the task will be attempted or retried.

 For pull queues, this is the time when the task is available to
 be leased; if a task is currently leased, this is the time when
 the current lease expires, that is, the time that the task was
 leased plus the
 [lease_duration][google.cloud.tasks.v2beta2.LeaseTasksRequest.lease_duration].

 `schedule_time` will be truncated to the nearest microsecond.
        .google.protobuf.Timestamp schedule_time = 5;
        Returns:
        Whether the scheduleTime field is set.

      • getScheduleTime

        com.google.protobuf.Timestamp 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.

 For pull queues, this is the time when the task is available to
 be leased; if a task is currently leased, this is the time when
 the current lease expires, that is, the time that the task was
 leased plus the
 [lease_duration][google.cloud.tasks.v2beta2.LeaseTasksRequest.lease_duration].

 `schedule_time` will be truncated to the nearest microsecond.
        .google.protobuf.Timestamp schedule_time = 5;
        Returns:
        The scheduleTime.

      • getScheduleTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getScheduleTimeOrBuilder()
         The time when the task is scheduled to be attempted.

 For App Engine queues, this is when the task will be attempted or retried.

 For pull queues, this is the time when the task is available to
 be leased; if a task is currently leased, this is the time when
 the current lease expires, that is, the time that the task was
 leased plus the
 [lease_duration][google.cloud.tasks.v2beta2.LeaseTasksRequest.lease_duration].

 `schedule_time` will be truncated to the nearest microsecond.
        .google.protobuf.Timestamp schedule_time = 5;

      • hasCreateTime

        boolean hasCreateTime()
         Output only. The time that the task was created.

 `create_time` will be truncated to the nearest second.
        .google.protobuf.Timestamp create_time = 6;
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        com.google.protobuf.Timestamp getCreateTime()
         Output only. The time that the task was created.

 `create_time` will be truncated to the nearest second.
        .google.protobuf.Timestamp create_time = 6;
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
         Output only. The time that the task was created.

 `create_time` will be truncated to the nearest second.
        .google.protobuf.Timestamp create_time = 6;

      • hasStatus

        boolean hasStatus()
         Output only. The task status.
        .google.cloud.tasks.v2beta2.TaskStatus status = 7;
        Returns:
        Whether the status field is set.

      • getStatus

        TaskStatus getStatus()
         Output only. The task status.
        .google.cloud.tasks.v2beta2.TaskStatus status = 7;
        Returns:
        The status.

      • getStatusOrBuilder

        TaskStatusOrBuilder getStatusOrBuilder()
         Output only. The task status.
        .google.cloud.tasks.v2beta2.TaskStatus status = 7;

      • getViewValue

        int getViewValue()
         Output only. The view specifies which subset of the
 [Task][google.cloud.tasks.v2beta2.Task] has been returned.
        .google.cloud.tasks.v2beta2.Task.View view = 8;
        Returns:
        The enum numeric value on the wire for view.

      • getView

        Task.View getView()
         Output only. The view specifies which subset of the
 [Task][google.cloud.tasks.v2beta2.Task] has been returned.
        .google.cloud.tasks.v2beta2.Task.View view = 8;
        Returns:
        The view.