Cloud Storage Client Library for Node.js

Use these samples to manage event notifications and client-side retry logic:

• Create Notification: Set up notifications for bucket events.
• Delete Notification: Remove an existing notification.
• Configure Retries: Customize the retry configuration for client requests.

Usage Examples:

node samples/createNotification.js
node samples/configureRetries.js

Before using the Node.js client library, ensure you have completed the following setup steps:

1. Project Setup: Select or create a Google Cloud Platform project.
2. Billing: Enable billing for your project.
3. API Activation: Enable the Google Cloud Storage API in the Google Cloud Console.
4. Authentication: Set up authentication (such as Application Default Credentials or a Service Account key) to allow your local workstation or environment to access the API.

Samples for creating buckets with various advanced configurations:

• Create New Bucket: Standard bucket creation.
• Create Bucket With Storage Class and Location: Create a bucket with a specific storage class and geographic location.
• Create a Dual-Region Bucket: Create a bucket spanning two specific regions.
• Create Bucket With Turbo Replication: Enable turbo replication for faster cross-region replication.
• Create a hierarchical namespace enabled bucket: Enable hierarchical namespace features.
• Create a Bucket with object retention enabled: Enable object retention policies.

Usage Examples:

# Create with storage class and location
node createBucketWithStorageClassAndLocation.js <BUCKET_NAME> <CLASS_NAME> <LOCATION>

# Create dual-region bucket
node createBucketWithDualRegion.js <BUCKET_NAME> <LOCATION> <REGION1> <REGION2>

The library allows you to inspect the state and metadata of buckets and files. You can retrieve:

• File Metadata: Get metadata for specific objects, including custom metadata and notifications.
• Bucket Status: Check Requester Pays status, Uniform Bucket Level Access, and Public Access Prevention.
• Policies: Retrieve Retention Policies, Soft Delete Policies, and Default Event Based Hold settings.
• Other: Get Autoclass settings, RPO, and Service Account information.

<!-- See individual sample files for specific implementations -->
// Get Metadata: samples/getMetadata.js
// Get Requester Pays Status: samples/getRequesterPaysStatus.js
// Get Soft Delete Policy: samples/getSoftDeletePolicy.js
// Get Retention Policy: samples/getRetentionPolicy.js

To run the provided code samples for the Google Cloud Storage Node.js client, you must first ensure you have followed the setup instructions in the main repository's Using the client library guide. Once the environment is configured, navigate to the samples directory and install the necessary dependencies.

Follow these steps in your terminal:

1. Navigate to the samples directory: cd samples
2. Install dependencies: npm install
3. Return to the root directory: cd ..

The @google-cloud/storage-samples repository provides a wide range of practical examples for interacting with Google Cloud Storage using the Node.js client library. These samples cover common tasks such as file uploads, downloads, security configurations, and bucket management.

Key categories of samples include:

• File Operations: Uploading files (from memory, in chunks, or via Transfer Manager), renaming files, streaming downloads/uploads, and managing encrypted files.
• Bucket & Policy Management: Setting retention policies, soft delete policies, Autoclass, and Public Access Prevention.
• Security & Access Control: Managing IAM members, setting event-based holds, temporary holds, and rotating encryption keys.
• Advanced Features: Using the Transfer Manager for bulk operations, managing KMS keys, and restoring soft-deleted buckets or objects.

The @google-cloud/storage client library is compatible with all current active and maintenance versions of Node.js.

If you are using an end-of-life version of Node.js, it is recommended to update to an actively supported LTS version. While legacy versions are supported on a best-efforts basis, they are not tested in continuous integration, may lack security patches/features, and cannot have up-to-date dependencies.

The following samples demonstrate how to manage permissions for Google Cloud Storage buckets and files using Access Control Lists (ACL) and Identity and Access Management (IAM):

• Add Bucket Conditional Binding: Apply IAM bindings with conditions.
• Add Bucket Default Owner Acl: Set default owner ACLs for a bucket.
• Add Bucket Iam Member: Add an IAM member to a bucket.
• Add Bucket Owner Acl: Add an owner ACL to a bucket.
• Add File Owner Acl: Add an owner ACL to a specific file.

Run these samples using node with the corresponding script path.

node samples/addBucketIamMember.js
node samples/addBucketOwnerAcl.js
node samples/addFileOwnerAcl.js