Storage

Storage

ACLs

Cloud Storage uses access control lists (ACLs) to manage object and bucket access. ACLs are the mechanism you use to share files with other users and allow other users to access your buckets and files.

To learn more about ACLs, read this overview on Access Control.

Constructor

new Storage(optionsopt)

Constructs the Storage client.

Parameters:
Name Type Attributes Description
options StorageOptions <optional>

Configuration options.

Source:
See:
Examples
<caption>Create a client that uses Application Default Credentials
(ADC)</caption> const {Storage} = require('@google-cloud/storage'); const
storage = new Storage();

Create a client with explicit credentials

storage');/storage');
const storage = new Storage({
  projectId: 'your-project-id',
  keyFilename: '/path/to/keyfile.json'
});

Members

(static) acl :object

Cloud Storage uses access control lists (ACLs) to manage object and bucket access. ACLs are the mechanism you use to share objects with other users and allow other users to access your buckets and objects.

This object provides constants to refer to the three permission levels that can be granted to an entity:

  • gcs.acl.OWNER_ROLE - ("OWNER")
  • gcs.acl.READER_ROLE - ("READER")
  • gcs.acl.WRITER_ROLE - ("WRITER")
Properties:
Name Type Description
OWNER_ROLE string
READER_ROLE string
WRITER_ROLE string
Source:
See:
Example
const {Storage} = require('@google-cloud/storage');
const storage = new Storage();
const albums = storage.bucket('albums');

//-
// Make all of the files currently in a bucket publicly readable.
//-
const options = {
  entity: 'allUsers',
  role: storage.acl.READER_ROLE
};

albums.acl.add(options, function(err, aclObject) {});

//-
// Make any new objects added to a bucket publicly readable.
//-
albums.acl.default.add(options, function(err, aclObject) {});

//-
// Grant a user ownership permissions to a bucket.
//-
albums.acl.add({
  entity: 'user-useremail@example.com',
  role: storage.acl.OWNER_ROLE
}, function(err, aclObject) {});

//-
// If the callback is omitted, we'll return a Promise.
//-
albums.acl.add(options).then(function(data) {
  const aclObject = data[0];
  const apiResponse = data[1];
});

(static) Bucket :Constructor

Bucket class.

Source:
See:

(static) Channel :Constructor

Channel class.

Source:
See:

(static) File :Constructor

File class.

Source:
See:

(static) HmacKey :Constructor

HmacKey class.

Source:
See:

acl

Reference to Storage.acl.

Source:
See:

Methods

bucket(name, optionsopt) → {Bucket}

Get a reference to a Cloud Storage bucket.

Parameters:
Name Type Attributes Description
name string

Name of the bucket.

options object <optional>

Configuration object.

Properties
Name Type Attributes Description
kmsKeyName string <optional>

A Cloud KMS key that will be used to encrypt objects inserted into this bucket, if no encryption method is specified.

userProject string <optional>

User project to be billed for all requests made from this Bucket object.

Source:
See:
Example
const {Storage} = require('@google-cloud/storage');
const storage = new Storage();
const albums = storage.bucket('albums');
const photos = storage.bucket('photos');

channel(id, resourceId) → {Channel}

Reference a channel to receive notifications about changes to your bucket.

Parameters:
Name Type Description
id string

The ID of the channel.

resourceId string

The resource ID of the channel.

Source:
See:
Example
const {Storage} = require('@google-cloud/storage');
const storage = new Storage();
const channel = storage.channel('id', 'resource-id');

createBucket(name, metadataopt, callbackopt) → {Promise.<CreateBucketResponse>}

Create a bucket.

Cloud Storage uses a flat namespace, so you can't create a bucket with a name that is already in use. For more information, see Bucket Naming Guidelines.

Parameters:
Name Type Attributes Description
name string

Name of the bucket to create.

metadata CreateBucketRequest <optional>

Metadata to set for the bucket.

callback CreateBucketCallback <optional>

Callback function.

Source:
See:
Throws:

If a name is not provided.

Type
Error
Examples
const {Storage} = require('@google-cloud/storage');
const storage = new Storage();
const callback = function(err, bucket, apiResponse) {
  // `bucket` is a Bucket object.
};

storage.createBucket('new-bucket', callback);

//-
// Create a bucket in a specific location and region. <em>See the <a
// href="https://cloud.google.com/storage/docs/json_api/v1/buckets/insert">
// Official JSON API docs</a> for complete details on the `location`
option.
// </em>
//-
const metadata = {
  location: 'US-CENTRAL1',
  regional: true
};

storage.createBucket('new-bucket', metadata, callback);

//-
// Create a bucket with a retention policy of 6 months.
//-
const metadata = {
  retentionPolicy: {
    retentionPeriod: 15780000 // 6 months in seconds.
  }
};

storage.createBucket('new-bucket', metadata, callback);

//-
// Enable versioning on a new bucket.
//-
const metadata = {
  versioning: {
    enabled: true
  }
};

storage.createBucket('new-bucket', metadata, callback);

//-
// If the callback is omitted, we'll return a Promise.
//-
storage.createBucket('new-bucket').then(function(data) {
  const bucket = data[0];
  const apiResponse = data[1];
});

Another example:

  /**
   * TODO(developer): Uncomment the following line before running the sample.
   */
  // const bucketName = 'Name of a bucket, e.g. my-bucket';

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

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

  async function createBucket() {
    // Creates a new bucket in the Asia region with the coldline default storage
    // class. Leave the second argument blank for default settings.
    //
    // For default values see: https://cloud.google.com/storage/docs/locations and
    // https://cloud.google.com/storage/docs/storage-classes

    const [bucket] = await storage.createBucket(bucketName, {
      location: 'ASIA',
      storageClass: 'COLDLINE',
    });

    console.log(`Bucket ${bucket.name} created.`);
  }

  createBucket().catch(console.error);

createHmacKey(serviceAccountEmail, callbackopt) → {Promise.<CreateHmacKeyResponse>}

Create an HMAC key associated with an service account to authenticate requests to the Cloud Storage XML API.

Parameters:
Name Type Attributes Description
serviceAccountEmail string

The service account's email address with which the HMAC key is created for.

callback CreateHmacKeyCallback <optional>

Callback function.

Source:
See:
Example
const {Storage} = require('google-cloud/storage');
const storage = new Storage();

// Replace with your service account's email address
const serviceAccountEmail =
  'my-service-account@appspot.gserviceaccount.com';

storage.createHmacKey(serviceAccountEmail, function(err, hmacKey, secret) {
  if (!err) {
    // Securely store the secret for use with the XML API.
  }
});

//-
// If the callback is omitted, we'll return a Promise.
//-
storage.createHmacKey(serviceAccountEmail)
  .then((response) => {
    const hmacKey = response[0];
    const secret = response[1];
    // Securely store the secret for use with the XML API.
  });

getBuckets(queryopt, callbackopt) → {Promise.<GetBucketsResponse>}

Get Bucket objects for all of the buckets in your project.

Parameters:
Name Type Attributes Description
query GetBucketsRequest <optional>

Query object for listing buckets.

callback GetBucketsCallback <optional>

Callback function.

Source:
See:
Examples
const {Storage} = require('@google-cloud/storage');
const storage = new Storage();
storage.getBuckets(function(err, buckets) {
  if (!err) {
    // buckets is an array of Bucket objects.
  }
});

//-
// To control how many API requests are made and page through the results
// manually, set `autoPaginate` to `false`.
//-
const callback = function(err, buckets, nextQuery, apiResponse) {
  if (nextQuery) {
    // More results exist.
    storage.getBuckets(nextQuery, callback);
  }

  // The `metadata` property is populated for you with the metadata at the
  // time of fetching.
  buckets[0].metadata;

  // However, in cases where you are concerned the metadata could have
  // changed, use the `getMetadata` method.
  buckets[0].getMetadata(function(err, metadata, apiResponse) {});
};

storage.getBuckets({
  autoPaginate: false
}, callback);

//-
// If the callback is omitted, we'll return a Promise.
//-
storage.getBuckets().then(function(data) {
  const buckets = data[0];
});

Another example:

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

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

  async function listBuckets() {
    // Lists all buckets in the current project

    const [buckets] = await storage.getBuckets();
    console.log('Buckets:');
    buckets.forEach(bucket => {
      console.log(bucket.name);
    });
  }

  listBuckets().catch(console.error);

getServiceAccount(optionsopt, callbackopt) → {Promise.<GetServiceAccountResponse>}

Get the email address of this project's Google Cloud Storage service account.

Parameters:
Name Type Attributes Description
options object <optional>

Configuration object.

Properties
Name Type Attributes Description
userProject string <optional>

User project to be billed for this request.

callback GetServiceAccountCallback <optional>

Callback function.

Source:
See:
Example
const {Storage} = require('@google-cloud/storage');
const storage = new Storage();

storage.getServiceAccount(function(err, serviceAccount, apiResponse) {
  if (!err) {
    const serviceAccountEmail = serviceAccount.emailAddress;
  }
});

//-
// If the callback is omitted, we'll return a Promise.
//-
storage.getServiceAccount().then(function(data) {
  const serviceAccountEmail = data[0].emailAddress;
  const apiResponse = data[1];
});

hmacKey(accessId, options) → {HmacKey}

Get a reference to an HmacKey object. Note: this does not fetch the HMAC key's metadata. Use HmacKey#get() to retrieve and populate the metadata.

To get a reference to an HMAC key that's not created for a service account in the same project used to instantiate the Storage client, supply the project's ID as projectId in the options argument.

Parameters:
Name Type Description
accessId string

The HMAC key's access ID.

options HmacKeyOptions

HmacKey constructor owptions.

Source:
See:
Example
const {Storage} = require('@google-cloud/storage');
const storage = new Storage();
const hmacKey = storage.hmacKey('ACCESS_ID');