get(name, x__xgafv=None)

Return a single Task.

Args:
  name: string, Required. Task name. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A Cloud Batch task.
  "name": "A String", # Task name. The name is generated from the parent TaskGroup name and 'id' field. For example: "projects/123456/locations/us-west1/jobs/job01/taskGroups/group01/tasks/task01".
  "status": { # Status of a task # Task Status.
    "state": "A String", # Task state
    "statusEvents": [ # Detailed info about why the state is reached.
      { # Status event
        "description": "A String", # Description of the event.
        "eventTime": "A String", # The time this event occurred.
        "taskExecution": { # This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. # Task Execution
          "exitCode": 42, # When task is completed as the status of FAILED or SUCCEEDED, exit code is for one task execution result, default is 0 as success.
        },
        "type": "A String", # Type of the event.
      },
    ],
  },
}

list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

List Tasks associated with a job.

Args:
  parent: string, Required. Name of a TaskGroup from which Tasks are being requested. Pattern: "projects/{project}/locations/{location}/jobs/{job}/taskGroups/{task_group}" (required)
  filter: string, Task filter, null filter matches all Tasks. Filter string should be of the format State=TaskStatus.State e.g. State=RUNNING
  pageSize: integer, Page size.
  pageToken: string, Page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # ListTasks Response.
  "nextPageToken": "A String", # Next page token.
  "tasks": [ # Tasks.
    { # A Cloud Batch task.
      "name": "A String", # Task name. The name is generated from the parent TaskGroup name and 'id' field. For example: "projects/123456/locations/us-west1/jobs/job01/taskGroups/group01/tasks/task01".
      "status": { # Status of a task # Task Status.
        "state": "A String", # Task state
        "statusEvents": [ # Detailed info about why the state is reached.
          { # Status event
            "description": "A String", # Description of the event.
            "eventTime": "A String", # The time this event occurred.
            "taskExecution": { # This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. # Task Execution
              "exitCode": 42, # When task is completed as the status of FAILED or SUCCEEDED, exit code is for one task execution result, default is 0 as success.
            },
            "type": "A String", # Type of the event.
          },
        ],
      },
    },
  ],
  "unreachable": [ # Locations that could not be reached.
    "A String",
  ],
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.

Batch API . projects . locations . jobs . taskGroups . tasks

Instance Methods

Method Details