Method: projects.locations.batches.list

Muestra una lista de cargas de trabajo por lotes.

Solicitud HTTP

GET https://dataproc.googleapis.com/v1/{parent=projects/*/locations/*}/batches

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
parent

string

Obligatorio. El elemento superior, que es propietario de esta colección de lotes.

La autorización requiere el siguiente permiso IAM en el recurso especificado parent:

  • dataproc.batches.list

Parámetros de consulta

Parámetros
pageSize

integer

Opcional. Es la cantidad máxima de lotes que se mostrarán en cada respuesta. El servicio puede mostrar menos que este valor. El tamaño de página predeterminado es 20 y el máximo es 1,000.

pageToken

string

Opcional. Es un token de página recibido de una llamada a batches.list anterior. Proporciona este token para recuperar la página siguiente.

filter

string

Opcional. Es un filtro para que los lotes se muestren en la respuesta.

Un filtro es una expresión lógica que restringe los valores de varios campos en cada recurso por lotes. Los filtros distinguen mayúsculas de minúsculas y pueden contener varias cláusulas combinadas con operadores lógicos (Y/O). Los campos admitidos son batchId, batchUuid, state, createTime y labels.

p.ej., state = RUNNING and createTime < "2023-01-01T00:00:00Z" filtra lotes en estado RUNNING que se crearon antes del 1/1/2023. state = RUNNING and labels.environment=production filtra lotes en estado RUNNING que tienen una etiqueta de entorno de producción.

Consulta https://google.aip.dev/assets/misc/ebnf-filtering.txt para obtener una descripción detallada de la sintaxis del filtro y una lista de las comparaciones admitidas.

orderBy

string

Opcional. Son los campos en los que se ordenará la lista de lotes.

Actualmente, los únicos órdenes de clasificación admitidos son no especificados (vacíos) y createTime desc para ordenar primero por los lotes creados más recientemente.

Consulta https://google.aip.dev/132#ordering para obtener más detalles.

Cuerpo de la solicitud

El cuerpo de la solicitud debe estar vacío.

Cuerpo de la respuesta

Una lista de cargas de trabajo por lotes.

Si se ejecuta correctamente, el cuerpo de la respuesta contiene datos con la siguiente estructura:

Representación JSON
{
  "batches": [
    {
      object (Batch)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Campos
batches[]

object (Batch)

Solo salida. Los lotes de la colección especificada.

nextPageToken

string

Un token, que se puede enviar como pageToken para recuperar la página siguiente. Si se omite este campo, no habrá páginas siguientes.

unreachable[]

string

Solo salida. Es la lista de lotes que no se pudieron incluir en la respuesta. Intentar obtener uno de estos recursos puede indicar por qué no se incluyó en la respuesta de la lista.

Permisos de autorización

Se requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

Para obtener más información, consulta Descripción general de la autenticación.