4864 lines
204 KiB
TypeScript
4864 lines
204 KiB
TypeScript
/**
|
|
* 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.
|
|
*/
|
|
|
|
/* jshint maxlen: false */
|
|
|
|
import createAPIRequest from '../../lib/apirequest';
|
|
|
|
/**
|
|
* Cloud Storage JSON API
|
|
*
|
|
* Stores and retrieves potentially large, immutable data objects.
|
|
*
|
|
* @example
|
|
* const google = require('googleapis');
|
|
* const storage = google.storage('v1');
|
|
*
|
|
* @namespace storage
|
|
* @type {Function}
|
|
* @version v1
|
|
* @variation v1
|
|
* @param {object=} options Options for Storage
|
|
*/
|
|
function Storage(options) { // eslint-disable-line
|
|
const self = this;
|
|
self._options = options || {};
|
|
|
|
self.bucketAccessControls = {
|
|
|
|
/**
|
|
* storage.bucketAccessControls.delete
|
|
*
|
|
* @desc Permanently deletes the ACL entry for the specified entity on the specified bucket.
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* // Name of a bucket.
|
|
* bucket: 'my-bucket', // TODO: Update placeholder value.
|
|
*
|
|
* // The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId,
|
|
* // group-emailAddress, allUsers, or allAuthenticatedUsers.
|
|
* entity: 'my-entity', // TODO: Update placeholder value.
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* storage.bucketAccessControls.delete(request, function(err) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
* });
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.bucketAccessControls.delete
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.bucket Name of a bucket.
|
|
* @param {string} params.entity The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
|
|
* @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets.
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
delete: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/b/{bucket}/acl/{entity}').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'DELETE'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['bucket', 'entity'],
|
|
pathParams: ['bucket', 'entity'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* storage.bucketAccessControls.get
|
|
*
|
|
* @desc Returns the ACL entry for the specified entity on the specified bucket.
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* // Name of a bucket.
|
|
* bucket: 'my-bucket', // TODO: Update placeholder value.
|
|
*
|
|
* // The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId,
|
|
* // group-emailAddress, allUsers, or allAuthenticatedUsers.
|
|
* entity: 'my-entity', // TODO: Update placeholder value.
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* storage.bucketAccessControls.get(request, function(err, response) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
*
|
|
* // TODO: Change code below to process the `response` object:
|
|
* console.log(JSON.stringify(response, null, 2));
|
|
* });
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.bucketAccessControls.get
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.bucket Name of a bucket.
|
|
* @param {string} params.entity The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
|
|
* @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets.
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
get: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/b/{bucket}/acl/{entity}').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['bucket', 'entity'],
|
|
pathParams: ['bucket', 'entity'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* storage.bucketAccessControls.insert
|
|
*
|
|
* @desc Creates a new ACL entry on the specified bucket.
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* // Name of a bucket.
|
|
* bucket: 'my-bucket', // TODO: Update placeholder value.
|
|
*
|
|
* resource: {
|
|
* // TODO: Add desired properties to the request body.
|
|
* },
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* storage.bucketAccessControls.insert(request, function(err, response) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
*
|
|
* // TODO: Change code below to process the `response` object:
|
|
* console.log(JSON.stringify(response, null, 2));
|
|
* });
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.bucketAccessControls.insert
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.bucket Name of a bucket.
|
|
* @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets.
|
|
* @param {storage(v1).BucketAccessControl} params.resource Request body data
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
insert: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/b/{bucket}/acl').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'POST'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['bucket'],
|
|
pathParams: ['bucket'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* storage.bucketAccessControls.list
|
|
*
|
|
* @desc Retrieves ACL entries on the specified bucket.
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* // Name of a bucket.
|
|
* bucket: 'my-bucket', // TODO: Update placeholder value.
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* storage.bucketAccessControls.list(request, function(err, response) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
*
|
|
* // TODO: Change code below to process the `response` object:
|
|
* console.log(JSON.stringify(response, null, 2));
|
|
* });
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.bucketAccessControls.list
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.bucket Name of a bucket.
|
|
* @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets.
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
list: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/b/{bucket}/acl').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['bucket'],
|
|
pathParams: ['bucket'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* storage.bucketAccessControls.patch
|
|
*
|
|
* @desc Updates an ACL entry on the specified bucket. This method supports patch semantics.
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* // Name of a bucket.
|
|
* bucket: 'my-bucket', // TODO: Update placeholder value.
|
|
*
|
|
* // The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId,
|
|
* // group-emailAddress, allUsers, or allAuthenticatedUsers.
|
|
* entity: 'my-entity', // TODO: Update placeholder value.
|
|
*
|
|
* resource: {
|
|
* // TODO: Add desired properties to the request body. Only these properties
|
|
* // will be changed.
|
|
* },
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* storage.bucketAccessControls.patch(request, function(err, response) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
*
|
|
* // TODO: Change code below to process the `response` object:
|
|
* console.log(JSON.stringify(response, null, 2));
|
|
* });
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.bucketAccessControls.patch
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.bucket Name of a bucket.
|
|
* @param {string} params.entity The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
|
|
* @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets.
|
|
* @param {storage(v1).BucketAccessControl} params.resource Request body data
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
patch: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/b/{bucket}/acl/{entity}').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'PATCH'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['bucket', 'entity'],
|
|
pathParams: ['bucket', 'entity'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* storage.bucketAccessControls.update
|
|
*
|
|
* @desc Updates an ACL entry on the specified bucket.
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* // Name of a bucket.
|
|
* bucket: 'my-bucket', // TODO: Update placeholder value.
|
|
*
|
|
* // The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId,
|
|
* // group-emailAddress, allUsers, or allAuthenticatedUsers.
|
|
* entity: 'my-entity', // TODO: Update placeholder value.
|
|
*
|
|
* resource: {
|
|
* // TODO: Add desired properties to the request body. All existing properties
|
|
* // will be replaced.
|
|
* },
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* storage.bucketAccessControls.update(request, function(err, response) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
*
|
|
* // TODO: Change code below to process the `response` object:
|
|
* console.log(JSON.stringify(response, null, 2));
|
|
* });
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.bucketAccessControls.update
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.bucket Name of a bucket.
|
|
* @param {string} params.entity The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
|
|
* @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets.
|
|
* @param {storage(v1).BucketAccessControl} params.resource Request body data
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
update: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/b/{bucket}/acl/{entity}').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'PUT'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['bucket', 'entity'],
|
|
pathParams: ['bucket', 'entity'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
}
|
|
|
|
};
|
|
|
|
self.buckets = {
|
|
|
|
/**
|
|
* storage.buckets.delete
|
|
*
|
|
* @desc Permanently deletes an empty bucket.
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* // Name of a bucket.
|
|
* bucket: 'my-bucket', // TODO: Update placeholder value.
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* storage.buckets.delete(request, function(err) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
* });
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.buckets.delete
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.bucket Name of a bucket.
|
|
* @param {string=} params.ifMetagenerationMatch If set, only deletes the bucket if its metageneration matches this value.
|
|
* @param {string=} params.ifMetagenerationNotMatch If set, only deletes the bucket if its metageneration does not match this value.
|
|
* @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets.
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
delete: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/b/{bucket}').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'DELETE'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['bucket'],
|
|
pathParams: ['bucket'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* storage.buckets.get
|
|
*
|
|
* @desc Returns metadata for the specified bucket.
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* // Name of a bucket.
|
|
* bucket: 'my-bucket', // TODO: Update placeholder value.
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* storage.buckets.get(request, function(err, response) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
*
|
|
* // TODO: Change code below to process the `response` object:
|
|
* console.log(JSON.stringify(response, null, 2));
|
|
* });
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.buckets.get
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.bucket Name of a bucket.
|
|
* @param {string=} params.ifMetagenerationMatch Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.
|
|
* @param {string=} params.ifMetagenerationNotMatch Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value.
|
|
* @param {string=} params.projection Set of properties to return. Defaults to noAcl.
|
|
* @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets.
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
get: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/b/{bucket}').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['bucket'],
|
|
pathParams: ['bucket'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* storage.buckets.getIamPolicy
|
|
*
|
|
* @desc Returns an IAM policy for the specified bucket.
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* // Name of a bucket.
|
|
* bucket: 'my-bucket', // TODO: Update placeholder value.
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* storage.buckets.getIamPolicy(request, function(err, response) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
*
|
|
* // TODO: Change code below to process the `response` object:
|
|
* console.log(JSON.stringify(response, null, 2));
|
|
* });
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.buckets.getIamPolicy
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.bucket Name of a bucket.
|
|
* @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets.
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
getIamPolicy: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/b/{bucket}/iam').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['bucket'],
|
|
pathParams: ['bucket'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* storage.buckets.insert
|
|
*
|
|
* @desc Creates a new bucket.
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* // A valid API project identifier.
|
|
* project: '', // TODO: Update placeholder value.
|
|
*
|
|
* resource: {
|
|
* // TODO: Add desired properties to the request body.
|
|
* },
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* storage.buckets.insert(request, function(err, response) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
*
|
|
* // TODO: Change code below to process the `response` object:
|
|
* console.log(JSON.stringify(response, null, 2));
|
|
* });
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.buckets.insert
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string=} params.predefinedAcl Apply a predefined set of access controls to this bucket.
|
|
* @param {string=} params.predefinedDefaultObjectAcl Apply a predefined set of default object access controls to this bucket.
|
|
* @param {string} params.project A valid API project identifier.
|
|
* @param {string=} params.projection Set of properties to return. Defaults to noAcl, unless the bucket resource specifies acl or defaultObjectAcl properties, when it defaults to full.
|
|
* @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets.
|
|
* @param {storage(v1).Bucket} params.resource Request body data
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
insert: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/b').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'POST'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['project'],
|
|
pathParams: [],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* storage.buckets.list
|
|
*
|
|
* @desc Retrieves a list of buckets for a given project.
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* // A valid API project identifier.
|
|
* project: '', // TODO: Update placeholder value.
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* var handlePage = function(err, response) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
*
|
|
* var itemsPage = response['items'];
|
|
* if (!itemsPage) {
|
|
* return;
|
|
* }
|
|
* for (var i = 0; i < itemsPage.length; i++) {
|
|
* // TODO: Change code below to process each resource in `itemsPage`:
|
|
* console.log(JSON.stringify(itemsPage[i], null, 2));
|
|
* }
|
|
*
|
|
* if (response.nextPageToken) {
|
|
* request.pageToken = response.nextPageToken;
|
|
* storage.buckets.list(request, handlePage);
|
|
* }
|
|
* };
|
|
*
|
|
* storage.buckets.list(request, handlePage);
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.buckets.list
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {integer=} params.maxResults Maximum number of buckets to return in a single response. The service will use this parameter or 1,000 items, whichever is smaller.
|
|
* @param {string=} params.pageToken A previously-returned page token representing part of the larger set of results to view.
|
|
* @param {string=} params.prefix Filter results to buckets whose names begin with this prefix.
|
|
* @param {string} params.project A valid API project identifier.
|
|
* @param {string=} params.projection Set of properties to return. Defaults to noAcl.
|
|
* @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets.
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
list: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/b').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['project'],
|
|
pathParams: [],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* storage.buckets.patch
|
|
*
|
|
* @desc Updates a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate. This method supports patch semantics.
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* // Name of a bucket.
|
|
* bucket: 'my-bucket', // TODO: Update placeholder value.
|
|
*
|
|
* resource: {
|
|
* // TODO: Add desired properties to the request body. Only these properties
|
|
* // will be changed.
|
|
* },
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* storage.buckets.patch(request, function(err, response) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
*
|
|
* // TODO: Change code below to process the `response` object:
|
|
* console.log(JSON.stringify(response, null, 2));
|
|
* });
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.buckets.patch
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.bucket Name of a bucket.
|
|
* @param {string=} params.ifMetagenerationMatch Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.
|
|
* @param {string=} params.ifMetagenerationNotMatch Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value.
|
|
* @param {string=} params.predefinedAcl Apply a predefined set of access controls to this bucket.
|
|
* @param {string=} params.predefinedDefaultObjectAcl Apply a predefined set of default object access controls to this bucket.
|
|
* @param {string=} params.projection Set of properties to return. Defaults to full.
|
|
* @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets.
|
|
* @param {storage(v1).Bucket} params.resource Request body data
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
patch: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/b/{bucket}').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'PATCH'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['bucket'],
|
|
pathParams: ['bucket'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* storage.buckets.setIamPolicy
|
|
*
|
|
* @desc Updates an IAM policy for the specified bucket.
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* // Name of a bucket.
|
|
* bucket: 'my-bucket', // TODO: Update placeholder value.
|
|
*
|
|
* resource: {
|
|
* // TODO: Add desired properties to the request body. All existing properties
|
|
* // will be replaced.
|
|
* },
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* storage.buckets.setIamPolicy(request, function(err, response) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
*
|
|
* // TODO: Change code below to process the `response` object:
|
|
* console.log(JSON.stringify(response, null, 2));
|
|
* });
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.buckets.setIamPolicy
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.bucket Name of a bucket.
|
|
* @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets.
|
|
* @param {storage(v1).Policy} params.resource Request body data
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
setIamPolicy: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/b/{bucket}/iam').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'PUT'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['bucket'],
|
|
pathParams: ['bucket'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* storage.buckets.testIamPermissions
|
|
*
|
|
* @desc Tests a set of permissions on the given bucket to see which, if any, are held by the caller.
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* // Name of a bucket.
|
|
* bucket: 'my-bucket', // TODO: Update placeholder value.
|
|
*
|
|
* // Permissions to test.
|
|
* permissions: [], // TODO: Update placeholder value.
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* storage.buckets.testIamPermissions(request, function(err, response) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
*
|
|
* // TODO: Change code below to process the `response` object:
|
|
* console.log(JSON.stringify(response, null, 2));
|
|
* });
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.buckets.testIamPermissions
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.bucket Name of a bucket.
|
|
* @param {string} params.permissions Permissions to test.
|
|
* @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets.
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
testIamPermissions: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/b/{bucket}/iam/testPermissions').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['bucket', 'permissions'],
|
|
pathParams: ['bucket'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* storage.buckets.update
|
|
*
|
|
* @desc Updates a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* // Name of a bucket.
|
|
* bucket: 'my-bucket', // TODO: Update placeholder value.
|
|
*
|
|
* resource: {
|
|
* // TODO: Add desired properties to the request body. All existing properties
|
|
* // will be replaced.
|
|
* },
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* storage.buckets.update(request, function(err, response) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
*
|
|
* // TODO: Change code below to process the `response` object:
|
|
* console.log(JSON.stringify(response, null, 2));
|
|
* });
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.buckets.update
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.bucket Name of a bucket.
|
|
* @param {string=} params.ifMetagenerationMatch Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.
|
|
* @param {string=} params.ifMetagenerationNotMatch Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value.
|
|
* @param {string=} params.predefinedAcl Apply a predefined set of access controls to this bucket.
|
|
* @param {string=} params.predefinedDefaultObjectAcl Apply a predefined set of default object access controls to this bucket.
|
|
* @param {string=} params.projection Set of properties to return. Defaults to full.
|
|
* @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets.
|
|
* @param {storage(v1).Bucket} params.resource Request body data
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
update: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/b/{bucket}').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'PUT'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['bucket'],
|
|
pathParams: ['bucket'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
}
|
|
|
|
};
|
|
|
|
self.channels = {
|
|
|
|
/**
|
|
* storage.channels.stop
|
|
*
|
|
* @desc Stop watching resources through this channel
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* resource: {
|
|
* // TODO: Add desired properties to the request body.
|
|
* },
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* storage.channels.stop(request, function(err) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
* });
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.channels.stop
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {storage(v1).Channel} params.resource Request body data
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
stop: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/channels/stop').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'POST'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: [],
|
|
pathParams: [],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
}
|
|
|
|
};
|
|
|
|
self.defaultObjectAccessControls = {
|
|
|
|
/**
|
|
* storage.defaultObjectAccessControls.delete
|
|
*
|
|
* @desc Permanently deletes the default object ACL entry for the specified entity on the specified bucket.
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* // Name of a bucket.
|
|
* bucket: 'my-bucket', // TODO: Update placeholder value.
|
|
*
|
|
* // The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId,
|
|
* // group-emailAddress, allUsers, or allAuthenticatedUsers.
|
|
* entity: 'my-entity', // TODO: Update placeholder value.
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* storage.defaultObjectAccessControls.delete(request, function(err) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
* });
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.defaultObjectAccessControls.delete
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.bucket Name of a bucket.
|
|
* @param {string} params.entity The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
|
|
* @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets.
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
delete: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/b/{bucket}/defaultObjectAcl/{entity}').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'DELETE'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['bucket', 'entity'],
|
|
pathParams: ['bucket', 'entity'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* storage.defaultObjectAccessControls.get
|
|
*
|
|
* @desc Returns the default object ACL entry for the specified entity on the specified bucket.
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* // Name of a bucket.
|
|
* bucket: 'my-bucket', // TODO: Update placeholder value.
|
|
*
|
|
* // The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId,
|
|
* // group-emailAddress, allUsers, or allAuthenticatedUsers.
|
|
* entity: 'my-entity', // TODO: Update placeholder value.
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* storage.defaultObjectAccessControls.get(request, function(err, response) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
*
|
|
* // TODO: Change code below to process the `response` object:
|
|
* console.log(JSON.stringify(response, null, 2));
|
|
* });
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.defaultObjectAccessControls.get
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.bucket Name of a bucket.
|
|
* @param {string} params.entity The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
|
|
* @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets.
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
get: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/b/{bucket}/defaultObjectAcl/{entity}').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['bucket', 'entity'],
|
|
pathParams: ['bucket', 'entity'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* storage.defaultObjectAccessControls.insert
|
|
*
|
|
* @desc Creates a new default object ACL entry on the specified bucket.
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* // Name of a bucket.
|
|
* bucket: 'my-bucket', // TODO: Update placeholder value.
|
|
*
|
|
* resource: {
|
|
* // TODO: Add desired properties to the request body.
|
|
* },
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* storage.defaultObjectAccessControls.insert(request, function(err, response) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
*
|
|
* // TODO: Change code below to process the `response` object:
|
|
* console.log(JSON.stringify(response, null, 2));
|
|
* });
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.defaultObjectAccessControls.insert
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.bucket Name of a bucket.
|
|
* @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets.
|
|
* @param {storage(v1).ObjectAccessControl} params.resource Request body data
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
insert: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/b/{bucket}/defaultObjectAcl').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'POST'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['bucket'],
|
|
pathParams: ['bucket'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* storage.defaultObjectAccessControls.list
|
|
*
|
|
* @desc Retrieves default object ACL entries on the specified bucket.
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* // Name of a bucket.
|
|
* bucket: 'my-bucket', // TODO: Update placeholder value.
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* storage.defaultObjectAccessControls.list(request, function(err, response) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
*
|
|
* // TODO: Change code below to process the `response` object:
|
|
* console.log(JSON.stringify(response, null, 2));
|
|
* });
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.defaultObjectAccessControls.list
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.bucket Name of a bucket.
|
|
* @param {string=} params.ifMetagenerationMatch If present, only return default ACL listing if the bucket's current metageneration matches this value.
|
|
* @param {string=} params.ifMetagenerationNotMatch If present, only return default ACL listing if the bucket's current metageneration does not match the given value.
|
|
* @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets.
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
list: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/b/{bucket}/defaultObjectAcl').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['bucket'],
|
|
pathParams: ['bucket'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* storage.defaultObjectAccessControls.patch
|
|
*
|
|
* @desc Updates a default object ACL entry on the specified bucket. This method supports patch semantics.
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* // Name of a bucket.
|
|
* bucket: 'my-bucket', // TODO: Update placeholder value.
|
|
*
|
|
* // The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId,
|
|
* // group-emailAddress, allUsers, or allAuthenticatedUsers.
|
|
* entity: 'my-entity', // TODO: Update placeholder value.
|
|
*
|
|
* resource: {
|
|
* // TODO: Add desired properties to the request body. Only these properties
|
|
* // will be changed.
|
|
* },
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* storage.defaultObjectAccessControls.patch(request, function(err, response) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
*
|
|
* // TODO: Change code below to process the `response` object:
|
|
* console.log(JSON.stringify(response, null, 2));
|
|
* });
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.defaultObjectAccessControls.patch
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.bucket Name of a bucket.
|
|
* @param {string} params.entity The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
|
|
* @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets.
|
|
* @param {storage(v1).ObjectAccessControl} params.resource Request body data
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
patch: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/b/{bucket}/defaultObjectAcl/{entity}').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'PATCH'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['bucket', 'entity'],
|
|
pathParams: ['bucket', 'entity'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* storage.defaultObjectAccessControls.update
|
|
*
|
|
* @desc Updates a default object ACL entry on the specified bucket.
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* // Name of a bucket.
|
|
* bucket: 'my-bucket', // TODO: Update placeholder value.
|
|
*
|
|
* // The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId,
|
|
* // group-emailAddress, allUsers, or allAuthenticatedUsers.
|
|
* entity: 'my-entity', // TODO: Update placeholder value.
|
|
*
|
|
* resource: {
|
|
* // TODO: Add desired properties to the request body. All existing properties
|
|
* // will be replaced.
|
|
* },
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* storage.defaultObjectAccessControls.update(request, function(err, response) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
*
|
|
* // TODO: Change code below to process the `response` object:
|
|
* console.log(JSON.stringify(response, null, 2));
|
|
* });
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.defaultObjectAccessControls.update
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.bucket Name of a bucket.
|
|
* @param {string} params.entity The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
|
|
* @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets.
|
|
* @param {storage(v1).ObjectAccessControl} params.resource Request body data
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
update: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/b/{bucket}/defaultObjectAcl/{entity}').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'PUT'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['bucket', 'entity'],
|
|
pathParams: ['bucket', 'entity'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
}
|
|
|
|
};
|
|
|
|
self.notifications = {
|
|
|
|
/**
|
|
* storage.notifications.delete
|
|
*
|
|
* @desc Permanently deletes a notification subscription.
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* // The parent bucket of the notification.
|
|
* bucket: 'my-bucket', // TODO: Update placeholder value.
|
|
*
|
|
* // ID of the notification to delete.
|
|
* notification: 'my-notification', // TODO: Update placeholder value.
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* storage.notifications.delete(request, function(err) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
* });
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.notifications.delete
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.bucket The parent bucket of the notification.
|
|
* @param {string} params.notification ID of the notification to delete.
|
|
* @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets.
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
delete: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/b/{bucket}/notificationConfigs/{notification}').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'DELETE'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['bucket', 'notification'],
|
|
pathParams: ['bucket', 'notification'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* storage.notifications.get
|
|
*
|
|
* @desc View a notification configuration.
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* // The parent bucket of the notification.
|
|
* bucket: 'my-bucket', // TODO: Update placeholder value.
|
|
*
|
|
* // Notification ID
|
|
* notification: 'my-notification', // TODO: Update placeholder value.
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* storage.notifications.get(request, function(err, response) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
*
|
|
* // TODO: Change code below to process the `response` object:
|
|
* console.log(JSON.stringify(response, null, 2));
|
|
* });
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.notifications.get
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.bucket The parent bucket of the notification.
|
|
* @param {string} params.notification Notification ID
|
|
* @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets.
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
get: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/b/{bucket}/notificationConfigs/{notification}').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['bucket', 'notification'],
|
|
pathParams: ['bucket', 'notification'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* storage.notifications.insert
|
|
*
|
|
* @desc Creates a notification subscription for a given bucket.
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* // The parent bucket of the notification.
|
|
* bucket: 'my-bucket', // TODO: Update placeholder value.
|
|
*
|
|
* resource: {
|
|
* // TODO: Add desired properties to the request body.
|
|
* },
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* storage.notifications.insert(request, function(err, response) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
*
|
|
* // TODO: Change code below to process the `response` object:
|
|
* console.log(JSON.stringify(response, null, 2));
|
|
* });
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.notifications.insert
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.bucket The parent bucket of the notification.
|
|
* @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets.
|
|
* @param {storage(v1).Notification} params.resource Request body data
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
insert: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/b/{bucket}/notificationConfigs').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'POST'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['bucket'],
|
|
pathParams: ['bucket'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* storage.notifications.list
|
|
*
|
|
* @desc Retrieves a list of notification subscriptions for a given bucket.
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* // Name of a Google Cloud Storage bucket.
|
|
* bucket: 'my-bucket', // TODO: Update placeholder value.
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* storage.notifications.list(request, function(err, response) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
*
|
|
* // TODO: Change code below to process the `response` object:
|
|
* console.log(JSON.stringify(response, null, 2));
|
|
* });
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.notifications.list
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.bucket Name of a Google Cloud Storage bucket.
|
|
* @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets.
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
list: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/b/{bucket}/notificationConfigs').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['bucket'],
|
|
pathParams: ['bucket'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
}
|
|
|
|
};
|
|
|
|
self.objectAccessControls = {
|
|
|
|
/**
|
|
* storage.objectAccessControls.delete
|
|
*
|
|
* @desc Permanently deletes the ACL entry for the specified entity on the specified object.
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* // Name of a bucket.
|
|
* bucket: 'my-bucket', // TODO: Update placeholder value.
|
|
*
|
|
* // Name of the object. For information about how to URL encode object names to be path safe, see
|
|
* // Encoding URI Path Parts.
|
|
* object: 'my-object', // TODO: Update placeholder value.
|
|
*
|
|
* // The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId,
|
|
* // group-emailAddress, allUsers, or allAuthenticatedUsers.
|
|
* entity: 'my-entity', // TODO: Update placeholder value.
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* storage.objectAccessControls.delete(request, function(err) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
* });
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.objectAccessControls.delete
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.bucket Name of a bucket.
|
|
* @param {string} params.entity The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
|
|
* @param {string=} params.generation If present, selects a specific revision of this object (as opposed to the latest version, the default).
|
|
* @param {string} params.object Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
|
|
* @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets.
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
delete: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/b/{bucket}/o/{object}/acl/{entity}').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'DELETE'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['bucket', 'object', 'entity'],
|
|
pathParams: ['bucket', 'entity', 'object'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* storage.objectAccessControls.get
|
|
*
|
|
* @desc Returns the ACL entry for the specified entity on the specified object.
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* // Name of a bucket.
|
|
* bucket: 'my-bucket', // TODO: Update placeholder value.
|
|
*
|
|
* // Name of the object. For information about how to URL encode object names to be path safe, see
|
|
* // Encoding URI Path Parts.
|
|
* object: 'my-object', // TODO: Update placeholder value.
|
|
*
|
|
* // The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId,
|
|
* // group-emailAddress, allUsers, or allAuthenticatedUsers.
|
|
* entity: 'my-entity', // TODO: Update placeholder value.
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* storage.objectAccessControls.get(request, function(err, response) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
*
|
|
* // TODO: Change code below to process the `response` object:
|
|
* console.log(JSON.stringify(response, null, 2));
|
|
* });
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.objectAccessControls.get
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.bucket Name of a bucket.
|
|
* @param {string} params.entity The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
|
|
* @param {string=} params.generation If present, selects a specific revision of this object (as opposed to the latest version, the default).
|
|
* @param {string} params.object Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
|
|
* @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets.
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
get: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/b/{bucket}/o/{object}/acl/{entity}').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['bucket', 'object', 'entity'],
|
|
pathParams: ['bucket', 'entity', 'object'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* storage.objectAccessControls.insert
|
|
*
|
|
* @desc Creates a new ACL entry on the specified object.
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* // Name of a bucket.
|
|
* bucket: 'my-bucket', // TODO: Update placeholder value.
|
|
*
|
|
* // Name of the object. For information about how to URL encode object names to be path safe, see
|
|
* // Encoding URI Path Parts.
|
|
* object: 'my-object', // TODO: Update placeholder value.
|
|
*
|
|
* resource: {
|
|
* // TODO: Add desired properties to the request body.
|
|
* },
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* storage.objectAccessControls.insert(request, function(err, response) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
*
|
|
* // TODO: Change code below to process the `response` object:
|
|
* console.log(JSON.stringify(response, null, 2));
|
|
* });
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.objectAccessControls.insert
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.bucket Name of a bucket.
|
|
* @param {string=} params.generation If present, selects a specific revision of this object (as opposed to the latest version, the default).
|
|
* @param {string} params.object Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
|
|
* @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets.
|
|
* @param {storage(v1).ObjectAccessControl} params.resource Request body data
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
insert: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/b/{bucket}/o/{object}/acl').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'POST'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['bucket', 'object'],
|
|
pathParams: ['bucket', 'object'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* storage.objectAccessControls.list
|
|
*
|
|
* @desc Retrieves ACL entries on the specified object.
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* // Name of a bucket.
|
|
* bucket: 'my-bucket', // TODO: Update placeholder value.
|
|
*
|
|
* // Name of the object. For information about how to URL encode object names to be path safe, see
|
|
* // Encoding URI Path Parts.
|
|
* object: 'my-object', // TODO: Update placeholder value.
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* storage.objectAccessControls.list(request, function(err, response) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
*
|
|
* // TODO: Change code below to process the `response` object:
|
|
* console.log(JSON.stringify(response, null, 2));
|
|
* });
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.objectAccessControls.list
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.bucket Name of a bucket.
|
|
* @param {string=} params.generation If present, selects a specific revision of this object (as opposed to the latest version, the default).
|
|
* @param {string} params.object Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
|
|
* @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets.
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
list: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/b/{bucket}/o/{object}/acl').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['bucket', 'object'],
|
|
pathParams: ['bucket', 'object'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* storage.objectAccessControls.patch
|
|
*
|
|
* @desc Updates an ACL entry on the specified object. This method supports patch semantics.
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* // Name of a bucket.
|
|
* bucket: 'my-bucket', // TODO: Update placeholder value.
|
|
*
|
|
* // Name of the object. For information about how to URL encode object names to be path safe, see
|
|
* // Encoding URI Path Parts.
|
|
* object: 'my-object', // TODO: Update placeholder value.
|
|
*
|
|
* // The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId,
|
|
* // group-emailAddress, allUsers, or allAuthenticatedUsers.
|
|
* entity: 'my-entity', // TODO: Update placeholder value.
|
|
*
|
|
* resource: {
|
|
* // TODO: Add desired properties to the request body. Only these properties
|
|
* // will be changed.
|
|
* },
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* storage.objectAccessControls.patch(request, function(err, response) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
*
|
|
* // TODO: Change code below to process the `response` object:
|
|
* console.log(JSON.stringify(response, null, 2));
|
|
* });
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.objectAccessControls.patch
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.bucket Name of a bucket.
|
|
* @param {string} params.entity The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
|
|
* @param {string=} params.generation If present, selects a specific revision of this object (as opposed to the latest version, the default).
|
|
* @param {string} params.object Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
|
|
* @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets.
|
|
* @param {storage(v1).ObjectAccessControl} params.resource Request body data
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
patch: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/b/{bucket}/o/{object}/acl/{entity}').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'PATCH'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['bucket', 'object', 'entity'],
|
|
pathParams: ['bucket', 'entity', 'object'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* storage.objectAccessControls.update
|
|
*
|
|
* @desc Updates an ACL entry on the specified object.
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* // Name of a bucket.
|
|
* bucket: 'my-bucket', // TODO: Update placeholder value.
|
|
*
|
|
* // Name of the object. For information about how to URL encode object names to be path safe, see
|
|
* // Encoding URI Path Parts.
|
|
* object: 'my-object', // TODO: Update placeholder value.
|
|
*
|
|
* // The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId,
|
|
* // group-emailAddress, allUsers, or allAuthenticatedUsers.
|
|
* entity: 'my-entity', // TODO: Update placeholder value.
|
|
*
|
|
* resource: {
|
|
* // TODO: Add desired properties to the request body. All existing properties
|
|
* // will be replaced.
|
|
* },
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* storage.objectAccessControls.update(request, function(err, response) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
*
|
|
* // TODO: Change code below to process the `response` object:
|
|
* console.log(JSON.stringify(response, null, 2));
|
|
* });
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.objectAccessControls.update
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.bucket Name of a bucket.
|
|
* @param {string} params.entity The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.
|
|
* @param {string=} params.generation If present, selects a specific revision of this object (as opposed to the latest version, the default).
|
|
* @param {string} params.object Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
|
|
* @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets.
|
|
* @param {storage(v1).ObjectAccessControl} params.resource Request body data
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
update: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/b/{bucket}/o/{object}/acl/{entity}').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'PUT'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['bucket', 'object', 'entity'],
|
|
pathParams: ['bucket', 'entity', 'object'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
}
|
|
|
|
};
|
|
|
|
self.objects = {
|
|
|
|
/**
|
|
* storage.objects.compose
|
|
*
|
|
* @desc Concatenates a list of existing objects into a new object in the same bucket.
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* // Name of the bucket in which to store the new object.
|
|
* destinationBucket: 'my-destination-bucket', // TODO: Update placeholder value.
|
|
*
|
|
* // Name of the new object. For information about how to URL encode object names to be path safe, see
|
|
* // Encoding URI Path Parts.
|
|
* destinationObject: 'my-destination-object', // TODO: Update placeholder value.
|
|
*
|
|
* resource: {
|
|
* // TODO: Add desired properties to the request body.
|
|
* },
|
|
*
|
|
* // TODO: To download media content, use:
|
|
* //
|
|
* // alt: 'media',
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* storage.objects.compose(request, function(err, response) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
*
|
|
* // TODO: Change code below to process the `response` object:
|
|
* console.log(JSON.stringify(response, null, 2));
|
|
* });
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.objects.compose
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.destinationBucket Name of the bucket in which to store the new object.
|
|
* @param {string} params.destinationObject Name of the new object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
|
|
* @param {string=} params.destinationPredefinedAcl Apply a predefined set of access controls to the destination object.
|
|
* @param {string=} params.ifGenerationMatch Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
|
|
* @param {string=} params.ifMetagenerationMatch Makes the operation conditional on whether the object's current metageneration matches the given value.
|
|
* @param {string=} params.kmsKeyName Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any.
|
|
* @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets.
|
|
* @param {storage(v1).ComposeRequest} params.resource Request body data
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
compose: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/b/{destinationBucket}/o/{destinationObject}/compose').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'POST'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['destinationBucket', 'destinationObject'],
|
|
pathParams: ['destinationBucket', 'destinationObject'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* storage.objects.copy
|
|
*
|
|
* @desc Copies a source object to a destination object. Optionally overrides metadata.
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* // Name of the bucket in which to find the source object.
|
|
* sourceBucket: 'my-source-bucket', // TODO: Update placeholder value.
|
|
*
|
|
* // Name of the source object. For information about how to URL encode object names to be path safe,
|
|
* // see Encoding URI Path Parts.
|
|
* sourceObject: 'my-source-object', // TODO: Update placeholder value.
|
|
*
|
|
* // Name of the bucket in which to store the new object. Overrides the provided object metadata's
|
|
* // bucket value, if any.For information about how to URL encode object names to be path safe, see
|
|
* // Encoding URI Path Parts.
|
|
* destinationBucket: 'my-destination-bucket', // TODO: Update placeholder value.
|
|
*
|
|
* // Name of the new object. Required when the object metadata is not otherwise provided. Overrides the
|
|
* // object metadata's name value, if any.
|
|
* destinationObject: 'my-destination-object', // TODO: Update placeholder value.
|
|
*
|
|
* resource: {
|
|
* // TODO: Add desired properties to the request body.
|
|
* },
|
|
*
|
|
* // TODO: To download media content, use:
|
|
* //
|
|
* // alt: 'media',
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* storage.objects.copy(request, function(err, response) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
*
|
|
* // TODO: Change code below to process the `response` object:
|
|
* console.log(JSON.stringify(response, null, 2));
|
|
* });
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.objects.copy
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.destinationBucket Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
|
|
* @param {string} params.destinationObject Name of the new object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any.
|
|
* @param {string=} params.destinationPredefinedAcl Apply a predefined set of access controls to the destination object.
|
|
* @param {string=} params.ifGenerationMatch Makes the operation conditional on whether the destination object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
|
|
* @param {string=} params.ifGenerationNotMatch Makes the operation conditional on whether the destination object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
|
|
* @param {string=} params.ifMetagenerationMatch Makes the operation conditional on whether the destination object's current metageneration matches the given value.
|
|
* @param {string=} params.ifMetagenerationNotMatch Makes the operation conditional on whether the destination object's current metageneration does not match the given value.
|
|
* @param {string=} params.ifSourceGenerationMatch Makes the operation conditional on whether the source object's current generation matches the given value.
|
|
* @param {string=} params.ifSourceGenerationNotMatch Makes the operation conditional on whether the source object's current generation does not match the given value.
|
|
* @param {string=} params.ifSourceMetagenerationMatch Makes the operation conditional on whether the source object's current metageneration matches the given value.
|
|
* @param {string=} params.ifSourceMetagenerationNotMatch Makes the operation conditional on whether the source object's current metageneration does not match the given value.
|
|
* @param {string=} params.projection Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full.
|
|
* @param {string} params.sourceBucket Name of the bucket in which to find the source object.
|
|
* @param {string=} params.sourceGeneration If present, selects a specific revision of the source object (as opposed to the latest version, the default).
|
|
* @param {string} params.sourceObject Name of the source object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
|
|
* @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets.
|
|
* @param {storage(v1).Object} params.resource Request body data
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
copy: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/b/{sourceBucket}/o/{sourceObject}/copyTo/b/{destinationBucket}/o/{destinationObject}').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'POST'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['sourceBucket', 'sourceObject', 'destinationBucket', 'destinationObject'],
|
|
pathParams: ['destinationBucket', 'destinationObject', 'sourceBucket', 'sourceObject'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* storage.objects.delete
|
|
*
|
|
* @desc Deletes an object and its metadata. Deletions are permanent if versioning is not enabled for the bucket, or if the generation parameter is used.
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* // Name of the bucket in which the object resides.
|
|
* bucket: 'my-bucket', // TODO: Update placeholder value.
|
|
*
|
|
* // Name of the object. For information about how to URL encode object names to be path safe, see
|
|
* // Encoding URI Path Parts.
|
|
* object: 'my-object', // TODO: Update placeholder value.
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* storage.objects.delete(request, function(err) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
* });
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.objects.delete
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.bucket Name of the bucket in which the object resides.
|
|
* @param {string=} params.generation If present, permanently deletes a specific revision of this object (as opposed to the latest version, the default).
|
|
* @param {string=} params.ifGenerationMatch Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
|
|
* @param {string=} params.ifGenerationNotMatch Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
|
|
* @param {string=} params.ifMetagenerationMatch Makes the operation conditional on whether the object's current metageneration matches the given value.
|
|
* @param {string=} params.ifMetagenerationNotMatch Makes the operation conditional on whether the object's current metageneration does not match the given value.
|
|
* @param {string} params.object Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
|
|
* @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets.
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
delete: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/b/{bucket}/o/{object}').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'DELETE'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['bucket', 'object'],
|
|
pathParams: ['bucket', 'object'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* storage.objects.get
|
|
*
|
|
* @desc Retrieves an object or its metadata.
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* // Name of the bucket in which the object resides.
|
|
* bucket: 'my-bucket', // TODO: Update placeholder value.
|
|
*
|
|
* // Name of the object. For information about how to URL encode object names to be path safe, see
|
|
* // Encoding URI Path Parts.
|
|
* object: 'my-object', // TODO: Update placeholder value.
|
|
*
|
|
* // TODO: To download media content, use:
|
|
* //
|
|
* // alt: 'media',
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* storage.objects.get(request, function(err, response) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
*
|
|
* // TODO: Change code below to process the `response` object:
|
|
* console.log(JSON.stringify(response, null, 2));
|
|
* });
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.objects.get
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.bucket Name of the bucket in which the object resides.
|
|
* @param {string=} params.generation If present, selects a specific revision of this object (as opposed to the latest version, the default).
|
|
* @param {string=} params.ifGenerationMatch Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
|
|
* @param {string=} params.ifGenerationNotMatch Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
|
|
* @param {string=} params.ifMetagenerationMatch Makes the operation conditional on whether the object's current metageneration matches the given value.
|
|
* @param {string=} params.ifMetagenerationNotMatch Makes the operation conditional on whether the object's current metageneration does not match the given value.
|
|
* @param {string} params.object Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
|
|
* @param {string=} params.projection Set of properties to return. Defaults to noAcl.
|
|
* @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets.
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
get: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/b/{bucket}/o/{object}').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['bucket', 'object'],
|
|
pathParams: ['bucket', 'object'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* storage.objects.getIamPolicy
|
|
*
|
|
* @desc Returns an IAM policy for the specified object.
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* // Name of the bucket in which the object resides.
|
|
* bucket: 'my-bucket', // TODO: Update placeholder value.
|
|
*
|
|
* // Name of the object. For information about how to URL encode object names to be path safe, see
|
|
* // Encoding URI Path Parts.
|
|
* object: 'my-object', // TODO: Update placeholder value.
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* storage.objects.getIamPolicy(request, function(err, response) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
*
|
|
* // TODO: Change code below to process the `response` object:
|
|
* console.log(JSON.stringify(response, null, 2));
|
|
* });
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.objects.getIamPolicy
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.bucket Name of the bucket in which the object resides.
|
|
* @param {string=} params.generation If present, selects a specific revision of this object (as opposed to the latest version, the default).
|
|
* @param {string} params.object Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
|
|
* @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets.
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
getIamPolicy: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/b/{bucket}/o/{object}/iam').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['bucket', 'object'],
|
|
pathParams: ['bucket', 'object'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* storage.objects.insert
|
|
*
|
|
* @desc Stores a new object and metadata.
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* // Name of the bucket in which to store the new object. Overrides the provided object metadata's
|
|
* // bucket value, if any.
|
|
* bucket: 'my-bucket', // TODO: Update placeholder value.
|
|
*
|
|
* resource: {
|
|
* // TODO: Add desired properties to the request body.
|
|
* },
|
|
*
|
|
* media: {
|
|
* // TODO: Add desired media content for upload. See
|
|
* // https://github.com/google/google-api-nodejs-client#media-uploads
|
|
* mimeType: '', // See https://www.w3.org/Protocols/rfc1341/4_Content-Type.html
|
|
* body: '',
|
|
* },
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* storage.objects.insert(request, function(err, response) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
*
|
|
* // TODO: Change code below to process the `response` object:
|
|
* console.log(JSON.stringify(response, null, 2));
|
|
* });
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.objects.insert
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.bucket Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.
|
|
* @param {string=} params.contentEncoding If set, sets the contentEncoding property of the final object to this value. Setting this parameter is equivalent to setting the contentEncoding metadata property. This can be useful when uploading an object with uploadType=media to indicate the encoding of the content being uploaded.
|
|
* @param {string=} params.ifGenerationMatch Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
|
|
* @param {string=} params.ifGenerationNotMatch Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
|
|
* @param {string=} params.ifMetagenerationMatch Makes the operation conditional on whether the object's current metageneration matches the given value.
|
|
* @param {string=} params.ifMetagenerationNotMatch Makes the operation conditional on whether the object's current metageneration does not match the given value.
|
|
* @param {string=} params.kmsKeyName Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any.
|
|
* @param {string=} params.name Name of the object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
|
|
* @param {string=} params.predefinedAcl Apply a predefined set of access controls to this object.
|
|
* @param {string=} params.projection Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full.
|
|
* @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets.
|
|
* @param {object} params.resource Media resource metadata
|
|
* @param {object} params.media Media object
|
|
* @param {string} params.media.mimeType Media mime-type
|
|
* @param {string|object} params.media.body Media body contents
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
insert: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/b/{bucket}/o').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'POST'
|
|
}, options),
|
|
params: params,
|
|
mediaUrl: (rootUrl + '/upload/storage/v1/b/{bucket}/o').replace(/([^:]\/)\/+/g, '$1'),
|
|
requiredParams: ['bucket'],
|
|
pathParams: ['bucket'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* storage.objects.list
|
|
*
|
|
* @desc Retrieves a list of objects matching the criteria.
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* // Name of the bucket in which to look for objects.
|
|
* bucket: 'my-bucket', // TODO: Update placeholder value.
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* var handlePage = function(err, response) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
*
|
|
* var itemsPage = response['items'];
|
|
* if (!itemsPage) {
|
|
* return;
|
|
* }
|
|
* for (var i = 0; i < itemsPage.length; i++) {
|
|
* // TODO: Change code below to process each resource in `itemsPage`:
|
|
* console.log(JSON.stringify(itemsPage[i], null, 2));
|
|
* }
|
|
*
|
|
* if (response.nextPageToken) {
|
|
* request.pageToken = response.nextPageToken;
|
|
* storage.objects.list(request, handlePage);
|
|
* }
|
|
* };
|
|
*
|
|
* storage.objects.list(request, handlePage);
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.objects.list
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.bucket Name of the bucket in which to look for objects.
|
|
* @param {string=} params.delimiter Returns results in a directory-like mode. items will contain only objects whose names, aside from the prefix, do not contain delimiter. Objects whose names, aside from the prefix, contain delimiter will have their name, truncated after the delimiter, returned in prefixes. Duplicate prefixes are omitted.
|
|
* @param {integer=} params.maxResults Maximum number of items plus prefixes to return in a single page of responses. As duplicate prefixes are omitted, fewer total results may be returned than requested. The service will use this parameter or 1,000 items, whichever is smaller.
|
|
* @param {string=} params.pageToken A previously-returned page token representing part of the larger set of results to view.
|
|
* @param {string=} params.prefix Filter results to objects whose names begin with this prefix.
|
|
* @param {string=} params.projection Set of properties to return. Defaults to noAcl.
|
|
* @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets.
|
|
* @param {boolean=} params.versions If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning.
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
list: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/b/{bucket}/o').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['bucket'],
|
|
pathParams: ['bucket'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* storage.objects.patch
|
|
*
|
|
* @desc Updates an object's metadata. This method supports patch semantics.
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* // Name of the bucket in which the object resides.
|
|
* bucket: 'my-bucket', // TODO: Update placeholder value.
|
|
*
|
|
* // Name of the object. For information about how to URL encode object names to be path safe, see
|
|
* // Encoding URI Path Parts.
|
|
* object: 'my-object', // TODO: Update placeholder value.
|
|
*
|
|
* resource: {
|
|
* // TODO: Add desired properties to the request body. Only these properties
|
|
* // will be changed.
|
|
* },
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* storage.objects.patch(request, function(err, response) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
*
|
|
* // TODO: Change code below to process the `response` object:
|
|
* console.log(JSON.stringify(response, null, 2));
|
|
* });
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.objects.patch
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.bucket Name of the bucket in which the object resides.
|
|
* @param {string=} params.generation If present, selects a specific revision of this object (as opposed to the latest version, the default).
|
|
* @param {string=} params.ifGenerationMatch Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
|
|
* @param {string=} params.ifGenerationNotMatch Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
|
|
* @param {string=} params.ifMetagenerationMatch Makes the operation conditional on whether the object's current metageneration matches the given value.
|
|
* @param {string=} params.ifMetagenerationNotMatch Makes the operation conditional on whether the object's current metageneration does not match the given value.
|
|
* @param {string} params.object Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
|
|
* @param {string=} params.predefinedAcl Apply a predefined set of access controls to this object.
|
|
* @param {string=} params.projection Set of properties to return. Defaults to full.
|
|
* @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets.
|
|
* @param {storage(v1).Object} params.resource Request body data
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
patch: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/b/{bucket}/o/{object}').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'PATCH'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['bucket', 'object'],
|
|
pathParams: ['bucket', 'object'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* storage.objects.rewrite
|
|
*
|
|
* @desc Rewrites a source object to a destination object. Optionally overrides metadata.
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* // Name of the bucket in which to find the source object.
|
|
* sourceBucket: 'my-source-bucket', // TODO: Update placeholder value.
|
|
*
|
|
* // Name of the source object. For information about how to URL encode object names to be path safe,
|
|
* // see Encoding URI Path Parts.
|
|
* sourceObject: 'my-source-object', // TODO: Update placeholder value.
|
|
*
|
|
* // Name of the bucket in which to store the new object. Overrides the provided object metadata's
|
|
* // bucket value, if any.
|
|
* destinationBucket: 'my-destination-bucket', // TODO: Update placeholder value.
|
|
*
|
|
* // Name of the new object. Required when the object metadata is not otherwise provided. Overrides the
|
|
* // object metadata's name value, if any. For information about how to URL encode object names to be
|
|
* // path safe, see Encoding URI Path Parts.
|
|
* destinationObject: 'my-destination-object', // TODO: Update placeholder value.
|
|
*
|
|
* resource: {
|
|
* // TODO: Add desired properties to the request body.
|
|
* },
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* storage.objects.rewrite(request, function(err, response) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
*
|
|
* // TODO: Change code below to process the `response` object:
|
|
* console.log(JSON.stringify(response, null, 2));
|
|
* });
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.objects.rewrite
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.destinationBucket Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.
|
|
* @param {string=} params.destinationKmsKeyName Resource name of the Cloud KMS key, of the form projects/my-project/locations/global/keyRings/my-kr/cryptoKeys/my-key, that will be used to encrypt the object. Overrides the object metadata's kms_key_name value, if any.
|
|
* @param {string} params.destinationObject Name of the new object. Required when the object metadata is not otherwise provided. Overrides the object metadata's name value, if any. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
|
|
* @param {string=} params.destinationPredefinedAcl Apply a predefined set of access controls to the destination object.
|
|
* @param {string=} params.ifGenerationMatch Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
|
|
* @param {string=} params.ifGenerationNotMatch Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
|
|
* @param {string=} params.ifMetagenerationMatch Makes the operation conditional on whether the destination object's current metageneration matches the given value.
|
|
* @param {string=} params.ifMetagenerationNotMatch Makes the operation conditional on whether the destination object's current metageneration does not match the given value.
|
|
* @param {string=} params.ifSourceGenerationMatch Makes the operation conditional on whether the source object's current generation matches the given value.
|
|
* @param {string=} params.ifSourceGenerationNotMatch Makes the operation conditional on whether the source object's current generation does not match the given value.
|
|
* @param {string=} params.ifSourceMetagenerationMatch Makes the operation conditional on whether the source object's current metageneration matches the given value.
|
|
* @param {string=} params.ifSourceMetagenerationNotMatch Makes the operation conditional on whether the source object's current metageneration does not match the given value.
|
|
* @param {string=} params.maxBytesRewrittenPerCall The maximum number of bytes that will be rewritten per rewrite request. Most callers shouldn't need to specify this parameter - it is primarily in place to support testing. If specified the value must be an integral multiple of 1 MiB (1048576). Also, this only applies to requests where the source and destination span locations and/or storage classes. Finally, this value must not change across rewrite calls else you'll get an error that the rewriteToken is invalid.
|
|
* @param {string=} params.projection Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full.
|
|
* @param {string=} params.rewriteToken Include this field (from the previous rewrite response) on each rewrite request after the first one, until the rewrite response 'done' flag is true. Calls that provide a rewriteToken can omit all other request fields, but if included those fields must match the values provided in the first rewrite request.
|
|
* @param {string} params.sourceBucket Name of the bucket in which to find the source object.
|
|
* @param {string=} params.sourceGeneration If present, selects a specific revision of the source object (as opposed to the latest version, the default).
|
|
* @param {string} params.sourceObject Name of the source object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
|
|
* @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets.
|
|
* @param {storage(v1).Object} params.resource Request body data
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
rewrite: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/b/{sourceBucket}/o/{sourceObject}/rewriteTo/b/{destinationBucket}/o/{destinationObject}').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'POST'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['sourceBucket', 'sourceObject', 'destinationBucket', 'destinationObject'],
|
|
pathParams: ['destinationBucket', 'destinationObject', 'sourceBucket', 'sourceObject'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* storage.objects.setIamPolicy
|
|
*
|
|
* @desc Updates an IAM policy for the specified object.
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* // Name of the bucket in which the object resides.
|
|
* bucket: 'my-bucket', // TODO: Update placeholder value.
|
|
*
|
|
* // Name of the object. For information about how to URL encode object names to be path safe, see
|
|
* // Encoding URI Path Parts.
|
|
* object: 'my-object', // TODO: Update placeholder value.
|
|
*
|
|
* resource: {
|
|
* // TODO: Add desired properties to the request body. All existing properties
|
|
* // will be replaced.
|
|
* },
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* storage.objects.setIamPolicy(request, function(err, response) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
*
|
|
* // TODO: Change code below to process the `response` object:
|
|
* console.log(JSON.stringify(response, null, 2));
|
|
* });
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.objects.setIamPolicy
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.bucket Name of the bucket in which the object resides.
|
|
* @param {string=} params.generation If present, selects a specific revision of this object (as opposed to the latest version, the default).
|
|
* @param {string} params.object Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
|
|
* @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets.
|
|
* @param {storage(v1).Policy} params.resource Request body data
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
setIamPolicy: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/b/{bucket}/o/{object}/iam').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'PUT'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['bucket', 'object'],
|
|
pathParams: ['bucket', 'object'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* storage.objects.testIamPermissions
|
|
*
|
|
* @desc Tests a set of permissions on the given object to see which, if any, are held by the caller.
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* // Name of the bucket in which the object resides.
|
|
* bucket: 'my-bucket', // TODO: Update placeholder value.
|
|
*
|
|
* // Name of the object. For information about how to URL encode object names to be path safe, see
|
|
* // Encoding URI Path Parts.
|
|
* object: 'my-object', // TODO: Update placeholder value.
|
|
*
|
|
* // Permissions to test.
|
|
* permissions: [], // TODO: Update placeholder value.
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* storage.objects.testIamPermissions(request, function(err, response) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
*
|
|
* // TODO: Change code below to process the `response` object:
|
|
* console.log(JSON.stringify(response, null, 2));
|
|
* });
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.objects.testIamPermissions
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.bucket Name of the bucket in which the object resides.
|
|
* @param {string=} params.generation If present, selects a specific revision of this object (as opposed to the latest version, the default).
|
|
* @param {string} params.object Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
|
|
* @param {string} params.permissions Permissions to test.
|
|
* @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets.
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
testIamPermissions: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/b/{bucket}/o/{object}/iam/testPermissions').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['bucket', 'object', 'permissions'],
|
|
pathParams: ['bucket', 'object'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* storage.objects.update
|
|
*
|
|
* @desc Updates an object's metadata.
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* // Name of the bucket in which the object resides.
|
|
* bucket: 'my-bucket', // TODO: Update placeholder value.
|
|
*
|
|
* // Name of the object. For information about how to URL encode object names to be path safe, see
|
|
* // Encoding URI Path Parts.
|
|
* object: 'my-object', // TODO: Update placeholder value.
|
|
*
|
|
* resource: {
|
|
* // TODO: Add desired properties to the request body. All existing properties
|
|
* // will be replaced.
|
|
* },
|
|
*
|
|
* // TODO: To download media content, use:
|
|
* //
|
|
* // alt: 'media',
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* storage.objects.update(request, function(err, response) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
*
|
|
* // TODO: Change code below to process the `response` object:
|
|
* console.log(JSON.stringify(response, null, 2));
|
|
* });
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.objects.update
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.bucket Name of the bucket in which the object resides.
|
|
* @param {string=} params.generation If present, selects a specific revision of this object (as opposed to the latest version, the default).
|
|
* @param {string=} params.ifGenerationMatch Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.
|
|
* @param {string=} params.ifGenerationNotMatch Makes the operation conditional on whether the object's current generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.
|
|
* @param {string=} params.ifMetagenerationMatch Makes the operation conditional on whether the object's current metageneration matches the given value.
|
|
* @param {string=} params.ifMetagenerationNotMatch Makes the operation conditional on whether the object's current metageneration does not match the given value.
|
|
* @param {string} params.object Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.
|
|
* @param {string=} params.predefinedAcl Apply a predefined set of access controls to this object.
|
|
* @param {string=} params.projection Set of properties to return. Defaults to full.
|
|
* @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets.
|
|
* @param {storage(v1).Object} params.resource Request body data
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
update: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/b/{bucket}/o/{object}').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'PUT'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['bucket', 'object'],
|
|
pathParams: ['bucket', 'object'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* storage.objects.watchAll
|
|
*
|
|
* @desc Watch for changes on all objects in a bucket.
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* // Name of the bucket in which to look for objects.
|
|
* bucket: 'my-bucket', // TODO: Update placeholder value.
|
|
*
|
|
* resource: {
|
|
* // TODO: Add desired properties to the request body.
|
|
* },
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* storage.objects.watchAll(request, function(err, response) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
*
|
|
* // TODO: Change code below to process the `response` object:
|
|
* console.log(JSON.stringify(response, null, 2));
|
|
* });
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.objects.watchAll
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.bucket Name of the bucket in which to look for objects.
|
|
* @param {string=} params.delimiter Returns results in a directory-like mode. items will contain only objects whose names, aside from the prefix, do not contain delimiter. Objects whose names, aside from the prefix, contain delimiter will have their name, truncated after the delimiter, returned in prefixes. Duplicate prefixes are omitted.
|
|
* @param {integer=} params.maxResults Maximum number of items plus prefixes to return in a single page of responses. As duplicate prefixes are omitted, fewer total results may be returned than requested. The service will use this parameter or 1,000 items, whichever is smaller.
|
|
* @param {string=} params.pageToken A previously-returned page token representing part of the larger set of results to view.
|
|
* @param {string=} params.prefix Filter results to objects whose names begin with this prefix.
|
|
* @param {string=} params.projection Set of properties to return. Defaults to noAcl.
|
|
* @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets.
|
|
* @param {boolean=} params.versions If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning.
|
|
* @param {storage(v1).Channel} params.resource Request body data
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
watchAll: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/b/{bucket}/o/watch').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'POST'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['bucket'],
|
|
pathParams: ['bucket'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
}
|
|
|
|
};
|
|
|
|
self.projects = {
|
|
serviceAccount: {
|
|
|
|
/**
|
|
* storage.projects.serviceAccount.get
|
|
*
|
|
* @desc Get the email address of this project's Google Cloud Storage service account.
|
|
*
|
|
* @example
|
|
* // BEFORE RUNNING:
|
|
* // ---------------
|
|
* // 1. If not already done, enable the Cloud Storage JSON API
|
|
* // and check the quota for your project at
|
|
* // https://console.developers.google.com/apis/api/storage
|
|
* // 2. This sample uses Application Default Credentials for authentication.
|
|
* // If not already done, install the gcloud CLI from
|
|
* // https://cloud.google.com/sdk and run
|
|
* // `gcloud beta auth application-default login`.
|
|
* // For more information, see
|
|
* // https://developers.google.com/identity/protocols/application-default-credentials
|
|
* // 3. Install the Node.js client library by running
|
|
* // `npm install googleapis --save`
|
|
*
|
|
* var google = require('googleapis');
|
|
* var storage = google.storage('v1');
|
|
*
|
|
* authorize(function(authClient) {
|
|
* var request = {
|
|
* // Project ID
|
|
* projectId: 'my-project-id', // TODO: Update placeholder value.
|
|
*
|
|
* auth: authClient,
|
|
* };
|
|
*
|
|
* storage.projects.serviceAccount.get(request, function(err, response) {
|
|
* if (err) {
|
|
* console.error(err);
|
|
* return;
|
|
* }
|
|
*
|
|
* // TODO: Change code below to process the `response` object:
|
|
* console.log(JSON.stringify(response, null, 2));
|
|
* });
|
|
* });
|
|
*
|
|
* function authorize(callback) {
|
|
* google.auth.getApplicationDefault(function(err, authClient) {
|
|
* if (err) {
|
|
* console.error('authentication failed: ', err);
|
|
* return;
|
|
* }
|
|
* if (authClient.createScopedRequired && authClient.createScopedRequired()) {
|
|
* var scopes = ['https://www.googleapis.com/auth/cloud-platform'];
|
|
* authClient = authClient.createScoped(scopes);
|
|
* }
|
|
* callback(authClient);
|
|
* });
|
|
* }
|
|
*
|
|
* @alias storage.projects.serviceAccount.get
|
|
* @memberOf! storage(v1)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.projectId Project ID
|
|
* @param {string=} params.userProject The project to be billed for this request, for Requester Pays buckets.
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
get: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://www.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/storage/v1/projects/{projectId}/serviceAccount').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['projectId'],
|
|
pathParams: ['projectId'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
}
|
|
}
|
|
};
|
|
}
|
|
|
|
/**
|
|
* @typedef Bucket
|
|
* @memberOf! storage(v1)
|
|
* @type object
|
|
* @property {storage(v1).BucketAccessControl[]} acl Access controls on the bucket.
|
|
* @property {object} billing The bucket's billing configuration.
|
|
* @property {object[]} cors The bucket's Cross-Origin Resource Sharing (CORS) configuration.
|
|
* @property {storage(v1).ObjectAccessControl[]} defaultObjectAcl Default access controls to apply to new objects when no ACL is provided.
|
|
* @property {object} encryption Encryption configuration used by default for newly inserted objects, when no encryption config is specified.
|
|
* @property {string} etag HTTP 1.1 Entity tag for the bucket.
|
|
* @property {string} id The ID of the bucket. For buckets, the id and name properities are the same.
|
|
* @property {string} kind The kind of item this is. For buckets, this is always storage#bucket.
|
|
* @property {object} labels User-provided labels, in key/value pairs.
|
|
* @property {object} lifecycle The bucket's lifecycle configuration. See lifecycle management for more information.
|
|
* @property {string} location The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the developer's guide for the authoritative list.
|
|
* @property {object} logging The bucket's logging configuration, which defines the destination bucket and optional name prefix for the current bucket's logs.
|
|
* @property {string} metageneration The metadata generation of this bucket.
|
|
* @property {string} name The name of the bucket.
|
|
* @property {object} owner The owner of the bucket. This is always the project team's owner group.
|
|
* @property {string} projectNumber The project number of the project the bucket belongs to.
|
|
* @property {string} selfLink The URI of this bucket.
|
|
* @property {string} storageClass The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.
|
|
* @property {string} timeCreated The creation time of the bucket in RFC 3339 format.
|
|
* @property {string} updated The modification time of the bucket in RFC 3339 format.
|
|
* @property {object} versioning The bucket's versioning configuration.
|
|
* @property {object} website The bucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site. See the Static Website Examples for more information.
|
|
*/
|
|
|
|
/**
|
|
* @typedef BucketAccessControl
|
|
* @memberOf! storage(v1)
|
|
* @type object
|
|
* @property {string} bucket The name of the bucket.
|
|
* @property {string} domain The domain associated with the entity, if any.
|
|
* @property {string} email The email address associated with the entity, if any.
|
|
* @property {string} entity The entity holding the permission, in one of the following forms:
|
|
- user-userId
|
|
- user-email
|
|
- group-groupId
|
|
- group-email
|
|
- domain-domain
|
|
- project-team-projectId
|
|
- allUsers
|
|
- allAuthenticatedUsers Examples:
|
|
- The user liz@example.com would be user-liz@example.com.
|
|
- The group example@googlegroups.com would be group-example@googlegroups.com.
|
|
- To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
|
|
* @property {string} entityId The ID for the entity, if any.
|
|
* @property {string} etag HTTP 1.1 Entity tag for the access-control entry.
|
|
* @property {string} id The ID of the access-control entry.
|
|
* @property {string} kind The kind of item this is. For bucket access control entries, this is always storage#bucketAccessControl.
|
|
* @property {object} projectTeam The project team associated with the entity, if any.
|
|
* @property {string} role The access permission for the entity.
|
|
* @property {string} selfLink The link to this access-control entry.
|
|
*/
|
|
|
|
/**
|
|
* @typedef BucketAccessControls
|
|
* @memberOf! storage(v1)
|
|
* @type object
|
|
* @property {storage(v1).BucketAccessControl[]} items The list of items.
|
|
* @property {string} kind The kind of item this is. For lists of bucket access control entries, this is always storage#bucketAccessControls.
|
|
*/
|
|
|
|
/**
|
|
* @typedef Buckets
|
|
* @memberOf! storage(v1)
|
|
* @type object
|
|
* @property {storage(v1).Bucket[]} items The list of items.
|
|
* @property {string} kind The kind of item this is. For lists of buckets, this is always storage#buckets.
|
|
* @property {string} nextPageToken The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
|
|
*/
|
|
|
|
/**
|
|
* @typedef Channel
|
|
* @memberOf! storage(v1)
|
|
* @type object
|
|
* @property {string} address The address where notifications are delivered for this channel.
|
|
* @property {string} expiration Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
|
|
* @property {string} id A UUID or similar unique string that identifies this channel.
|
|
* @property {string} kind Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
|
|
* @property {object} params Additional parameters controlling delivery channel behavior. Optional.
|
|
* @property {boolean} payload A Boolean value to indicate whether payload is wanted. Optional.
|
|
* @property {string} resourceId An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
|
|
* @property {string} resourceUri A version-specific identifier for the watched resource.
|
|
* @property {string} token An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
|
|
* @property {string} type The type of delivery mechanism used for this channel.
|
|
*/
|
|
|
|
/**
|
|
* @typedef ComposeRequest
|
|
* @memberOf! storage(v1)
|
|
* @type object
|
|
* @property {storage(v1).Object} destination Properties of the resulting object.
|
|
* @property {string} kind The kind of item this is.
|
|
* @property {object[]} sourceObjects The list of source objects that will be concatenated into a single object.
|
|
*/
|
|
|
|
/**
|
|
* @typedef Notification
|
|
* @memberOf! storage(v1)
|
|
* @type object
|
|
* @property {object} custom_attributes An optional list of additional attributes to attach to each Cloud PubSub message published for this notification subscription.
|
|
* @property {string} etag HTTP 1.1 Entity tag for this subscription notification.
|
|
* @property {string[]} event_types If present, only send notifications about listed event types. If empty, sent notifications for all event types.
|
|
* @property {string} id The ID of the notification.
|
|
* @property {string} kind The kind of item this is. For notifications, this is always storage#notification.
|
|
* @property {string} object_name_prefix If present, only apply this notification configuration to object names that begin with this prefix.
|
|
* @property {string} payload_format The desired content of the Payload.
|
|
* @property {string} selfLink The canonical URL of this notification.
|
|
* @property {string} topic The Cloud PubSub topic to which this subscription publishes. Formatted as: '//pubsub.googleapis.com/projects/{project-identifier}/topics/{my-topic}'
|
|
*/
|
|
|
|
/**
|
|
* @typedef Notifications
|
|
* @memberOf! storage(v1)
|
|
* @type object
|
|
* @property {storage(v1).Notification[]} items The list of items.
|
|
* @property {string} kind The kind of item this is. For lists of notifications, this is always storage#notifications.
|
|
*/
|
|
|
|
/**
|
|
* @typedef Object
|
|
* @memberOf! storage(v1)
|
|
* @type object
|
|
* @property {storage(v1).ObjectAccessControl[]} acl Access controls on the object.
|
|
* @property {string} bucket The name of the bucket containing this object.
|
|
* @property {string} cacheControl Cache-Control directive for the object data. If omitted, and the object is accessible to all anonymous users, the default will be public, max-age=3600.
|
|
* @property {integer} componentCount Number of underlying components that make up this object. Components are accumulated by compose operations.
|
|
* @property {string} contentDisposition Content-Disposition of the object data.
|
|
* @property {string} contentEncoding Content-Encoding of the object data.
|
|
* @property {string} contentLanguage Content-Language of the object data.
|
|
* @property {string} contentType Content-Type of the object data. If an object is stored without a Content-Type, it is served as application/octet-stream.
|
|
* @property {string} crc32c CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.
|
|
* @property {object} customerEncryption Metadata of customer-supplied encryption key, if the object is encrypted by such a key.
|
|
* @property {string} etag HTTP 1.1 Entity tag for the object.
|
|
* @property {string} generation The content generation of this object. Used for object versioning.
|
|
* @property {string} id The ID of the object, including the bucket name, object name, and generation number.
|
|
* @property {string} kind The kind of item this is. For objects, this is always storage#object.
|
|
* @property {string} kmsKeyName Cloud KMS Key used to encrypt this object, if the object is encrypted by such a key.
|
|
* @property {string} md5Hash MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.
|
|
* @property {string} mediaLink Media download link.
|
|
* @property {object} metadata User-provided metadata, in key/value pairs.
|
|
* @property {string} metageneration The version of the metadata for this object at this generation. Used for preconditions and for detecting changes in metadata. A metageneration number is only meaningful in the context of a particular generation of a particular object.
|
|
* @property {string} name The name of the object. Required if not specified by URL parameter.
|
|
* @property {object} owner The owner of the object. This will always be the uploader of the object.
|
|
* @property {string} selfLink The link to this object.
|
|
* @property {string} size Content-Length of the data in bytes.
|
|
* @property {string} storageClass Storage class of the object.
|
|
* @property {string} timeCreated The creation time of the object in RFC 3339 format.
|
|
* @property {string} timeDeleted The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.
|
|
* @property {string} timeStorageClassUpdated The time at which the object's storage class was last changed. When the object is initially created, it will be set to timeCreated.
|
|
* @property {string} updated The modification time of the object metadata in RFC 3339 format.
|
|
*/
|
|
|
|
/**
|
|
* @typedef ObjectAccessControl
|
|
* @memberOf! storage(v1)
|
|
* @type object
|
|
* @property {string} bucket The name of the bucket.
|
|
* @property {string} domain The domain associated with the entity, if any.
|
|
* @property {string} email The email address associated with the entity, if any.
|
|
* @property {string} entity The entity holding the permission, in one of the following forms:
|
|
- user-userId
|
|
- user-email
|
|
- group-groupId
|
|
- group-email
|
|
- domain-domain
|
|
- project-team-projectId
|
|
- allUsers
|
|
- allAuthenticatedUsers Examples:
|
|
- The user liz@example.com would be user-liz@example.com.
|
|
- The group example@googlegroups.com would be group-example@googlegroups.com.
|
|
- To refer to all members of the Google Apps for Business domain example.com, the entity would be domain-example.com.
|
|
* @property {string} entityId The ID for the entity, if any.
|
|
* @property {string} etag HTTP 1.1 Entity tag for the access-control entry.
|
|
* @property {string} generation The content generation of the object, if applied to an object.
|
|
* @property {string} id The ID of the access-control entry.
|
|
* @property {string} kind The kind of item this is. For object access control entries, this is always storage#objectAccessControl.
|
|
* @property {string} object The name of the object, if applied to an object.
|
|
* @property {object} projectTeam The project team associated with the entity, if any.
|
|
* @property {string} role The access permission for the entity.
|
|
* @property {string} selfLink The link to this access-control entry.
|
|
*/
|
|
|
|
/**
|
|
* @typedef ObjectAccessControls
|
|
* @memberOf! storage(v1)
|
|
* @type object
|
|
* @property {storage(v1).ObjectAccessControl[]} items The list of items.
|
|
* @property {string} kind The kind of item this is. For lists of object access control entries, this is always storage#objectAccessControls.
|
|
*/
|
|
|
|
/**
|
|
* @typedef Objects
|
|
* @memberOf! storage(v1)
|
|
* @type object
|
|
* @property {storage(v1).Object[]} items The list of items.
|
|
* @property {string} kind The kind of item this is. For lists of objects, this is always storage#objects.
|
|
* @property {string} nextPageToken The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
|
|
* @property {string[]} prefixes The list of prefixes of objects matching-but-not-listed up to and including the requested delimiter.
|
|
*/
|
|
|
|
/**
|
|
* @typedef Policy
|
|
* @memberOf! storage(v1)
|
|
* @type object
|
|
* @property {object[]} bindings An association between a role, which comes with a set of permissions, and members who may assume that role.
|
|
* @property {string} etag HTTP 1.1 Entity tag for the policy.
|
|
* @property {string} kind The kind of item this is. For policies, this is always storage#policy. This field is ignored on input.
|
|
* @property {string} resourceId The ID of the resource to which this policy belongs. Will be of the form projects/_/buckets/bucket for buckets, and projects/_/buckets/bucket/objects/object for objects. A specific generation may be specified by appending #generationNumber to the end of the object name, e.g. projects/_/buckets/my-bucket/objects/data.txt#17. The current generation can be denoted with #0. This field is ignored on input.
|
|
*/
|
|
|
|
/**
|
|
* @typedef RewriteResponse
|
|
* @memberOf! storage(v1)
|
|
* @type object
|
|
* @property {boolean} done true if the copy is finished; otherwise, false if the copy is in progress. This property is always present in the response.
|
|
* @property {string} kind The kind of item this is.
|
|
* @property {string} objectSize The total size of the object being copied in bytes. This property is always present in the response.
|
|
* @property {storage(v1).Object} resource A resource containing the metadata for the copied-to object. This property is present in the response only when copying completes.
|
|
* @property {string} rewriteToken A token to use in subsequent requests to continue copying data. This token is present in the response only when there is more data to copy.
|
|
* @property {string} totalBytesRewritten The total bytes written so far, which can be used to provide a waiting user with a progress indicator. This property is always present in the response.
|
|
*/
|
|
|
|
/**
|
|
* @typedef ServiceAccount
|
|
* @memberOf! storage(v1)
|
|
* @type object
|
|
* @property {string} email_address The ID of the notification.
|
|
* @property {string} kind The kind of item this is. For notifications, this is always storage#notification.
|
|
*/
|
|
|
|
/**
|
|
* @typedef TestIamPermissionsResponse
|
|
* @memberOf! storage(v1)
|
|
* @type object
|
|
* @property {string} kind The kind of item this is.
|
|
* @property {string[]} permissions The permissions held by the caller. Permissions are always of the format storage.resource.capability, where resource is one of buckets or objects. The supported permissions are as follows:
|
|
- storage.buckets.delete — Delete bucket.
|
|
- storage.buckets.get — Read bucket metadata.
|
|
- storage.buckets.getIamPolicy — Read bucket IAM policy.
|
|
- storage.buckets.create — Create bucket.
|
|
- storage.buckets.list — List buckets.
|
|
- storage.buckets.setIamPolicy — Update bucket IAM policy.
|
|
- storage.buckets.update — Update bucket metadata.
|
|
- storage.objects.delete — Delete object.
|
|
- storage.objects.get — Read object data and metadata.
|
|
- storage.objects.getIamPolicy — Read object IAM policy.
|
|
- storage.objects.create — Create object.
|
|
- storage.objects.list — List objects.
|
|
- storage.objects.setIamPolicy — Update object IAM policy.
|
|
- storage.objects.update — Update object metadata.
|
|
*/
|
|
export = Storage;
|