Excluir jobs

Esta página descreve quando e como excluir jobs do Batch.

Quando um job é excluído, os detalhes e o histórico dele que aparecem quando você visualiza um job e as tarefas dele são removidos do Batch. Se você quiser remover todas as informações e recursos associados a um job, também será necessário excluir itens de outros Google Cloud produtos ativados, como tópicos do Pub/Sub, tabelas do BigQuery ou registros do Cloud Logging.

Google Cloud exclui automaticamente um job 60 dias após ele ser cancelado, bem-sucedido ou falhar. Antes que um job seja excluído automaticamente, você pode fazer uma das seguintes ações:

  • Exportar informações do job: se você quiser manter as informações do job por mais de 60 dias, exporte as informações do job para o BigQuery usando o Workflows. Para mais informações, consulte Exportar informações do job.

  • Excluir um job: conforme explicado neste documento, você pode excluir um job manualmente quando estiver pronto para removê-lo da lista de jobs do projeto e não precisar mais do histórico do job. Se você excluir um job antes ou durante a execução, ele será cancelado e excluído.

Antes de começar

  1. Se você nunca usou o Batch, consulte Introdução ao Batch e ative o Batch concluindo os pré-requisitos para projetos e usuários.

  2. Para conseguir as permissões necessárias para excluir um job, peça ao administrador que conceda a você o papel do IAM Editor de jobs do Batch (roles/batch.jobsEditor) no projeto. Para mais informações sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.

    Também é possível conseguir as permissões necessárias com papéis personalizados ou outros papéis predefinidos.

Excluir um job

É possível excluir um job usando o Google Cloud console, a CLI gcloud, a API Batch, Go, Java, Node.js, Python ou C++.

Console

Para excluir um job usando o Google Cloud console, faça o seguinte:

  1. No Google Cloud console, acesse a página Lista de jobs.

    Acessar a lista de jobs

  2. Clique no nome do job criado. A página Detalhes do job será aberta.

  3. Clique em Excluir.

  4. Na caixa de diálogo Excluir job em lote?, no campo, digite Delete.

  5. Clique em Excluir.

    A página Lista de jobs mostra que o job foi excluído.

gcloud

Para excluir um job usando a CLI gcloud, use o gcloud batch jobs delete comando.

gcloud batch jobs delete JOB_NAME --location LOCATION

Substitua:

  • JOB_NAME: o nome do job.
  • LOCATION: o local do job.

API

Para excluir um job usando a API Batch, use o jobs.delete método:

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

Substitua:

Ir

Go

Para mais informações, consulte a documentação de referência da APIGo Batch.

Para autenticar no Batch, configure o Application Default Credentials. Se quiser mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local. 

import (
	"context"
	"fmt"
	"io"

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

// Deletes the specified job
func deleteJob(w io.Writer, projectID, region, jobName string) error {
	// projectID := "your_project_id"
	// region := "us-central1"
	// jobName := "some-job"

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

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

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

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

	return nil
}

Java

Java

Para mais informações, consulte a API Java Batch documentação de referência.

Para autenticar no Batch, configure o Application Default Credentials. Se quiser mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local. 

import com.google.cloud.batch.v1.BatchServiceClient;
import java.io.IOException;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;

public class DeleteJob {

  public static void main(String[] args)
      throws IOException, ExecutionException, InterruptedException, TimeoutException {
    // 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 that you want to delete.
    String jobName = "JOB_NAME";

    deleteJob(projectId, region, jobName);
  }

  // Triggers the deletion of a Job.
  public static void deleteJob(String projectId, String region, String jobName)
      throws IOException, ExecutionException, InterruptedException, TimeoutException {
    // 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 name = String.format("projects/%s/locations/%s/jobs/%s", projectId, region, jobName);

      batchServiceClient.deleteJobAsync(name).get(5, TimeUnit.MINUTES);
      System.out.printf("Delete the job: %s", jobName);
    }
  }
}

Node.js

Node.js

Para mais informações, consulte a documentação de referência da API Batch Node.js API reference documentation.

Para autenticar no Batch, configure o Application Default Credentials. Se quiser mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local. 

/**
 * 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 delete.
 */
// 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 callDeleteJob() {
  // Construct request
  const request = {
    name: `projects/${projectId}/locations/${region}/jobs/${jobName}`,
  };

  // Run request
  const [operation] = await batchClient.deleteJob(request);
  const [response] = await operation.promise();
  console.log(response);
}

await callDeleteJob();

Python

Python

Para mais informações, consulte a documentação de referência da APIPython Batch.

Para autenticar no Batch, configure o Application Default Credentials. Se quiser mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local. 

from google.api_core.operation import Operation

from google.cloud import batch_v1


def delete_job(project_id: str, region: str, job_name: str) -> Operation:
    """
    Triggers the deletion of a 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 that you want to delete.

    Returns:
        An operation object related to the deletion. You can call `.result()`
        on it to wait for its completion.
    """
    client = batch_v1.BatchServiceClient()

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

C++

C++

Para mais informações, consulte a documentação de referência da API C++Batch.

Para autenticar no Batch, configure o Application Default Credentials. Se quiser mais informações, consulte Configurar a autenticação para um ambiente de desenvolvimento local. 

#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;
    google::cloud::batch::v1::DeleteJobRequest request;
    request.set_name(name);
    // Initialize a client and issue the request.
    auto client = google::cloud::batch_v1::BatchServiceClient(
        google::cloud::batch_v1::MakeBatchServiceConnection());
    auto future = client.DeleteJob(request);
    // Wait until the long-running operation completes.
    auto success = future.get();
    if (!success) throw std::move(success).status();
    std::cout << "Job " << name << " successfully deleted\n";
  }

A seguir