getSoftDeletePolicy.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
 *
 *      http://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.
 */

function main(bucketName = 'my-bucket') {
  // [START storage_get_soft_delete_policy]
  /**
   * TODO(developer): Uncomment the following lines before running the sample.
   */
  // The ID of your GCS bucket
  // const bucketName = 'your-unique-bucket-name';

  // Imports the Google Cloud client library
  const {Storage} = require('@google-cloud/storage');

  // Creates a client
  const storage = new Storage();

  async function getSoftDeletePolicy() {
    const [metadata] = await storage.bucket(bucketName).getMetadata();

    const softDelete = metadata.softDeletePolicy;
    if (
      !softDelete ||
      !softDelete.retentionDurationSeconds ||
      softDelete.retentionDurationSeconds === '0'
    ) {
      console.log(`Bucket ${metadata.name} soft delete policy was disabled`);
    } else {
      console.log(`Soft delete policy for ${metadata.name}`);
      console.log(
        `Soft delete Period: ${softDelete.retentionDurationSeconds} seconds`
      );
      if (softDelete.effectiveTime) {
        console.log(`Effective Time: ${softDelete.effectiveTime}`);
      }
    }
  }

  getSoftDeletePolicy().catch(console.error);
  // [END storage_get_soft_delete_policy]
}

main(...process.argv.slice(2));