Client library for Cloud Storage JSON API
npm install --save @datafire/google_storage
let google_storage = require('@datafire/google_storage').create({
access_token: "",
refresh_token: "",
client_id: "",
client_secret: "",
redirect_uri: ""
});
.then(data => {
console.log(data);
});
Stores and retrieves potentially large, immutable data objects.
Exchange the code passed to your redirect URI for an access_token
google_storage.oauthCallback({
"code": ""
}, context)
object
string
object
string
string
string
string
string
Exchange a refresh_token for an access_token
google_storage.oauthRefresh(null, context)
This action has no parameters
object
string
string
string
string
string
Retrieves a list of buckets for a given project.
google_storage.storage.buckets.list({
"project": ""
}, context)
object
string
: A valid API project identifier.integer
: Maximum number of buckets to return in a single response. The service will use this parameter or 1,000 items, whichever is smaller.string
: A previously-returned page token representing part of the larger set of results to view.string
: Filter results to buckets whose names begin with this prefix.string
(values: full, noAcl): Set of properties to return. Defaults to noAcl.string
: The project to be billed for this request if the target bucket is requester-pays bucket.string
: The project to be billed for this request.string
(values: json): Data format for the response.string
: Selector specifying which fields to include in a partial response.string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string
: Deprecated. Please use quotaUser instead.Creates a new bucket.
google_storage.storage.buckets.insert({
"project": ""
}, context)
object
string
: A valid API project identifier.string
(values: authenticatedRead, private, projectPrivate, publicRead, publicReadWrite): Apply a predefined set of access controls to this bucket.string
(values: authenticatedRead, bucketOwnerFullControl, bucketOwnerRead, private, projectPrivate, publicRead): Apply a predefined set of default object access controls to this bucket.string
(values: full, noAcl): Set of properties to return. Defaults to noAcl, unless the bucket resource specifies acl or defaultObjectAcl properties, when it defaults to full.string
: The project to be billed for this request if the target bucket is requester-pays bucket.string
: The project to be billed for this request.string
(values: json): Data format for the response.string
: Selector specifying which fields to include in a partial response.string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string
: Deprecated. Please use quotaUser instead.Permanently deletes an empty bucket.
google_storage.storage.buckets.delete({
"bucket": ""
}, context)
object
string
: Name of a bucket.string
: If set, only deletes the bucket if its metageneration matches this value.string
: If set, only deletes the bucket if its metageneration does not match this value.string
: The project to be billed for this request if the target bucket is requester-pays bucket.string
: The project to be billed for this request. Required for Requester Pays buckets.string
(values: json): Data format for the response.string
: Selector specifying which fields to include in a partial response.string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string
: Deprecated. Please use quotaUser instead.Output schema unknown
Returns metadata for the specified bucket.
google_storage.storage.buckets.get({
"bucket": ""
}, context)
object
string
: Name of a bucket.string
: Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.string
: Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value.string
(values: full, noAcl): Set of properties to return. Defaults to noAcl.string
: The project to be billed for this request if the target bucket is requester-pays bucket.string
: The project to be billed for this request. Required for Requester Pays buckets.string
(values: json): Data format for the response.string
: Selector specifying which fields to include in a partial response.string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string
: Deprecated. Please use quotaUser instead.Patches a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.
google_storage.storage.buckets.patch({
"bucket": ""
}, context)
object
string
: Name of a bucket.string
: Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.string
: Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value.string
(values: authenticatedRead, private, projectPrivate, publicRead, publicReadWrite): Apply a predefined set of access controls to this bucket.string
(values: authenticatedRead, bucketOwnerFullControl, bucketOwnerRead, private, projectPrivate, publicRead): Apply a predefined set of default object access controls to this bucket.string
(values: full, noAcl): Set of properties to return. Defaults to full.string
: The project to be billed for this request if the target bucket is requester-pays bucket.string
: The project to be billed for this request. Required for Requester Pays buckets.string
(values: json): Data format for the response.string
: Selector specifying which fields to include in a partial response.string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string
: Deprecated. Please use quotaUser instead.Updates a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.
google_storage.storage.buckets.update({
"bucket": ""
}, context)
object
string
: Name of a bucket.string
: Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.string
: Makes the return of the bucket metadata conditional on whether the bucket's current metageneration does not match the given value.string
(values: authenticatedRead, private, projectPrivate, publicRead, publicReadWrite): Apply a predefined set of access controls to this bucket.string
(values: authenticatedRead, bucketOwnerFullControl, bucketOwnerRead, private, projectPrivate, publicRead): Apply a predefined set of default object access controls to this bucket.string
(values: full, noAcl): Set of properties to return. Defaults to full.string
: The project to be billed for this request if the target bucket is requester-pays bucket.string
: The project to be billed for this request. Required for Requester Pays buckets.string
(values: json): Data format for the response.string
: Selector specifying which fields to include in a partial response.string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string
: Deprecated. Please use quotaUser instead.Retrieves ACL entries on the specified bucket.
google_storage.storage.bucketAccessControls.list({
"bucket": ""
}, context)
object
string
: Name of a bucket.string
: The project to be billed for this request if the target bucket is requester-pays bucket.string
: The project to be billed for this request. Required for Requester Pays buckets.string
(values: json): Data format for the response.string
: Selector specifying which fields to include in a partial response.string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string
: Deprecated. Please use quotaUser instead.Creates a new ACL entry on the specified bucket.
google_storage.storage.bucketAccessControls.insert({
"bucket": ""
}, context)
object
string
: Name of a bucket.string
: The project to be billed for this request if the target bucket is requester-pays bucket.string
: The project to be billed for this request. Required for Requester Pays buckets.string
(values: json): Data format for the response.string
: Selector specifying which fields to include in a partial response.string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string
: Deprecated. Please use quotaUser instead.Permanently deletes the ACL entry for the specified entity on the specified bucket.
google_storage.storage.bucketAccessControls.delete({
"bucket": "",
"entity": ""
}, context)
object
string
: Name of a bucket.string
: The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.string
: The project to be billed for this request if the target bucket is requester-pays bucket.string
: The project to be billed for this request. Required for Requester Pays buckets.string
(values: json): Data format for the response.string
: Selector specifying which fields to include in a partial response.string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string
: Deprecated. Please use quotaUser instead.Output schema unknown
Returns the ACL entry for the specified entity on the specified bucket.
google_storage.storage.bucketAccessControls.get({
"bucket": "",
"entity": ""
}, context)
object
string
: Name of a bucket.string
: The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.string
: The project to be billed for this request if the target bucket is requester-pays bucket.string
: The project to be billed for this request. Required for Requester Pays buckets.string
(values: json): Data format for the response.string
: Selector specifying which fields to include in a partial response.string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string
: Deprecated. Please use quotaUser instead.Patches an ACL entry on the specified bucket.
google_storage.storage.bucketAccessControls.patch({
"bucket": "",
"entity": ""
}, context)
object
string
: Name of a bucket.string
: The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.string
: The project to be billed for this request if the target bucket is requester-pays bucket.string
: The project to be billed for this request. Required for Requester Pays buckets.string
(values: json): Data format for the response.string
: Selector specifying which fields to include in a partial response.string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string
: Deprecated. Please use quotaUser instead.Updates an ACL entry on the specified bucket.
google_storage.storage.bucketAccessControls.update({
"bucket": "",
"entity": ""
}, context)
object
string
: Name of a bucket.string
: The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.string
: The project to be billed for this request if the target bucket is requester-pays bucket.string
: The project to be billed for this request. Required for Requester Pays buckets.string
(values: json): Data format for the response.string
: Selector specifying which fields to include in a partial response.string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string
: Deprecated. Please use quotaUser instead.Retrieves default object ACL entries on the specified bucket.
google_storage.storage.defaultObjectAccessControls.list({
"bucket": ""
}, context)
object
string
: Name of a bucket.string
: If present, only return default ACL listing if the bucket's current metageneration matches this value.string
: If present, only return default ACL listing if the bucket's current metageneration does not match the given value.string
: The project to be billed for this request if the target bucket is requester-pays bucket.string
: The project to be billed for this request. Required for Requester Pays buckets.string
(values: json): Data format for the response.string
: Selector specifying which fields to include in a partial response.string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string
: Deprecated. Please use quotaUser instead.Creates a new default object ACL entry on the specified bucket.
google_storage.storage.defaultObjectAccessControls.insert({
"bucket": ""
}, context)
object
string
: Name of a bucket.string
: The project to be billed for this request if the target bucket is requester-pays bucket.string
: The project to be billed for this request. Required for Requester Pays buckets.string
(values: json): Data format for the response.string
: Selector specifying which fields to include in a partial response.string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string
: Deprecated. Please use quotaUser instead.Permanently deletes the default object ACL entry for the specified entity on the specified bucket.
google_storage.storage.defaultObjectAccessControls.delete({
"bucket": "",
"entity": ""
}, context)
object
string
: Name of a bucket.string
: The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.string
: The project to be billed for this request if the target bucket is requester-pays bucket.string
: The project to be billed for this request. Required for Requester Pays buckets.string
(values: json): Data format for the response.string
: Selector specifying which fields to include in a partial response.string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string
: Deprecated. Please use quotaUser instead.Output schema unknown
Returns the default object ACL entry for the specified entity on the specified bucket.
google_storage.storage.defaultObjectAccessControls.get({
"bucket": "",
"entity": ""
}, context)
object
string
: Name of a bucket.string
: The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.string
: The project to be billed for this request if the target bucket is requester-pays bucket.string
: The project to be billed for this request. Required for Requester Pays buckets.string
(values: json): Data format for the response.string
: Selector specifying which fields to include in a partial response.string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string
: Deprecated. Please use quotaUser instead.Patches a default object ACL entry on the specified bucket.
google_storage.storage.defaultObjectAccessControls.patch({
"bucket": "",
"entity": ""
}, context)
object
string
: Name of a bucket.string
: The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.string
: The project to be billed for this request if the target bucket is requester-pays bucket.string
: The project to be billed for this request. Required for Requester Pays buckets.string
(values: json): Data format for the response.string
: Selector specifying which fields to include in a partial response.string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string
: Deprecated. Please use quotaUser instead.Updates a default object ACL entry on the specified bucket.
google_storage.storage.defaultObjectAccessControls.update({
"bucket": "",
"entity": ""
}, context)
object
string
: Name of a bucket.string
: The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.string
: The project to be billed for this request if the target bucket is requester-pays bucket.string
: The project to be billed for this request. Required for Requester Pays buckets.string
(values: json): Data format for the response.string
: Selector specifying which fields to include in a partial response.string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string
: Deprecated. Please use quotaUser instead.Returns an IAM policy for the specified bucket.
google_storage.storage.buckets.getIamPolicy({
"bucket": ""
}, context)
object
string
: Name of a bucket.integer
: The IAM policy format version to be returned. If the optionsRequestedPolicyVersion is for an older version that doesn't support part of the requested IAM policy, the request fails.string
: The project to be billed for this request if the target bucket is requester-pays bucket.string
: The project to be billed for this request. Required for Requester Pays buckets.string
(values: json): Data format for the response.string
: Selector specifying which fields to include in a partial response.string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string
: Deprecated. Please use quotaUser instead.Updates an IAM policy for the specified bucket.
google_storage.storage.buckets.setIamPolicy({
"bucket": ""
}, context)
object
string
: Name of a bucket.string
: The project to be billed for this request if the target bucket is requester-pays bucket.string
: The project to be billed for this request. Required for Requester Pays buckets.string
(values: json): Data format for the response.string
: Selector specifying which fields to include in a partial response.string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string
: Deprecated. Please use quotaUser instead.Tests a set of permissions on the given bucket to see which, if any, are held by the caller.
google_storage.storage.buckets.testIamPermissions({
"bucket": "",
"permissions": []
}, context)
object
string
: Name of a bucket.array
: Permissions to test.string
: The project to be billed for this request if the target bucket is requester-pays bucket.string
: The project to be billed for this request. Required for Requester Pays buckets.string
(values: json): Data format for the response.string
: Selector specifying which fields to include in a partial response.string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string
: Deprecated. Please use quotaUser instead.Locks retention policy on a bucket.
google_storage.storage.buckets.lockRetentionPolicy({
"bucket": "",
"ifMetagenerationMatch": ""
}, context)
object
string
: Name of a bucket.string
: Makes the operation conditional on whether bucket's current metageneration matches the given value.string
: The project to be billed for this request if the target bucket is requester-pays bucket.string
: The project to be billed for this request. Required for Requester Pays buckets.string
(values: json): Data format for the response.string
: Selector specifying which fields to include in a partial response.string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string
: Deprecated. Please use quotaUser instead.Retrieves a list of notification subscriptions for a given bucket.
google_storage.storage.notifications.list({
"bucket": ""
}, context)
object
string
: Name of a Google Cloud Storage bucket.string
: The project to be billed for this request if the target bucket is requester-pays bucket.string
: The project to be billed for this request. Required for Requester Pays buckets.string
(values: json): Data format for the response.string
: Selector specifying which fields to include in a partial response.string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string
: Deprecated. Please use quotaUser instead.Creates a notification subscription for a given bucket.
google_storage.storage.notifications.insert({
"bucket": ""
}, context)
object
string
: The parent bucket of the notification.string
: The project to be billed for this request if the target bucket is requester-pays bucket.string
: The project to be billed for this request. Required for Requester Pays buckets.string
(values: json): Data format for the response.string
: Selector specifying which fields to include in a partial response.string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string
: Deprecated. Please use quotaUser instead.Permanently deletes a notification subscription.
google_storage.storage.notifications.delete({
"bucket": "",
"notification": ""
}, context)
object
string
: The parent bucket of the notification.string
: ID of the notification to delete.string
: The project to be billed for this request if the target bucket is requester-pays bucket.string
: The project to be billed for this request. Required for Requester Pays buckets.string
(values: json): Data format for the response.string
: Selector specifying which fields to include in a partial response.string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string
: Deprecated. Please use quotaUser instead.Output schema unknown
View a notification configuration.
google_storage.storage.notifications.get({
"bucket": "",
"notification": ""
}, context)
object
string
: The parent bucket of the notification.string
: Notification IDstring
: The project to be billed for this request if the target bucket is requester-pays bucket.string
: The project to be billed for this request. Required for Requester Pays buckets.string
(values: json): Data format for the response.string
: Selector specifying which fields to include in a partial response.string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string
: Deprecated. Please use quotaUser instead.Retrieves a list of objects matching the criteria.
google_storage.storage.objects.list({
"bucket": ""
}, context)
object
string
: Name of the bucket in which to look for objects.string
: 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.string
: Filter results to objects whose names are lexicographically before endOffset. If startOffset is also set, the objects listed will have names between startOffset (inclusive) and endOffset (exclusive).boolean
: If true, objects that end in exactly one instance of delimiter will have their metadata included in items in addition to prefixes.integer
: 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.string
: A previously-returned page token representing part of the larger set of results to view.string
: Filter results to objects whose names begin with this prefix.string
(values: full, noAcl): Set of properties to return. Defaults to noAcl.string
: The project to be billed for this request if the target bucket is requester-pays bucket.string
: Filter results to objects whose names are lexicographically equal to or after startOffset. If endOffset is also set, the objects listed will have names between startOffset (inclusive) and endOffset (exclusive).string
: The project to be billed for this request. Required for Requester Pays buckets.boolean
: If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning.string
(values: json): Data format for the response.string
: Selector specifying which fields to include in a partial response.string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string
: Deprecated. Please use quotaUser instead.Stores a new object and metadata.
google_storage.storage.objects.insert({
"bucket": ""
}, context)
object
string
: Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.string
: 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.string
: 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.string
: 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.string
: Makes the operation conditional on whether the object's current metageneration matches the given value.string
: Makes the operation conditional on whether the object's current metageneration does not match the given value.string
: 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.string
: 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.string
(values: authenticatedRead, bucketOwnerFullControl, bucketOwnerRead, private, projectPrivate, publicRead): Apply a predefined set of access controls to this object.string
(values: full, noAcl): Set of properties to return. Defaults to noAcl, unless the object resource specifies the acl property, when it defaults to full.string
: The project to be billed for this request if the target bucket is requester-pays bucket.string
: The project to be billed for this request. Required for Requester Pays buckets.string
(values: json): Data format for the response.string
: Selector specifying which fields to include in a partial response.string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string
: Deprecated. Please use quotaUser instead.Watch for changes on all objects in a bucket.
google_storage.storage.objects.watchAll({
"bucket": ""
}, context)
object
string
: Name of the bucket in which to look for objects.string
: 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.string
: Filter results to objects whose names are lexicographically before endOffset. If startOffset is also set, the objects listed will have names between startOffset (inclusive) and endOffset (exclusive).boolean
: If true, objects that end in exactly one instance of delimiter will have their metadata included in items in addition to prefixes.integer
: 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.string
: A previously-returned page token representing part of the larger set of results to view.string
: Filter results to objects whose names begin with this prefix.string
(values: full, noAcl): Set of properties to return. Defaults to noAcl.string
: The project to be billed for this request if the target bucket is requester-pays bucket.string
: Filter results to objects whose names are lexicographically equal to or after startOffset. If endOffset is also set, the objects listed will have names between startOffset (inclusive) and endOffset (exclusive).string
: The project to be billed for this request. Required for Requester Pays buckets.boolean
: If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning.string
(values: json): Data format for the response.string
: Selector specifying which fields to include in a partial response.string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string
: Deprecated. Please use quotaUser instead.Deletes an object and its metadata. Deletions are permanent if versioning is not enabled for the bucket, or if the generation parameter is used.
google_storage.storage.objects.delete({
"bucket": "",
"object": ""
}, context)
object
string
: Name of the bucket in which the object resides.string
: Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.string
: If present, permanently deletes a specific revision of this object (as opposed to the latest version, the default).string
: 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.string
: 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.string
: Makes the operation conditional on whether the object's current metageneration matches the given value.string
: Makes the operation conditional on whether the object's current metageneration does not match the given value.string
: The project to be billed for this request if the target bucket is requester-pays bucket.string
: The project to be billed for this request. Required for Requester Pays buckets.string
(values: json): Data format for the response.string
: Selector specifying which fields to include in a partial response.string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string
: Deprecated. Please use quotaUser instead.Output schema unknown
Retrieves an object or its metadata.
google_storage.storage.objects.get({
"bucket": "",
"object": ""
}, context)
object
string
: Name of the bucket in which the object resides.string
: Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.string
: If present, selects a specific revision of this object (as opposed to the latest version, the default).string
: 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.string
: 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.string
: Makes the operation conditional on whether the object's current metageneration matches the given value.string
: Makes the operation conditional on whether the object's current metageneration does not match the given value.string
(values: full, noAcl): Set of properties to return. Defaults to noAcl.string
: The project to be billed for this request if the target bucket is requester-pays bucket.string
: The project to be billed for this request. Required for Requester Pays buckets.string
(values: json): Data format for the response.string
: Selector specifying which fields to include in a partial response.string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string
: Deprecated. Please use quotaUser instead.Patches an object's metadata.
google_storage.storage.objects.patch({
"bucket": "",
"object": ""
}, context)
object
string
: Name of the bucket in which the object resides.string
: Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.string
: If present, selects a specific revision of this object (as opposed to the latest version, the default).string
: 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.string
: 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.string
: Makes the operation conditional on whether the object's current metageneration matches the given value.string
: Makes the operation conditional on whether the object's current metageneration does not match the given value.string
(values: authenticatedRead, bucketOwnerFullControl, bucketOwnerRead, private, projectPrivate, publicRead): Apply a predefined set of access controls to this object.string
(values: full, noAcl): Set of properties to return. Defaults to full.string
: The project to be billed for this request if the target bucket is requester-pays bucket.string
: The project to be billed for this request, for Requester Pays buckets.string
(values: json): Data format for the response.string
: Selector specifying which fields to include in a partial response.string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string
: Deprecated. Please use quotaUser instead.Updates an object's metadata.
google_storage.storage.objects.update({
"bucket": "",
"object": ""
}, context)
object
string
: Name of the bucket in which the object resides.string
: Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.string
: If present, selects a specific revision of this object (as opposed to the latest version, the default).string
: 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.string
: 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.string
: Makes the operation conditional on whether the object's current metageneration matches the given value.string
: Makes the operation conditional on whether the object's current metageneration does not match the given value.string
(values: authenticatedRead, bucketOwnerFullControl, bucketOwnerRead, private, projectPrivate, publicRead): Apply a predefined set of access controls to this object.string
(values: full, noAcl): Set of properties to return. Defaults to full.string
: The project to be billed for this request if the target bucket is requester-pays bucket.string
: The project to be billed for this request. Required for Requester Pays buckets.string
(values: json): Data format for the response.string
: Selector specifying which fields to include in a partial response.string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string
: Deprecated. Please use quotaUser instead.Retrieves ACL entries on the specified object.
google_storage.storage.objectAccessControls.list({
"bucket": "",
"object": ""
}, context)
object
string
: Name of a bucket.string
: Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.string
: If present, selects a specific revision of this object (as opposed to the latest version, the default).string
: The project to be billed for this request if the target bucket is requester-pays bucket.string
: The project to be billed for this request. Required for Requester Pays buckets.string
(values: json): Data format for the response.string
: Selector specifying which fields to include in a partial response.string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string
: Deprecated. Please use quotaUser instead.Creates a new ACL entry on the specified object.
google_storage.storage.objectAccessControls.insert({
"bucket": "",
"object": ""
}, context)
object
string
: Name of a bucket.string
: Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.string
: If present, selects a specific revision of this object (as opposed to the latest version, the default).string
: The project to be billed for this request if the target bucket is requester-pays bucket.string
: The project to be billed for this request. Required for Requester Pays buckets.string
(values: json): Data format for the response.string
: Selector specifying which fields to include in a partial response.string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string
: Deprecated. Please use quotaUser instead.Permanently deletes the ACL entry for the specified entity on the specified object.
google_storage.storage.objectAccessControls.delete({
"bucket": "",
"object": "",
"entity": ""
}, context)
object
string
: Name of a bucket.string
: Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.string
: The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.string
: If present, selects a specific revision of this object (as opposed to the latest version, the default).string
: The project to be billed for this request if the target bucket is requester-pays bucket.string
: The project to be billed for this request. Required for Requester Pays buckets.string
(values: json): Data format for the response.string
: Selector specifying which fields to include in a partial response.string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string
: Deprecated. Please use quotaUser instead.Output schema unknown
Returns the ACL entry for the specified entity on the specified object.
google_storage.storage.objectAccessControls.get({
"bucket": "",
"object": "",
"entity": ""
}, context)
object
string
: Name of a bucket.string
: Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.string
: The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.string
: If present, selects a specific revision of this object (as opposed to the latest version, the default).string
: The project to be billed for this request if the target bucket is requester-pays bucket.string
: The project to be billed for this request. Required for Requester Pays buckets.string
(values: json): Data format for the response.string
: Selector specifying which fields to include in a partial response.string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string
: Deprecated. Please use quotaUser instead.Patches an ACL entry on the specified object.
google_storage.storage.objectAccessControls.patch({
"bucket": "",
"object": "",
"entity": ""
}, context)
object
string
: Name of a bucket.string
: Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.string
: The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.string
: If present, selects a specific revision of this object (as opposed to the latest version, the default).string
: The project to be billed for this request if the target bucket is requester-pays bucket.string
: The project to be billed for this request. Required for Requester Pays buckets.string
(values: json): Data format for the response.string
: Selector specifying which fields to include in a partial response.string
: API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.string
: OAuth 2.0 token for the current user.boolean
: Returns response with indentations and line breaks.string
: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.string
: Deprecated. Please use quotaUser instead.Updates an ACL entry on the specified object.
Version | Tag | Published |
---|---|---|
6.0.0 | latest | 2yrs ago |