Ver trabajos y tareas

En este documento, se explica cómo ver los trabajos y las tareas de Batch.

Antes de comenzar

Si no has usado Batch antes, revisa Comienza a usar Batch y completa los requisitos previos para los proyectos y usuarios a fin de habilitar Batch.
Si quieres obtener los permisos que necesitas para ver los trabajos y las tareas, pídele a tu administrador que te otorgue el rol de IAM Visualizador de trabajos por lotes (roles/batch.jobsViewer) o Editor de trabajos por lotes (roles/batch.jobsEditor) en el proyecto. Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso.

Es posible que también puedas obtener los permisos necesarios a través de los roles personalizados o de otros roles predefinidos.

Ver tus empleos

Para ver tus trabajos, selecciona uno de los siguientes métodos:

Para ver todos los trabajos de tu proyecto, consulta una lista de tus trabajos.
Para ver todos los detalles de configuración de un trabajo específico, consulta los detalles de un trabajo.

Cómo ver una lista de tus trabajos

Puedes ver una lista de trabajos en el proyecto actual con la consola de Google Cloud, gcloud CLI, la API de Batch, Go, Java, Node.js, Python o C++.

Console

Para ver una lista de trabajos en el proyecto actual con la consola de Google Cloud, ve a la página Lista de trabajos.

Ir a Lista de trabajos

La lista de trabajos puede tener varias páginas. Si necesitas pasar a la página siguiente, haz clic en Siguiente en la parte inferior de la pantalla.
Si deseas filtrar la lista de trabajos, haz clic en Filtrar (opcional). Luego, escribe o selecciona una propiedad y un valor.

Por ejemplo, si quieres filtrar la lista para que solo incluya trabajos en un estado específico, ingresa lo siguiente:
```
Status:JOB_STATE
```
Reemplaza JOB_STATE por un estado de trabajo, por ejemplo, FAILED.

Nota: Algunas opciones de filtrado, por ejemplo, solo enumerar trabajos con una o más etiquetas específicas, no se admiten en la consola de Google Cloud. Para obtener más opciones de filtrado, enumera los trabajos con gcloud CLI o la API de Batch en su lugar.

gcloud

Ver todos los trabajos

Para ver una lista de trabajos en el proyecto actual con la gcloud CLId, usa el comando gcloud batch jobs list.

gcloud batch jobs list

De manera opcional, puedes agregar una o más marcas para ver una lista filtrada de trabajos:

Para ver solo los trabajos de una ubicación específica, incluye la marca --location.
Para ver solo los trabajos basados en una expresión de filtro, especifica la marca --filter.

Por ejemplo, usa el siguiente comando:

gcloud batch jobs list \
    --location=LOCATION \
    --filter="FILTER_EXPRESSION"

Reemplaza lo siguiente:

LOCATION: Es la ubicación en la que existen uno o más trabajos.
FILTER_EXPRESSION: Es una expresión de filtro que define los trabajos que deseas enumerar. La expresión de filtro debe definir uno o más pares propiedad-valor separados por cero o más operadores booleanos (AND, OR y NOT).

Por ejemplo, consulta las siguientes expresiones de filtro:
- Filtro basado en el estado del trabajo: para ver solo los trabajos que están en un estado específico, usa la siguiente expresión de filtro:
```
status.state="JOB_STATE"
```
  Reemplaza JOB_STATE por un estado de trabajo, por ejemplo, FAILED.
- Filtro basado en etiquetas: Supongamos que tu proyecto definió las siguientes etiquetas personalizadas:
  - Para indicar los trabajos y los recursos que tu equipo de investigación creó cuando ves los informes de Facturación de Cloud, algunos de tus trabajos y sus recursos tienen una etiqueta team configurada como research.
  - Para indicar las cargas de trabajo urgentes, algunos trabajos tienen una etiqueta deadline, que se establece en varios valores.
  - Para indicar los ejecutables que tu equipo de desarrollo probó de forma correcta, algunos ejecutables tienen una etiqueta tested establecida en true.
  Luego, puedes especificar la siguiente expresión de filtro:
```
(allocationPolicy.labels.team=research) AND ((labels.deadline:*) OR (runnables.labels.tested=true))
```
  En esta expresión de filtro, solo se enumeran los trabajos que cumplen con todos los criterios siguientes:
  - Trabajos del equipo de investigación que tienen una etiqueta team en la política de asignación del trabajo configurada como research
  - Trabajos que cumplen con al menos uno de los siguientes criterios:
    - Trabajos que son urgentes y tienen una etiqueta deadline en el trabajo que se establece en cualquier valor.
    - Trabajos que tienen al menos un ejecutable que se probó de forma correcta, que son trabajos que tienen al menos un ejecutable con una etiqueta tested establecida en true

API

Ver todos los trabajos

Para ver una lista de trabajos en el proyecto actual de una ubicación específica con la API de Batch, realiza una solicitud GET al método jobs.list.

GET https://batch.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/jobs

Reemplaza lo siguiente:

PROJECT_ID: Es el ID del proyecto de tu proyecto actual.
LOCATION: Es la ubicación en la que existen los trabajos.

De manera opcional, puedes especificar el parámetro de consulta filter para ver una lista filtrada de trabajos basada en una expresión de filtro.

Por ejemplo, realiza la siguiente solicitud GET:

GET https://batch.googleapis.com/v1/projects/example-project/locations/us-central1/jobs?filter=FILTER_EXPRESSION

Reemplaza FILTER_EXPRESSION por una expresión de filtro que use codificación URL. La expresión de filtro debe definir uno o más pares propiedad-valor separados por cero o más operadores booleanos (AND, OR y NOT).

Por ejemplo, consulta las siguientes expresiones de filtro:

Filtro basado en el estado del trabajo: para ver solo los trabajos que están en un estado específico, usa la siguiente expresión de filtro:
```
status.state="JOB_STATE"
```
Reemplaza JOB_STATE por un estado de trabajo, por ejemplo, FAILED.
Filtro basado en etiquetas: Supongamos que tu proyecto definió las siguientes etiquetas personalizadas:
- Para indicar los trabajos y los recursos que tu equipo de investigación creó cuando ves los informes de Facturación de Cloud, algunos de tus trabajos y sus recursos tienen una etiqueta team configurada como research.
- Para indicar las cargas de trabajo urgentes, algunos trabajos tienen una etiqueta deadline, que se establece en varios valores.
- Para indicar los ejecutables que tu equipo de desarrollo probó de forma correcta, algunos ejecutables tienen una etiqueta tested establecida en true.
Luego, puedes especificar la siguiente expresión de filtro:
```
(allocationPolicy.labels.team%3Dresearch)%20AND%20((labels.deadline%3A*)%20OR%20(runnables.labels.tested%3Dtrue))
```
Nota: La expresión de filtro codificada con URL representa la siguiente expresión de filtro decodificada:
```
  (allocationPolicy.labels.team=research) AND ((labels.deadline:*) OR (runnables.labels.tested=true))
```
En esta expresión de filtro, solo se enumeran los trabajos que cumplen con todos los criterios siguientes:
- Trabajos del equipo de investigación que tienen una etiqueta team en la política de asignación del trabajo configurada como research
- Trabajos que cumplen con al menos uno de los siguientes criterios:
  - Trabajos que son urgentes y tienen una etiqueta deadline en el trabajo que se establece en cualquier valor.
  - Trabajos que tienen al menos un ejecutable que se probó de forma correcta, que son trabajos que tienen al menos un ejecutable con una etiqueta tested establecida en true

Go

Si deseas obtener más información, consulta la documentación de referencia de la API de Batch Go.

Para autenticarte en Batch, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.

import (
	"context"
	"fmt"
	"io"

	batch "cloud.google.com/go/batch/apiv1"
	"cloud.google.com/go/batch/apiv1/batchpb"
	"google.golang.org/api/iterator"
)

// Lists all jobs in the given project and region
func listJobs(w io.Writer, projectID, region string) error {
	// projectID := "your_project_id"
	// region := "us-central1"

	ctx := context.Background()
	batchClient, err := batch.NewClient(ctx)
	if err != nil {
		return fmt.Errorf("NewClient: %w", err)
	}
	defer batchClient.Close()

	req := &batchpb.ListJobsRequest{
		Parent: fmt.Sprintf("projects/%s/locations/%s", projectID, region),
	}

	var jobs []*batchpb.Job
	it := batchClient.ListJobs(ctx, req)

	for {
		job, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			return fmt.Errorf("unable to list jobs: %w", err)
		}
		jobs = append(jobs, job)
	}

	fmt.Fprintf(w, "Jobs: %v\n", jobs)

	return nil
}

Java

Si deseas obtener más información, consulta la documentación de referencia de la API de Batch Java.

import com.google.cloud.batch.v1.BatchServiceClient;
import com.google.cloud.batch.v1.Job;
import java.io.IOException;

public class ListJobs {

  public static void main(String[] args) throws IOException {
    // TODO(developer): Replace these variables before running the sample.
    // Project ID or project number of the Cloud project you want to use.
    String projectId = "YOUR_PROJECT_ID";

    // Name of the region hosting the jobs.
    String region = "europe-central2";

    listJobs(projectId, region);
  }

  // Get a list of all jobs defined in given region.
  public static void listJobs(String projectId, String region) throws IOException {
    // Initialize client that will be used to send requests. This client only needs to be created
    // once, and can be reused for multiple requests. After completing all of your requests, call
    // the `batchServiceClient.close()` method on the client to safely
    // clean up any remaining background resources.
    try (BatchServiceClient batchServiceClient = BatchServiceClient.create()) {

      // Construct the parent path of the job.
      String parent = String.format("projects/%s/locations/%s", projectId, region);

      for (Job job : batchServiceClient.listJobs(parent).iterateAll()) {
        System.out.println(job.getName());
      }
      System.out.println("Listed all batch jobs.");
    }
  }
}

Node.js

Si deseas obtener más información, consulta la documentación de referencia de la API de Batch Node.js.

/**
 * TODO(developer): Uncomment and replace these variables before running the sample.
 */
// const projectId = 'YOUR_PROJECT_ID';
/**
 * The region that hosts the job.
 */
// const region = 'us-central-1';

// Imports the Batch library
const batchLib = require('@google-cloud/batch');

// Instantiates a client
const batchClient = new batchLib.v1.BatchServiceClient();

async function callListJobs() {
  // Construct request
  const request = {
    parent: `projects/${projectId}/locations/${region}`,
  };

  // Run request
  const iterable = await batchClient.listJobsAsync(request);
  for await (const response of iterable) {
    console.log(response);
  }
}

callListJobs();

Python

Si deseas obtener más información, consulta la documentación de referencia de la API de Batch Python.

from __future__ import annotations

from collections.abc import Iterable

from google.cloud import batch_v1

def list_jobs(project_id: str, region: str) -> Iterable[batch_v1.Job]:
    """
    Get a list of all jobs defined in given region.

    Args:
        project_id: project ID or project number of the Cloud project you want to use.
        region: name of the region hosting the jobs.

    Returns:
        An iterable collection of Job object.
    """
    client = batch_v1.BatchServiceClient()

    return client.list_jobs(parent=f"projects/{project_id}/locations/{region}")

C++

Si deseas obtener más información, consulta la documentación de referencia de la API de Batch C++.

#include "google/cloud/batch/v1/batch_client.h"

  [](std::string const& project_id, std::string const& location_id) {
    auto const parent = "projects/" + project_id + "/locations/" + location_id;
    // Initialize a client and issue the request.
    auto client = google::cloud::batch_v1::BatchServiceClient(
        google::cloud::batch_v1::MakeBatchServiceConnection());
    int i = 0;
    for (auto job : client.ListJobs(parent)) {
      if (!job) throw std::move(job).status();
      std::cout << "Job[" << i++ << "]  " << job->DebugString() << "\n";
    }
  }

Consulta los detalles de un trabajo

Puedes ver los detalles de un trabajo en el proyecto actual con la consola de Google Cloud, gcloud CLI, la API de Batch, Go, Java, Node.js, Python o C++.

Console

Para ver los detalles de un trabajo en el proyecto actual con la consola de Google Cloud, sigue estos pasos:

En la consola de Google Cloud, ve a la página Lista de trabajos.

Ir a Lista de trabajos
En la columna Nombre del trabajo, haz clic en el nombre de un trabajo.

Se abrirá la página Detalles del trabajo.

La pestaña Detalles se abre de forma predeterminada. Para obtener más información, haz clic en otras pestañas.

gcloud

Para ver los detalles de un trabajo en el proyecto actual con la gcloud CLId, usa el comando gcloud batch jobs describe con la marca --location.

gcloud batch jobs describe JOB_NAME \
    --location=LOCATION

Reemplaza lo siguiente:

JOB_NAME: Es el nombre de un trabajo existente.
LOCATION: Es la ubicación en la que existe el trabajo.

API

Para ver los detalles de un trabajo en el proyecto actual con la API de Batch, realiza una solicitud GET al método jobs.get.

GET https://batch.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/jobs/JOB_NAME

Reemplaza lo siguiente:

PROJECT_ID: Es el ID del proyecto actual.
LOCATION: Es la ubicación en la que existe el trabajo.
JOB_NAME: Es el nombre de un trabajo existente.

Go

Si deseas obtener más información, consulta la documentación de referencia de la API de Batch Go.

import (
	"context"
	"fmt"
	"io"

	batch "cloud.google.com/go/batch/apiv1"
	"cloud.google.com/go/batch/apiv1/batchpb"
)

// Retrieves the information about the specified job, most importantly its status
func getJob(w io.Writer, projectID, region, jobName string) (*batchpb.Job, error) {
	// projectID := "your_project_id"
	// region := "us-central1"
	// jobName := "some-job"

	ctx := context.Background()
	batchClient, err := batch.NewClient(ctx)
	if err != nil {
		return nil, fmt.Errorf("NewClient: %w", err)
	}
	defer batchClient.Close()

	req := &batchpb.GetJobRequest{
		Name: fmt.Sprintf("projects/%s/locations/%s/jobs/%s", projectID, region, jobName),
	}

	response, err := batchClient.GetJob(ctx, req)
	if err != nil {
		return nil, fmt.Errorf("unable to get job: %w", err)
	}

	fmt.Fprintf(w, "Job info: %v\n", response)

	return response, nil
}

Java

Si deseas obtener más información, consulta la documentación de referencia de la API de Batch Java.

import com.google.cloud.batch.v1.BatchServiceClient;
import com.google.cloud.batch.v1.Job;
import com.google.cloud.batch.v1.JobName;
import java.io.IOException;

public class GetJob {

  public static void main(String[] args) throws IOException {
    // TODO(developer): Replace these variables before running the sample.
    // Project ID or project number of the Cloud project you want to use.
    String projectId = "YOUR_PROJECT_ID";

    // Name of the region hosts the job.
    String region = "europe-central2";

    // The name of the job you want to retrieve information about.
    String jobName = "JOB_NAME";

    getJob(projectId, region, jobName);
  }

  // Retrieve information about a Batch Job.
  public static void getJob(String projectId, String region, String jobName) throws IOException {
    // Initialize client that will be used to send requests. This client only needs to be created
    // once, and can be reused for multiple requests. After completing all of your requests, call
    // the `batchServiceClient.close()` method on the client to safely
    // clean up any remaining background resources.
    try (BatchServiceClient batchServiceClient = BatchServiceClient.create()) {

      Job job =
          batchServiceClient.getJob(
              JobName.newBuilder()
                  .setProject(projectId)
                  .setLocation(region)
                  .setJob(jobName)
                  .build());

      System.out.printf("Retrieved the job: %s ", job.getName());
    }
  }
}

Node.js

Si deseas obtener más información, consulta la documentación de referencia de la API de Batch Node.js.

/**
 * TODO(developer): Uncomment and replace these variables before running the sample.
 */
// const projectId = 'YOUR_PROJECT_ID';
/**
 * The region that hosts the job.
 */
// const region = 'us-central-1';
/**
 * The name of the job you want to retrieve information about.
 */
// const jobName = 'YOUR_JOB_NAME';

// Imports the Batch library
const batchLib = require('@google-cloud/batch');

// Instantiates a client
const batchClient = new batchLib.v1.BatchServiceClient();

async function callGetJob() {
  // Construct request
  const request = {
    name: `projects/${projectId}/locations/${region}/jobs/${jobName}`,
  };

  // Run request
  const response = await batchClient.getJob(request);
  console.log(response);
}

callGetJob();

Python

Si deseas obtener más información, consulta la documentación de referencia de la API de Batch Python.


from google.cloud import batch_v1

def get_job(project_id: str, region: str, job_name: str) -> batch_v1.Job:
    """
    Retrieve information about a Batch Job.

    Args:
        project_id: project ID or project number of the Cloud project you want to use.
        region: name of the region hosts the job.
        job_name: the name of the job you want to retrieve information about.

    Returns:
        A Job object representing the specified job.
    """
    client = batch_v1.BatchServiceClient()

    return client.get_job(
        name=f"projects/{project_id}/locations/{region}/jobs/{job_name}"
    )

C++

Si deseas obtener más información, consulta la documentación de referencia de la API de Batch C++.

#include "google/cloud/batch/v1/batch_client.h"

  [](std::string const& project_id, std::string const& location_id,
     std::string const& job_id) {
    auto const name = "projects/" + project_id + "/locations/" + location_id +
                      "/jobs/" + job_id;
    // Initialize a client and issue the request.
    auto client = google::cloud::batch_v1::BatchServiceClient(
        google::cloud::batch_v1::MakeBatchServiceConnection());
    auto response = client.GetJob(name);
    if (!response) throw std::move(response).status();
    std::cout << "GetJob() succeeded with " << response->DebugString() << "\n";
  }

Ve las tareas

Para ver las tareas de uno de tus trabajos, selecciona uno de los siguientes métodos:

Para ver todas las tareas de un trabajo o de un grupo de tareas de un trabajo, consulta una lista de las tareas de un trabajo.
Para ver todos los detalles de configuración de una tarea específica, consulta los detalles de una tarea.

Consulta la lista de tareas de un trabajo

Puedes ver una lista de las tareas en un trabajo o en un grupo de tareas de un trabajo con la consola de Google Cloud, gcloud CLI, la API de Batch, Go, Java, Node.js, Python o C++.

Si deseas filtrar una lista de tareas en un trabajo o en un grupo de tareas de un trabajo (por ejemplo, para solo enumerar las tareas que terminaron de ejecutarse correctamente), debes usar gcloud CLI o la API de Batch.

Console

Si deseas ver un resumen de las tareas de un trabajo con la consola de Google Cloud, consulta los detalles de un trabajo para abrir la página Detalles del trabajo. Luego, consulta la sección Detalles de la tarea.

gcloud

Para ver una lista de las tareas en el grupo de tareas de un trabajo con la gcloud CLI, usa el comando gcloud batch tasks list con las siguientes marcas:

gcloud batch tasks list \
    --job=JOB_NAME \
    --location=LOCATION

Reemplaza lo siguiente:

JOB_NAME: Es el nombre de un trabajo existente.
LOCATION: Es la ubicación en la que existe el trabajo.

De manera opcional, puedes agregar la marca --filter para ver una lista filtrada de tareas en el grupo de tareas de un trabajo en función de una expresión de filtro.

Por ejemplo, usa el siguiente comando:

gcloud batch tasks list \
    --job=example-job \
    --location=us-central1 \
    --filter="FILTER_EXPRESSION"

Reemplaza FILTER_EXPRESSION por una expresión de filtro.

Por ejemplo, puedes especificar la siguiente expresión de filtro para ver solo las tareas del grupo de tareas de un trabajo que están en ejecución o que terminaron de ejecutarse correctamente:

STATE=RUNNING OR STATE=SUCCEEDED

API

Para ver una lista de tareas en el grupo de tareas de un trabajo con la API de Batch, realiza una solicitud GET al método tasks.list:

GET https://batch.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/jobs/JOB_NAME/taskGroups/TASK_GROUP_NAME/tasks

Reemplaza lo siguiente:

PROJECT_ID: Es el ID del proyecto actual.
LOCATION: Es la ubicación en la que existe el trabajo.
JOB_NAME: Es el nombre de un trabajo existente.
TASK_GROUP_NAME: Es el nombre del grupo de tareas del que deseas ver los detalles. El valor se debe establecer en group0.

De manera opcional, puedes especificar el parámetro de consulta filter para ver una lista filtrada de tareas en el grupo de tareas de un trabajo en función de una expresión de filtro.

Por ejemplo, realiza la siguiente solicitud GET:

GET https://batch.googleapis.com/v1/projects/example-project/locations/us-central1/jobs/example-job/taskGroups/group0/tasks?filter=FILTER_EXPRESSION

Reemplaza FILTER_EXPRESSION por una expresión de filtro que use codificación URL.

Por ejemplo, puedes especificar la siguiente expresión de filtro para ver solo las tareas del grupo de tareas de un trabajo que están en ejecución o que terminaron de ejecutarse correctamente:

STATE=RUNNING%20OR%20STATE=SUCCEEDED

Ten en cuenta que la expresión de filtro codificada con URL representa la siguiente expresión de filtro decodificada:

STATE=RUNNING OR STATE=SUCCEEDED

Go

Si deseas obtener más información, consulta la documentación de referencia de la API de Batch Go.

import (
	"context"
	"fmt"
	"io"

	batch "cloud.google.com/go/batch/apiv1"
	"cloud.google.com/go/batch/apiv1/batchpb"
	"google.golang.org/api/iterator"
)

// Lists all tasks in the given project and region
func listTasks(w io.Writer, projectID, region, jobName, taskGroup string) error {
	// projectID := "your_project_id"
	// region := "us-central1"
	// jobName := "some-job"
	// taskGroup := "group0" // defaults to "group0" on job creation unless overridden

	ctx := context.Background()
	batchClient, err := batch.NewClient(ctx)
	if err != nil {
		return fmt.Errorf("NewClient: %w", err)
	}
	defer batchClient.Close()

	req := &batchpb.ListTasksRequest{
		Parent: fmt.Sprintf("projects/%s/locations/%s/jobs/%s/taskGroups/%s", projectID, region, jobName, taskGroup),
	}

	var tasks []*batchpb.Task
	it := batchClient.ListTasks(ctx, req)

	for {
		task, err := it.Next()
		if err == iterator.Done {
			break
		}
		if err != nil {
			return fmt.Errorf("unable to list tasks: %w", err)
		}
		tasks = append(tasks, task)
	}

	fmt.Fprintf(w, "Tasks: %v\n", tasks)

	return nil
}

Java

Si deseas obtener más información, consulta la documentación de referencia de la API de Batch Java.

import com.google.cloud.batch.v1.BatchServiceClient;
import com.google.cloud.batch.v1.Task;
import java.io.IOException;

public class ListTasks {

  public static void main(String[] args) throws IOException {
    // TODO(developer): Replace these variables before running the sample.
    // Project ID or project number of the Cloud project you want to use.
    String projectId = "YOUR_PROJECT_ID";
    // Name of the region hosts the job.
    String region = "europe-central2";
    // Name of the job which tasks you want to list.
    String jobName = "JOB_NAME";
    // Name of the group of tasks. Usually it's `group0`.
    String groupName = "group0";

    listTasks(projectId, region, jobName, groupName);
  }

  // Get a list of all jobs defined in given region.
  public static void listTasks(String projectId, String region, String jobName, String groupName)
      throws IOException {
    // Initialize client that will be used to send requests. This client only needs to be created
    // once, and can be reused for multiple requests. After completing all of your requests, call
    // the `batchServiceClient.close()` method on the client to safely
    // clean up any remaining background resources.
    try (BatchServiceClient batchServiceClient = BatchServiceClient.create()) {

      String parent = String.format("projects/%s/locations/%s/jobs/%s/taskGroups/%s", projectId,
          region, jobName, groupName);
      for (Task task : batchServiceClient.listTasks(parent).iterateAll()) {
        System.out.println(task.getName());
      }
    }
  }
}

Node.js

Si deseas obtener más información, consulta la documentación de referencia de la API de Batch Node.js.

/**
 * TODO(developer): Uncomment and replace these variables before running the sample.
 */
// const projectId = 'YOUR_PROJECT_ID';
/**
 * The region that hosts the job.
 */
// const region = 'us-central-1';
/**
 * The name of the job which tasks you want to list.
 */
// const jobName = 'YOUR_JOB_NAME';
/**
 * The name of the group of tasks. Usually it's `group0`.
 */
// const groupName = 'group0';

// Imports the Batch library
const batchLib = require('@google-cloud/batch');

// Instantiates a client
const batchClient = new batchLib.v1.BatchServiceClient();

async function callListTasks() {
  // Construct request
  const request = {
    parent: `projects/${projectId}/locations/${region}/jobs/${jobName}/taskGroups/${groupName}`,
  };

  // Run request
  const iterable = await batchClient.listTasksAsync(request);
  for await (const response of iterable) {
    console.log(response);
  }
}

callListTasks();

Python

Si deseas obtener más información, consulta la documentación de referencia de la API de Batch Python.

from __future__ import annotations

from collections.abc import Iterable

from google.cloud import batch_v1

def list_tasks(
    project_id: str, region: str, job_name: str, group_name: str
) -> Iterable[batch_v1.Task]:
    """
    Get a list of all jobs defined in given region.

    Args:
        project_id: project ID or project number of the Cloud project you want to use.
        region: name of the region hosting the jobs.
        job_name: name of the job which tasks you want to list.
        group_name: name of the group of tasks. Usually it's `group0`.

    Returns:
        An iterable collection of Task objects.
    """
    client = batch_v1.BatchServiceClient()

    return client.list_tasks(
        parent=f"projects/{project_id}/locations/{region}/jobs/{job_name}/taskGroups/{group_name}"
    )

C++

Si deseas obtener más información, consulta la documentación de referencia de la API de Batch C++.

#include "google/cloud/batch/v1/batch_client.h"

  [](std::string const& project_id, std::string const& location_id,
     std::string const& job_id, std::string const& group_id) {
    auto const parent = "projects/" + project_id + "/locations/" + location_id +
                        "/jobs/" + job_id + "/taskGroups/" + group_id;
    // Initialize a client and issue the request.
    auto client = google::cloud::batch_v1::BatchServiceClient(
        google::cloud::batch_v1::MakeBatchServiceConnection());
    int i = 0;
    for (auto task : client.ListTasks(parent)) {
      if (!task) throw std::move(task).status();
      std::cout << "Task[" << i++ << "]  " << task->DebugString() << "\n";
    }
  }

Cómo ver los detalles de una tarea

Puedes ver los detalles de una tarea con la consola de Google Cloud, gcloud CLI, la API de Batch, Go, Java, Node.js, Python o C++.

Console

Si deseas ver los detalles de una tarea con la consola de Google Cloud, consulta los detalles de un trabajo para abrir la página Detalles del trabajo. Luego, consulta la sección Detalles de la tarea.

gcloud

Para ver los detalles de una tarea con gcloud CLI, usa el comando gcloud batch tasks describe con las siguientes marcas:

gcloud batch tasks describe TASK_INDEX \
  --location=LOCATION \
  --job=JOB_NAME \
  --task_group=TASK_GROUP_NAME

Reemplaza lo siguiente:

TASK_INDEX: Es el índice de la tarea de la que deseas ver los detalles. En un grupo de tareas, el índice de tareas comienza en 0 para la primera tarea y aumenta en 1 con cada tarea adicional. Por ejemplo, un grupo de tareas que contiene cuatro tareas tiene los índices 0, 1, 2 y 3.
TASK_GROUP_NAME: Es el nombre del grupo de tareas que contiene la tarea de la que deseas ver los detalles. El valor se debe establecer en group0.
JOB_NAME: Es el nombre de un trabajo existente.
LOCATION: Es la ubicación en la que existe el trabajo.

API

Para ver los detalles de una tarea con la API de Batch, realiza una solicitud GET al método tasks.get:

GET https://batch.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/jobs/JOB_NAME/taskGroups/TASK_GROUP_NAME/tasks/TASK_INDEX

Reemplaza lo siguiente:

PROJECT_ID: Es el ID del proyecto actual.
LOCATION: Es la ubicación en la que existe el trabajo.
JOB_NAME: Es el nombre de un trabajo existente.
TASK_GROUP_NAME: Es el nombre del grupo de tareas que contiene la tarea de la que deseas ver los detalles. El valor se debe establecer en group0.
TASK_INDEX: Es el índice de la tarea de la que deseas ver los detalles. En un grupo de tareas, el índice de tareas comienza en 0 para la primera tarea y aumenta en 1 con cada tarea adicional. Por ejemplo, un grupo de tareas que contiene cuatro tareas tiene los índices 0, 1, 2, y 3.

Go

Si deseas obtener más información, consulta la documentación de referencia de la API de Batch Go.

import (
	"context"
	"fmt"
	"io"

	batch "cloud.google.com/go/batch/apiv1"
	"cloud.google.com/go/batch/apiv1/batchpb"
)

// Retrieves the information about the specified job, most importantly its status
func getTask(w io.Writer, projectID, region, jobName, taskGroup string, taskNumber int32) error {
	// projectID := "your_project_id"
	// region := "us-central1"
	// jobName := "some-job"
	// taskGroup := "group0" // defaults to "group0" on job creation unless overridden
	// taskNumber := 0

	ctx := context.Background()
	batchClient, err := batch.NewClient(ctx)
	if err != nil {
		return fmt.Errorf("NewClient: %w", err)
	}
	defer batchClient.Close()

	req := &batchpb.GetTaskRequest{
		Name: fmt.Sprintf("projects/%s/locations/%s/jobs/%s/taskGroups/%s/tasks/%d",
			projectID, region, jobName, taskGroup, taskNumber),
	}

	response, err := batchClient.GetTask(ctx, req)
	if err != nil {
		return fmt.Errorf("unable to get task: %w", err)
	}

	fmt.Fprintf(w, "Task info: %v\n", response)

	return nil
}

Java

Si deseas obtener más información, consulta la documentación de referencia de la API de Batch Java.

import com.google.cloud.batch.v1.BatchServiceClient;
import com.google.cloud.batch.v1.Task;
import com.google.cloud.batch.v1.TaskName;
import java.io.IOException;

public class GetTask {

  public static void main(String[] args) throws IOException {
    // TODO(developer): Replace these variables before running the sample.
    // Project ID or project number of the Cloud project you want to use.
    String projectId = "YOUR_PROJECT_ID";
    // Name of the region hosts the job.
    String region = "europe-central2";
    // The name of the job you want to retrieve information about.
    String jobName = "JOB_NAME";
    // The name of the group that owns the task you want to check. Usually it's `group0`.
    String groupName = "group0";
    // Number of the task you want to look up.
    int taskNumber = 0;

    getTask(projectId, region, jobName, groupName, taskNumber);
  }

  // Retrieve information about a Task.
  public static void getTask(String projectId, String region, String jobName, String groupName,
      int taskNumber) throws IOException {
    // Initialize client that will be used to send requests. This client only needs to be created
    // once, and can be reused for multiple requests. After completing all of your requests, call
    // the `batchServiceClient.close()` method on the client to safely
    // clean up any remaining background resources.
    try (BatchServiceClient batchServiceClient = BatchServiceClient.create()) {

      Task task = batchServiceClient.getTask(TaskName.newBuilder()
          .setProject(projectId)
          .setLocation(region)
          .setJob(jobName)
          .setTaskGroup(groupName)
          .setTask(String.valueOf(taskNumber))
          .build());
      System.out.printf("Retrieved task information: %s", task.getName());
    }
  }
}

Node.js

Si deseas obtener más información, consulta la documentación de referencia de la API de Batch Node.js.

/**
 * TODO(developer): Uncomment and replace these variables before running the sample.
 */
// const projectId = 'YOUR_PROJECT_ID';
/**
 * The region that hosts the job.
 */
// const region = 'us-central-1';
/**
 * The name of the job you want to retrieve information about.
 */
// const jobName = 'YOUR_JOB_NAME';
/**
 * The name of the group that owns the task you want to check.
 * Usually it's `group0`.
 */
// const groupName = 'group0';
/**
 * The number of the task you want to look up.
 */
// const taskNumber = 0;

// Imports the Batch library
const batchLib = require('@google-cloud/batch');

// Instantiates a client
const batchClient = new batchLib.v1.BatchServiceClient();

async function callGetJob() {
  // Construct request
  const request = {
    name:
      `projects/${projectId}/locations/${region}/jobs/${jobName}` +
      `/taskGroups/${groupName}/tasks/${taskNumber}`,
  };

  // Run request
  const response = await batchClient.getTask(request);
  console.log(response);
}

callGetJob();

Python

Si deseas obtener más información, consulta la documentación de referencia de la API de Batch Python.


from google.cloud import batch_v1

def get_task(
    project_id: str, region: str, job_name: str, group_name: str, task_number: int
) -> batch_v1.Task:
    """
    Retrieve information about a Task.

    Args:
        project_id: project ID or project number of the Cloud project you want to use.
        region: name of the region hosts the job.
        job_name: the name of the job you want to retrieve information about.
        group_name: the name of the group that owns the task you want to check. Usually it's `group0`.
        task_number: number of the task you want to look up.

    Returns:
        A Task object representing the specified task.
    """
    client = batch_v1.BatchServiceClient()

    return client.get_task(
        name=f"projects/{project_id}/locations/{region}/jobs/{job_name}"
        f"/taskGroups/{group_name}/tasks/{task_number}"
    )

C++

Si deseas obtener más información, consulta la documentación de referencia de la API de Batch C++.

#include "google/cloud/batch/v1/batch_client.h"

  [](std::string const& project_id, std::string const& location_id,
     std::string const& job_id, std::string const& group_id,
     std::string const& task_number) {
    auto const name = "projects/" + project_id + "/locations/" + location_id +
                      "/jobs/" + job_id + "/taskGroups/" + group_id +
                      "/tasks/" + task_number;
    // Initialize a client and issue the request.
    auto client = google::cloud::batch_v1::BatchServiceClient(
        google::cloud::batch_v1::MakeBatchServiceConnection());
    auto response = client.GetTask(name);
    if (!response) throw std::move(response).status();
    std::cout << "GetTask() succeeded with " << response->DebugString() << "\n";
  }

¿Qué sigue?

Aprende a supervisar y analizar trabajos:
- Ver el historial de eventos de estado de un trabajo.
- Si configuraste registros para un trabajo, puedes analizar un trabajo mediante registros.
- Si configuraste notificaciones de estado, puedes supervisar un trabajo con las notificaciones de Pub/Sub y analizar las notificaciones con BigQuery.
Aprende a organizar recursos mediante etiquetas.
Obtén más información sobre cómo borrar y exportar trabajos.

Ver trabajos y tareas

Antes de comenzar

Ver tus empleos

Cómo ver una lista de tus trabajos

Console

gcloud

Ver todos los trabajos

Consulta una lista filtrada de trabajos

API

Ver todos los trabajos

Consulta una lista filtrada de trabajos

Go

Go

Java

Java

Node.js

Node.js

Python

Python

C++

C++

Consulta los detalles de un trabajo

Console

gcloud

API

Go

Go

Java

Java

Node.js

Node.js

Python

Python

C++

C++

Ve las tareas

Consulta la lista de tareas de un trabajo

Console

gcloud

API

Go

Go

Java

Java

Node.js

Node.js

Python

Python

C++

C++

Cómo ver los detalles de una tarea

Console

gcloud

API

Go

Go

Java

Java

Node.js

Node.js

Python

Python

C++

C++

¿Qué sigue?