/*! * Copyright 2015 Google Inc. All Rights Reserved. * * 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. */ 'use strict'; const common = require('@google-cloud/common'); const util = require('util'); /** * Create a channel object to interact with a Cloud Storage channel. * * @see [Object Change Notification]{@link https://cloud.google.com/storage/docs/object-change-notification} * * @class * * @param {string} id The ID of the channel. * @param {string} resourceId The resource ID of the channel. * * @example * const storage = require('@google-cloud/storage')(); * const channel = storage.channel('id', 'resource-id'); */ function Channel(storage, id, resourceId) { const config = { parent: storage, baseUrl: '/channels', // An ID shouldn't be included in the API requests. // RE: https://github.com/GoogleCloudPlatform/google-cloud-node/issues/1145 id: '', methods: { // Only need `request`. }, }; common.ServiceObject.call(this, config); this.metadata.id = id; this.metadata.resourceId = resourceId; } util.inherits(Channel, common.ServiceObject); /** * @typedef {array} StopResponse * @property {object} 0 The full API response. */ /** * @callback StopCallback * @param {?Error} err Request error, if any. * @param {object} apiResponse The full API response. */ /** * Stop this channel. * * @param {StopCallback} [callback] Callback function. * @returns {Promise} * * @example * const storage = require('@google-cloud/storage')(); * const channel = storage.channel('id', 'resource-id'); * channel.stop(function(err, apiResponse) { * if (!err) { * // Channel stopped successfully. * } * }); * * //- * // If the callback is omitted, we'll return a Promise. * //- * channel.stop().then(function(data) { * const apiResponse = data[0]; * }); */ Channel.prototype.stop = function(callback) { callback = callback || common.util.noop; this.request( { method: 'POST', uri: '/stop', json: this.metadata, }, function(err, apiResponse) { callback(err, apiResponse); } ); }; /*! Developer Documentation * * All async methods (except for streams) will return a Promise in the event * that a callback is omitted. */ common.util.promisifyAll(Channel); /** * Reference to the {@link Channel} class. * @name module:@google-cloud/storage.Channel * @see Channel */ module.exports = Channel;