ジョブの削除

このページでは、Batch ジョブを削除する方法について説明します。

始める前に

バッチを以前に使用したことがなかった場合は、バッチを開始するを確認し、プロジェクトとユーザーの前提条件を完了してバッチを有効にします。
ジョブの削除に必要な権限を取得するには、管理者にプロジェクトのバッチジョブ編集者（roles/batch.jobsEditor）の IAM ロールを付与するように依頼してください。ロールの付与の詳細については、アクセス権の管理をご覧ください。

必要な権限は、カスタムロールや他の事前定義ロールから取得することもできます。

ジョブの削除

プロジェクトのジョブリストからジョブを削除する準備ができていて、ジョブの履歴が不要になった場合は、ジョブを削除します。ジョブの前または実行中にジョブを削除すると、そのジョブはキャンセルされます。

Google Cloud Console、gcloud CLI、Batch API、Go、Java、Node.js、Python を使用してジョブを削除できます。

Console

Google Cloud Console を使用してジョブを削除するには、次のようにします。

Google Cloud Console で、[ジョブリスト] ページに移動します。

ジョブリストに移動する
作成したジョブの名前をクリックします。ジョブの詳細ページが開きます。
[削除] をクリックします。
[Delete batch job?] ダイアログで、フィールドに「Delete」と入力します。
[削除] をクリックします。

ジョブが削除されたことが [ジョブリスト] ページに表示されます。

gcloud

gcloud CLI を使用してジョブを削除するには、gcloud batch jobs delete コマンドを使用します。

gcloud batch jobs delete JOB_NAME --location LOCATION

以下を置き換えます。

JOB_NAME: ジョブの名前。
LOCATION: ジョブのロケーション。

API

Batch API を使用してジョブを削除するには、jobs.delete メソッドを使用します。

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

以下を置き換えます。

PROJECT_ID: プロジェクトのプロジェクト ID
LOCATION: ジョブのロケーション。
JOB_NAME: ジョブの名前。

Go

詳細については、Batch Go API のリファレンスドキュメントをご覧ください。

Batch への認証を行うには、アプリケーションのデフォルト認証情報を設定します。詳細については、ローカル開発環境の認証の設定をご覧ください。

GitHub で表示フィードバック

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

詳細については、Batch Java API のリファレンスドキュメントをご覧ください。

GitHub で表示フィードバック


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

詳細については、Batch Node.js API のリファレンスドキュメントをご覧ください。

GitHub で表示フィードバック

/**
 * 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);
}

callDeleteJob();

Python

詳細については、Batch Python API のリファレンスドキュメントをご覧ください。

GitHub で表示フィードバック

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}")

次のステップ

別のジョブを作成します。
ジョブの作成の詳細:
- チュートリアル: ワークフローを使用して Batch ジョブを実行する。
- その他の Batch コードサンプルについては、GitHub をご覧ください。