Method: projects.locations.batches.list

Lista cargas de trabalho em lote.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O pai, que é proprietário dessa coleção de lotes.

A autorização requer a seguinte permissão do IAM no recurso especificado parent:

  • dataproc.batches.list

Parâmetros de consulta

Parâmetros
pageSize

integer

Opcional. O número máximo de lotes a serem retornados em cada resposta. O serviço pode retornar menos que esse valor. O tamanho de página padrão é 20, e o máximo é 1.000.
pageToken

string

Opcional. Um token de página recebido de uma chamada batches.list anterior. Forneça este token para recuperar a página seguinte.
filter

string

Opcional. Um filtro para que os lotes sejam retornados na resposta.

Um filtro é uma expressão lógica que restringe os valores de vários campos em cada recurso de lote. Os filtros diferenciam maiúsculas de minúsculas e podem conter várias cláusulas combinadas com operadores lógicos (E/OU). Os campos aceitos são batchId, batchUuid, state, createTime e labels.

Por exemplo, state = RUNNING and createTime < "2023-01-01T00:00:00Z" filtra lotes no estado EXECUÇÃO que foram criados antes de 01/01/2023. state = RUNNING and labels.environment=production filtra lotes em execução que têm um rótulo de ambiente de produção.

Consulte https://google.aip.dev/assets/misc/ebnf-filtering.txt para conferir uma descrição detalhada da sintaxe do filtro e uma lista de comparações compatíveis.
orderBy

string

Opcional. Campos para classificar a lista de lotes.

No momento, as únicas ordenações de classificação compatíveis são não especificadas (vazias) e createTime desc para classificar primeiro os lotes mais recentes.

Consulte https://google.aip.dev/132#ordering para mais detalhes.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

Uma lista de cargas de trabalho em lote.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "batches": [
    {
      object (Batch)
    }
  ],
  "nextPageToken": string,
  "unreachable": [
    string
  ]
}
Campos
batches[]

object (Batch)

Apenas saída. Os lotes da coleção especificada.
nextPageToken

string

Um token, que pode ser enviado como pageToken para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.
unreachable[]

string

Apenas saída. Lista de lotes que não puderam ser incluídos na resposta. A tentativa de acessar um desses recursos pode indicar por que ele não foi incluído na resposta da lista.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.