@google-cloud/storage 3.0.0 » Class: Notification

Methods

delete([options][, callback]) → Promise containing DeleteNotificationResponse

Permanently deletes a notification subscription.

Examples

const {Storage} = require('@google-cloud/storage');
const storage = new Storage();
const myBucket = storage.bucket('my-bucket');
const notification = myBucket.notification('1');

notification.delete(function(err, apiResponse) {});

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

include:samples/notifications.js

region_tag:storage_delete_notification
Another example:

Parameters

Name Type Optional Description

options

object

Yes

Configuration options.

Values in options have the following properties:

Name	Type	Optional	Description
userProject	string	Yes	The ID of the project which will be billed for the request.

callback

DeleteNotificationCallback

Yes

Callback function.

See also: Notifications: delete API Documentation
Returns: Promise containing DeleteNotificationResponse

exists(topic[, options][, callback]) → Promise containing CreateNotificationResponse

Creates a notification subscription for the bucket.

Example

const {Storage} = require('@google-cloud/storage');
const storage = new Storage();
const myBucket = storage.bucket('my-bucket');
const notification = myBucket.notification('1');

notification.create(function(err, notification, apiResponse) {
  if (!err) {
    // The notification was created successfully.
  }
});

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

Parameters

Name Type Optional Description

Name	Type	Optional	Description
topic	(Topic or string)		The Cloud PubSub topic to which this subscription publishes. If the project ID is omitted, the current project ID will be used. Acceptable formats are: - `projects/grape-spaceship-123/topics/my-topic` `my-topic`
options	CreateNotificationRequest	Yes	Metadata to set for the notification.
callback	CreateNotificationCallback	Yes	Callback function.

topic

(Topic or string)

The Cloud PubSub topic to which this subscription publishes. If the project ID is omitted, the current project ID will be used.

Acceptable formats are:
- `projects/grape-spaceship-123/topics/my-topic`

my-topic

options

CreateNotificationRequest

Yes

Metadata to set for the notification.

callback

CreateNotificationCallback

Yes

Callback function.

See also

Notifications: insert

Throws

Error

If a valid topic is not provided.

Returns

Promise containing CreateNotificationResponse

exists([callback]) → Promise containing NotificationExistsResponse

Check if the notification exists.

Example

const {Storage} = require('@google-cloud/storage');
const storage = new Storage();
const myBucket = storage.bucket('my-bucket');
const notification = myBucket.notification('1');

notification.exists(function(err, exists) {});

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

Parameter

Name	Type	Optional	Description
callback	NotificationExistsCallback	Yes	Callback function.

Returns: Promise containing NotificationExistsResponse

get([options][, callback]) → Promise containing GetNotificationCallback

Get a notification and its metadata if it exists.

Example

const {Storage} = require('@google-cloud/storage');
const storage = new Storage();
const myBucket = storage.bucket('my-bucket');
const notification = myBucket.notification('1');

notification.get(function(err, notification, apiResponse) {
  // `notification.metadata` has been populated.
});

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

Parameters

Name Type Optional Description

options

object

Yes

Configuration options. See Bucket#createNotification for create options.

Values in options have the following properties:

Name	Type	Optional	Description
autoCreate	boolean	Yes	Automatically create the object if it does not exist. Default: `false`.
userProject	string	Yes	The ID of the project which will be billed for the request.

callback

GetNotificationCallback

Yes

Callback function.

See also: Notifications: get API Documentation
Returns: Promise containing GetNotificationCallback

getMetadata([options][, callback]) → Promise containing GetNotificationMetadataResponse

Get the notification's metadata.

Examples

const {Storage} = require('@google-cloud/storage');
const storage = new Storage();
const myBucket = storage.bucket('my-bucket');
const notification = myBucket.notification('1');

notification.getMetadata(function(err, metadata, apiResponse) {});

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

include:samples/notifications.js

region_tag:storage_notifications_get_metadata
Another example:

Parameters

Name Type Optional Description

options

object

Yes

Configuration options.

Values in options have the following properties:

Name	Type	Optional	Description
userProject	string	Yes	The ID of the project which will be billed for the request.

callback

GetNotificationMetadataCallback

Yes

Callback function.

See also: Notifications: get API Documentation
Returns: Promise containing GetNotificationMetadataResponse