serverless-spark-list-batches

About

A serverless-spark-list-batches tool returns a list of Spark batches from a Google Cloud Serverless for Apache Spark source. It’s compatible with the following sources:

• serverless-spark

serverless-spark-list-batches accepts the following parameters:

• filter (optional): A filter expression to limit the batches returned. Filters are case sensitive and may contain multiple clauses combined with logical operators (AND/OR). Supported fields are batch_id, batch_uuid, state, create_time, and labels. For example: state = RUNNING AND create_time < "2023-01-01T00:00:00Z".
• pageSize (optional): The maximum number of batches to return in a single page.
• pageToken (optional): A page token, received from a previous call, to retrieve the next page of results.

The tool gets the project and location from the source configuration.

Example

tools:
  list_spark_batches:
    kind: serverless-spark-list-batches
    source: my-serverless-spark-source
    description: Use this tool to list and filter serverless spark batches.

Response Format

{
  "batches": [
    {
      "name": "projects/my-project/locations/us-central1/batches/batch-abc-123",
      "uuid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
      "state": "SUCCEEDED",
      "creator": "alice@example.com",
      "createTime": "2023-10-27T10:00:00Z"
    },
    {
      "name": "projects/my-project/locations/us-central1/batches/batch-def-456",
      "uuid": "b2c3d4e5-f6a7-8901-2345-678901bcdefa",
      "state": "FAILED",
      "creator": "alice@example.com",
      "createTime": "2023-10-27T11:30:00Z"
    }
  ],
  "nextPageToken": "abcd1234"
}

Reference