getJob.js

// Copyright 2025 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

'use strict';

/**
 * This application demonstrates how to perform basic operations on an Batch Operations
 * instance with the Google Cloud Storage API.
 *
 * For more information, see the documentation at https://cloud.google.com/storage/docs/batch-operations/overview.
 */

function main(projectId, jobId) {
  // [START storage_batch_get_job]
  /**
   * Retrieves details of a specific batch job instance.
   *
   * This operation is used to retrieve the detailed current state, execution status,
   * and original configuration of a specific Batch Operation job that was previously
   * created for a Google Cloud Storage bucket.
   *
   * @param {string} projectId Your Google Cloud project ID.
   * Example: 'my-project-id'
   * @param {string} jobId A unique identifier for this job.
   * Example: '94d60cc1-2d95-41c5-b6e3-ff66cd3532d5'
   */

  // Imports the Control library
  const {StorageBatchOperationsClient} =
    require('@google-cloud/storagebatchoperations').v1;

  // Instantiates a client
  const client = new StorageBatchOperationsClient();

  async function getJob() {
    const name = client.jobPath(projectId, 'global', jobId);

    // Create the request
    const request = {
      name,
    };

    try {
      // Run request
      const [response] = await client.getJob(request);
      console.log(`Batch job details for '${jobId}':`);
      console.log(`  Name: ${response.name}`);
      console.log(`  State: ${response.state}`);
      console.log(
        `  Create Time: ${new Date(response.createTime.seconds * 1000).toISOString()}`
      );
    } catch (error) {
      console.error(
        `Error retrieving batch jobs for jobId ${jobId}:`,
        error.message
      );

      if (error.code === 5) {
        // NOT_FOUND (gRPC code 5) error can occur if the batch job does not exist.
        console.error(
          `Ensure the job '${jobId}' exists in project '${projectId}'.`
        );
      }
      throw error;
    }
  }

  getJob();
  // [END storage_batch_get_job]
}

process.on('unhandledRejection', err => {
  console.error(err.message);
  process.exitCode = 1;
});
main(...process.argv.slice(2));