ジョブとタスクを表示する

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

このページでは、Batch ジョブとそのタスクの表示方法について説明します。

始める前に

  • Batch を初めて使用する場合は、Batch のスタートガイドを確認し、プロジェクトとユーザーの前提条件を完了して Batch を有効にします。
  • ジョブとタスクを表示するために必要な権限を取得するには、管理者にバッチジョブ閲覧者(roles/batch.jobsViewer)またはバッチジョブ編集者(roles/batch.jobsEditor)の IAM ロールを付与するよう依頼してください。 ロールの付与の詳細については、アクセスの管理をご覧ください。

ジョブの一覧表示と記述

プロジェクト内のジョブを表示するには、ジョブを一覧表示します。構成の詳細を表示するジョブを記述します。

ジョブのリスト表示

ジョブを一覧表示するには、Google Cloud Console、gcloud CLI、Batch API、Go、Java、Node.js、Python を使用します。

Console

プロジェクトのジョブを一覧表示するには、Google Cloud Console で [ジョブリスト] ページに移動します。

ジョブリストに移動する

gcloud

gcloud CLI を使用してプロジェクトのジョブを一覧表示するには、gcloud batch jobs list コマンドを使用します。

gcloud batch jobs list

API

Batch API を使用して特定のロケーションのプロジェクトのジョブを一覧表示するには、jobs.list メソッドを使用します。

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

以下を置き換えます。

Go

Go

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

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: %v", 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: %v", err)
		}
		jobs = append(jobs, job)
	}

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

	return nil
}

Java

Java

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


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

Node.js

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

/**
 * 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

Python

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

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

ジョブの説明

ジョブの説明には Google Cloud Console、gcloud CLI、Batch API、Go、Java、Node.js、Python を使用できます。

Console

  1. プロジェクトのジョブを一覧表示するには、Google Cloud Console で [ジョブリスト] ページに移動します。

    ジョブリストに移動する

  2. ジョブを説明するには、[ジョブ名] 列でジョブの名前をクリックします。ジョブの詳細ページが開きます。

gcloud

gcloud CLI を使用してジョブを記述するには、gcloud batch jobs describe コマンドを使用します。

gcloud batch jobs describe JOB_NAME --location LOCATION

以下を置き換えます。

API

Batch API を使用してジョブを記述するには、jobs.get メソッドを使用します。

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

以下を置き換えます。

Go

Go

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

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: %v", 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: %v", err)
	}

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

	return response, nil
}

Java

Java

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


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

Node.js

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

/**
 * 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

Python

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


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

タスクの一覧表示と説明

ジョブを一覧表示するか、ジョブのタスクグループのタスクを一覧表示します。 タスクの詳細を表示するタスクを記述します。 ジョブのタスクは、Google Cloud Console、gcloud CLI、Batch API を使用して一覧表示し、説明できます。

Console

Google Cloud Console を使用してジョブのタスクの詳細を表示するには、ジョブを記述して、Job の詳細のページを開いて、タスクの詳細セクションを参照してください。

gcloud

タスクの一覧表示

gcloud CLI を使用してジョブのタスクグループのタスクを一覧表示するには、gcloud batch tasks list コマンドを使用します。

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

以下を置き換えます。

タスクの説明

gcloud CLI を使用してタスクを記述するには、gcloud batch tasks describe コマンドを使用します。

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

以下を置き換えます。

  • TASK_INDEX: 記述するタスクのインデックス。タスクグループ内のタスクのインデックスは 0 から始まり、タスクごとに 1 つずつ増加します。たとえば、4 つのタスクを含むタスクグループのインデックスは、0123 です。
  • TASK_GROUP_NAME: 記述するタスクを含むタスクグループの名前。group0 に設定します。
  • JOB_NAME: ジョブの名前。
  • LOCATION: ジョブのロケーション

API

タスクの一覧表示

Batch API を使用してジョブのタスクグループのタスクを一覧表示するには、tasks.list メソッドを使用します。

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

以下を置き換えます。

  • PROJECT_ID: プロジェクトのプロジェクト ID
  • LOCATION: ジョブのロケーション
  • JOB_NAME: ジョブの名前。
  • TASK_GROUP_NAME: 記述するタスクグループの名前。これを group0 に設定します。

タスクの説明

Batch API を使用してタスクを記述するには、tasks.get メソッドを使用します。

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

以下を置き換えます。

  • PROJECT_ID: プロジェクトのプロジェクト ID
  • LOCATION: ジョブのロケーション
  • JOB_NAME: ジョブの名前。
  • TASK_GROUP_NAME: 記述するタスクを含むタスクグループの名前。group0 に設定します。
  • TASK_INDEX: 記述するタスクのインデックス。タスクグループ内のタスクのインデックスは 0 から始まり、タスクごとに 1 つずつ増加します。たとえば、4 つのタスクを含むタスクグループのインデックスは、0123 です。

次のステップ