Storage

import { Storage } from "https://googleapis.deno.dev/v1/storage:v1.ts";

Stores and retrieves potentially large, immutable data objects.

class Storage {

constructor(client?: CredentialsClient, baseUrl?: string);

async anywhereCachesDisable(anywhereCacheId: string, bucket: string): Promise<AnywhereCache>;

async anywhereCachesGet(anywhereCacheId: string, bucket: string): Promise<AnywhereCache>;

async anywhereCachesInsert(bucket: string, req: AnywhereCache): Promise<GoogleLongrunningOperation>;

async anywhereCachesList(bucket: string, opts?: AnywhereCachesListOptions): Promise<AnywhereCaches>;

async anywhereCachesPause(anywhereCacheId: string, bucket: string): Promise<AnywhereCache>;

async anywhereCachesResume(anywhereCacheId: string, bucket: string): Promise<AnywhereCache>;

async anywhereCachesUpdate(

anywhereCacheId: string,

bucket: string,

req: AnywhereCache,

): Promise<GoogleLongrunningOperation>;

async bucketAccessControlsDelete(

bucket: string,

entity: string,

opts?: BucketAccessControlsDeleteOptions,

): Promise<void>;

async bucketAccessControlsGet(

bucket: string,

entity: string,

opts?: BucketAccessControlsGetOptions,

): Promise<BucketAccessControl>;

async bucketAccessControlsInsert(

bucket: string,

req: BucketAccessControl,

opts?: BucketAccessControlsInsertOptions,

): Promise<BucketAccessControl>;

async bucketAccessControlsList(bucket: string, opts?: BucketAccessControlsListOptions): Promise<BucketAccessControls>;

async bucketAccessControlsPatch(

bucket: string,

entity: string,

req: BucketAccessControl,

opts?: BucketAccessControlsPatchOptions,

): Promise<BucketAccessControl>;

async bucketAccessControlsUpdate(

bucket: string,

entity: string,

req: BucketAccessControl,

opts?: BucketAccessControlsUpdateOptions,

): Promise<BucketAccessControl>;

async bucketsDelete(bucket: string, opts?: BucketsDeleteOptions): Promise<void>;

async bucketsGet(bucket: string, opts?: BucketsGetOptions): Promise<Bucket>;

async bucketsGetIamPolicy(bucket: string, opts?: BucketsGetIamPolicyOptions): Promise<Policy>;

async bucketsInsert(req: Bucket, opts?: BucketsInsertOptions): Promise<Bucket>;

async bucketsList(opts?: BucketsListOptions): Promise<Buckets>;

async bucketsLockRetentionPolicy(bucket: string, opts?: BucketsLockRetentionPolicyOptions): Promise<Bucket>;

async bucketsPatch(

bucket: string,

req: Bucket,

opts?: BucketsPatchOptions,

): Promise<Bucket>;

async bucketsSetIamPolicy(

bucket: string,

req: Policy,

opts?: BucketsSetIamPolicyOptions,

): Promise<Policy>;

async bucketsTestIamPermissions(bucket: string, opts?: BucketsTestIamPermissionsOptions): Promise<TestIamPermissionsResponse>;

async bucketsUpdate(

bucket: string,

req: Bucket,

opts?: BucketsUpdateOptions,

): Promise<Bucket>;

async channelsStop(req: Channel): Promise<void>;

async defaultObjectAccessControlsDelete(

bucket: string,

entity: string,

opts?: DefaultObjectAccessControlsDeleteOptions,

): Promise<void>;

async defaultObjectAccessControlsGet(

bucket: string,

entity: string,

opts?: DefaultObjectAccessControlsGetOptions,

): Promise<ObjectAccessControl>;

async defaultObjectAccessControlsInsert(

bucket: string,

req: ObjectAccessControl,

opts?: DefaultObjectAccessControlsInsertOptions,

): Promise<ObjectAccessControl>;

async defaultObjectAccessControlsList(bucket: string, opts?: DefaultObjectAccessControlsListOptions): Promise<ObjectAccessControls>;

async defaultObjectAccessControlsPatch(

bucket: string,

entity: string,

req: ObjectAccessControl,

opts?: DefaultObjectAccessControlsPatchOptions,

): Promise<ObjectAccessControl>;

async defaultObjectAccessControlsUpdate(

bucket: string,

entity: string,

req: ObjectAccessControl,

opts?: DefaultObjectAccessControlsUpdateOptions,

): Promise<ObjectAccessControl>;

async foldersDelete(

bucket: string,

folder: string,

opts?: FoldersDeleteOptions,

): Promise<void>;

async foldersGet(

bucket: string,

folder: string,

opts?: FoldersGetOptions,

): Promise<Folder>;

async foldersInsert(

bucket: string,

req: Folder,

opts?: FoldersInsertOptions,

): Promise<Folder>;

async foldersList(bucket: string, opts?: FoldersListOptions): Promise<Folders>;

async foldersRename(

bucket: string,

destinationFolder: string,

sourceFolder: string,

opts?: FoldersRenameOptions,

): Promise<GoogleLongrunningOperation>;

async managedFoldersDelete(

bucket: string,

managedFolder: string,

opts?: ManagedFoldersDeleteOptions,

): Promise<void>;

async managedFoldersGet(

bucket: string,

managedFolder: string,

opts?: ManagedFoldersGetOptions,

): Promise<ManagedFolder>;

async managedFoldersGetIamPolicy(

bucket: string,

managedFolder: string,

opts?: ManagedFoldersGetIamPolicyOptions,

): Promise<Policy>;

async managedFoldersInsert(bucket: string, req: ManagedFolder): Promise<ManagedFolder>;

async managedFoldersList(bucket: string, opts?: ManagedFoldersListOptions): Promise<ManagedFolders>;

async managedFoldersSetIamPolicy(

bucket: string,

managedFolder: string,

req: Policy,

opts?: ManagedFoldersSetIamPolicyOptions,

): Promise<Policy>;

async managedFoldersTestIamPermissions(

bucket: string,

managedFolder: string,

opts?: ManagedFoldersTestIamPermissionsOptions,

): Promise<TestIamPermissionsResponse>;

async notificationsDelete(

bucket: string,

notification: string,

opts?: NotificationsDeleteOptions,

): Promise<void>;

async notificationsGet(

bucket: string,

notification: string,

opts?: NotificationsGetOptions,

): Promise<Notification>;

async notificationsInsert(

bucket: string,

req: Notification,

opts?: NotificationsInsertOptions,

): Promise<Notification>;

async notificationsList(bucket: string, opts?: NotificationsListOptions): Promise<Notifications>;

async objectAccessControlsDelete(

bucket: string,

entity: string,

object: string,

opts?: ObjectAccessControlsDeleteOptions,

): Promise<void>;

async objectAccessControlsGet(

bucket: string,

entity: string,

object: string,

opts?: ObjectAccessControlsGetOptions,

): Promise<ObjectAccessControl>;

async objectAccessControlsInsert(

bucket: string,

object: string,

req: ObjectAccessControl,

opts?: ObjectAccessControlsInsertOptions,

): Promise<ObjectAccessControl>;

async objectAccessControlsList(

bucket: string,

object: string,

opts?: ObjectAccessControlsListOptions,

): Promise<ObjectAccessControls>;

async objectAccessControlsPatch(

bucket: string,

entity: string,

object: string,

req: ObjectAccessControl,

opts?: ObjectAccessControlsPatchOptions,

): Promise<ObjectAccessControl>;

async objectAccessControlsUpdate(

bucket: string,

entity: string,

object: string,

req: ObjectAccessControl,

opts?: ObjectAccessControlsUpdateOptions,

): Promise<ObjectAccessControl>;

async objectsBulkRestore(bucket: string, req: BulkRestoreObjectsRequest): Promise<GoogleLongrunningOperation>;

async objectsCompose(

destinationBucket: string,

destinationObject: string,

req: ComposeRequest,

opts?: ObjectsComposeOptions,

): Promise<Object>;

async objectsCopy(

destinationBucket: string,

destinationObject: string,

sourceBucket: string,

sourceObject: string,

req: Object,

opts?: ObjectsCopyOptions,

): Promise<Object>;

async objectsDelete(

bucket: string,

object: string,

opts?: ObjectsDeleteOptions,

): Promise<void>;

async objectsGet(

bucket: string,

object: string,

opts?: ObjectsGetOptions,

): Promise<Object>;

async objectsGetIamPolicy(

bucket: string,

object: string,

opts?: ObjectsGetIamPolicyOptions,

): Promise<Policy>;

async objectsInsert(

bucket: string,

req: Object,

opts?: ObjectsInsertOptions,

): Promise<Object>;

async objectsList(bucket: string, opts?: ObjectsListOptions): Promise<Objects>;

async objectsPatch(

bucket: string,

object: string,

req: Object,

opts?: ObjectsPatchOptions,

): Promise<Object>;

async objectsRestore(

bucket: string,

object: string,

opts?: ObjectsRestoreOptions,

): Promise<Object>;

async objectsRewrite(

destinationBucket: string,

destinationObject: string,

sourceBucket: string,

sourceObject: string,

req: Object,

opts?: ObjectsRewriteOptions,

): Promise<RewriteResponse>;

async objectsSetIamPolicy(

bucket: string,

object: string,

req: Policy,

opts?: ObjectsSetIamPolicyOptions,

): Promise<Policy>;

async objectsTestIamPermissions(

bucket: string,

object: string,

opts?: ObjectsTestIamPermissionsOptions,

): Promise<TestIamPermissionsResponse>;

async objectsUpdate(

bucket: string,

object: string,

req: Object,

opts?: ObjectsUpdateOptions,

): Promise<Object>;

async objectsWatchAll(

bucket: string,

req: Channel,

opts?: ObjectsWatchAllOptions,

): Promise<Channel>;

async operationsCancel(bucket: string, operationId: string): Promise<void>;

async operationsGet(bucket: string, operationId: string): Promise<GoogleLongrunningOperation>;

async operationsList(bucket: string, opts?: OperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>;

async projectsHmacKeysCreate(projectId: string, opts?: ProjectsHmacKeysCreateOptions): Promise<HmacKey>;

async projectsHmacKeysDelete(

accessId: string,

projectId: string,

opts?: ProjectsHmacKeysDeleteOptions,

): Promise<void>;

async projectsHmacKeysGet(

accessId: string,

projectId: string,

opts?: ProjectsHmacKeysGetOptions,

): Promise<HmacKeyMetadata>;

async projectsHmacKeysList(projectId: string, opts?: ProjectsHmacKeysListOptions): Promise<HmacKeysMetadata>;

async projectsHmacKeysUpdate(

accessId: string,

projectId: string,

req: HmacKeyMetadata,

opts?: ProjectsHmacKeysUpdateOptions,

): Promise<HmacKeyMetadata>;

async projectsServiceAccountGet(projectId: string, opts?: ProjectsServiceAccountGetOptions): Promise<ServiceAccount>;

}

§Constructors

new Storage(client?: CredentialsClient, baseUrl?: string)

[src]

§Methods

anywhereCachesDisable(anywhereCacheId: string, bucket: string): Promise<AnywhereCache>

[src]

Disables an Anywhere Cache instance.

@param anywhereCacheId

The ID of requested Anywhere Cache instance.

@param bucket

Name of the parent bucket.

anywhereCachesGet(anywhereCacheId: string, bucket: string): Promise<AnywhereCache>

[src]

Returns the metadata of an Anywhere Cache instance.

@param anywhereCacheId

The ID of requested Anywhere Cache instance.

@param bucket

Name of the parent bucket.

anywhereCachesInsert(bucket: string, req: AnywhereCache): Promise<GoogleLongrunningOperation>

[src]

Creates an Anywhere Cache instance.

@param bucket

Name of the parent bucket.

anywhereCachesList(bucket: string, opts?: AnywhereCachesListOptions): Promise<AnywhereCaches>

[src]

Returns a list of Anywhere Cache instances of the bucket matching the criteria.

@param bucket

Name of the parent bucket.

anywhereCachesPause(anywhereCacheId: string, bucket: string): Promise<AnywhereCache>

[src]

Pauses an Anywhere Cache instance.

@param anywhereCacheId

The ID of requested Anywhere Cache instance.

@param bucket

Name of the parent bucket.

anywhereCachesResume(anywhereCacheId: string, bucket: string): Promise<AnywhereCache>

[src]

Resumes a paused or disabled Anywhere Cache instance.

@param anywhereCacheId

The ID of requested Anywhere Cache instance.

@param bucket

Name of the parent bucket.

anywhereCachesUpdate(anywhereCacheId: string, bucket: string, req: AnywhereCache): Promise<GoogleLongrunningOperation>

[src]

Updates the config(ttl and admissionPolicy) of an Anywhere Cache instance.

@param anywhereCacheId

The ID of requested Anywhere Cache instance.

@param bucket

Name of the parent bucket.

bucketAccessControlsDelete(bucket: string, entity: string, opts?: BucketAccessControlsDeleteOptions): Promise<void>

[src]

Permanently deletes the ACL entry for the specified entity on the specified bucket.

@param bucket

Name of a bucket.

@param entity

The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.

bucketAccessControlsGet(bucket: string, entity: string, opts?: BucketAccessControlsGetOptions): Promise<BucketAccessControl>

[src]

Returns the ACL entry for the specified entity on the specified bucket.

@param bucket

Name of a bucket.

@param entity

The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.

bucketAccessControlsInsert(bucket: string, req: BucketAccessControl, opts?: BucketAccessControlsInsertOptions): Promise<BucketAccessControl>

[src]

Creates a new ACL entry on the specified bucket.

@param bucket

Name of a bucket.

bucketAccessControlsList(bucket: string, opts?: BucketAccessControlsListOptions): Promise<BucketAccessControls>

[src]

Retrieves ACL entries on the specified bucket.

@param bucket

Name of a bucket.

bucketAccessControlsPatch(bucket: string, entity: string, req: BucketAccessControl, opts?: BucketAccessControlsPatchOptions): Promise<BucketAccessControl>

[src]

Patches an ACL entry on the specified bucket.

@param bucket

Name of a bucket.

@param entity

The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.

bucketAccessControlsUpdate(bucket: string, entity: string, req: BucketAccessControl, opts?: BucketAccessControlsUpdateOptions): Promise<BucketAccessControl>

[src]

Updates an ACL entry on the specified bucket.

@param bucket

Name of a bucket.

@param entity

The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.

bucketsDelete(bucket: string, opts?: BucketsDeleteOptions): Promise<void>

[src]

Permanently deletes an empty bucket.

@param bucket

Name of a bucket.

bucketsGet(bucket: string, opts?: BucketsGetOptions): Promise<Bucket>

[src]

Returns metadata for the specified bucket.

@param bucket

Name of a bucket.

bucketsGetIamPolicy(bucket: string, opts?: BucketsGetIamPolicyOptions): Promise<Policy>

[src]

Returns an IAM policy for the specified bucket.

@param bucket

Name of a bucket.

bucketsInsert(req: Bucket, opts?: BucketsInsertOptions): Promise<Bucket>

[src]

Creates a new bucket.

bucketsList(opts?: BucketsListOptions): Promise<Buckets>

[src]

Retrieves a list of buckets for a given project.

bucketsLockRetentionPolicy(bucket: string, opts?: BucketsLockRetentionPolicyOptions): Promise<Bucket>

[src]

Locks retention policy on a bucket.

@param bucket

Name of a bucket.

bucketsPatch(bucket: string, req: Bucket, opts?: BucketsPatchOptions): Promise<Bucket>

[src]

Patches a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.

@param bucket

Name of a bucket.

bucketsSetIamPolicy(bucket: string, req: Policy, opts?: BucketsSetIamPolicyOptions): Promise<Policy>

[src]

Updates an IAM policy for the specified bucket.

@param bucket

Name of a bucket.

bucketsTestIamPermissions(bucket: string, opts?: BucketsTestIamPermissionsOptions): Promise<TestIamPermissionsResponse>

[src]

Tests a set of permissions on the given bucket to see which, if any, are held by the caller.

@param bucket

Name of a bucket.

bucketsUpdate(bucket: string, req: Bucket, opts?: BucketsUpdateOptions): Promise<Bucket>

[src]

Updates a bucket. Changes to the bucket will be readable immediately after writing, but configuration changes may take time to propagate.

@param bucket

Name of a bucket.

channelsStop(req: Channel): Promise<void>

[src]

Stop watching resources through this channel

defaultObjectAccessControlsDelete(bucket: string, entity: string, opts?: DefaultObjectAccessControlsDeleteOptions): Promise<void>

[src]

Permanently deletes the default object ACL entry for the specified entity on the specified bucket.

@param bucket

Name of a bucket.

@param entity

The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.

defaultObjectAccessControlsGet(bucket: string, entity: string, opts?: DefaultObjectAccessControlsGetOptions): Promise<ObjectAccessControl>

[src]

Returns the default object ACL entry for the specified entity on the specified bucket.

@param bucket

Name of a bucket.

@param entity

The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.

defaultObjectAccessControlsInsert(bucket: string, req: ObjectAccessControl, opts?: DefaultObjectAccessControlsInsertOptions): Promise<ObjectAccessControl>

[src]

Creates a new default object ACL entry on the specified bucket.

@param bucket

Name of a bucket.

defaultObjectAccessControlsList(bucket: string, opts?: DefaultObjectAccessControlsListOptions): Promise<ObjectAccessControls>

[src]

Retrieves default object ACL entries on the specified bucket.

@param bucket

Name of a bucket.

defaultObjectAccessControlsPatch(bucket: string, entity: string, req: ObjectAccessControl, opts?: DefaultObjectAccessControlsPatchOptions): Promise<ObjectAccessControl>

[src]

Patches a default object ACL entry on the specified bucket.

@param bucket

Name of a bucket.

@param entity

The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.

defaultObjectAccessControlsUpdate(bucket: string, entity: string, req: ObjectAccessControl, opts?: DefaultObjectAccessControlsUpdateOptions): Promise<ObjectAccessControl>

[src]

Updates a default object ACL entry on the specified bucket.

@param bucket

Name of a bucket.

@param entity

The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.

foldersDelete(bucket: string, folder: string, opts?: FoldersDeleteOptions): Promise<void>

[src]

Permanently deletes a folder. Only applicable to buckets with hierarchical namespace enabled.

@param bucket

Name of the bucket in which the folder resides.

@param folder

Name of a folder.

foldersGet(bucket: string, folder: string, opts?: FoldersGetOptions): Promise<Folder>

[src]

Returns metadata for the specified folder. Only applicable to buckets with hierarchical namespace enabled.

@param bucket

Name of the bucket in which the folder resides.

@param folder

Name of a folder.

foldersInsert(bucket: string, req: Folder, opts?: FoldersInsertOptions): Promise<Folder>

[src]

Creates a new folder. Only applicable to buckets with hierarchical namespace enabled.

@param bucket

Name of the bucket in which the folder resides.

foldersList(bucket: string, opts?: FoldersListOptions): Promise<Folders>

[src]

Retrieves a list of folders matching the criteria. Only applicable to buckets with hierarchical namespace enabled.

@param bucket

Name of the bucket in which to look for folders.

foldersRename(bucket: string, destinationFolder: string, sourceFolder: string, opts?: FoldersRenameOptions): Promise<GoogleLongrunningOperation>

[src]

Renames a source folder to a destination folder. Only applicable to buckets with hierarchical namespace enabled.

@param bucket

Name of the bucket in which the folders are in.

@param destinationFolder

Name of the destination folder.

@param sourceFolder

Name of the source folder.

managedFoldersDelete(bucket: string, managedFolder: string, opts?: ManagedFoldersDeleteOptions): Promise<void>

[src]

Permanently deletes a managed folder.

@param bucket

Name of the bucket containing the managed folder.

@param managedFolder

The managed folder name/path.

managedFoldersGet(bucket: string, managedFolder: string, opts?: ManagedFoldersGetOptions): Promise<ManagedFolder>

[src]

Returns metadata of the specified managed folder.

@param bucket

Name of the bucket containing the managed folder.

@param managedFolder

The managed folder name/path.

managedFoldersGetIamPolicy(bucket: string, managedFolder: string, opts?: ManagedFoldersGetIamPolicyOptions): Promise<Policy>

[src]

Returns an IAM policy for the specified managed folder.

@param bucket

Name of the bucket containing the managed folder.

@param managedFolder

The managed folder name/path.

managedFoldersInsert(bucket: string, req: ManagedFolder): Promise<ManagedFolder>

[src]

Creates a new managed folder.

@param bucket

Name of the bucket containing the managed folder.

managedFoldersList(bucket: string, opts?: ManagedFoldersListOptions): Promise<ManagedFolders>

[src]

Lists managed folders in the given bucket.

@param bucket

Name of the bucket containing the managed folder.

managedFoldersSetIamPolicy(bucket: string, managedFolder: string, req: Policy, opts?: ManagedFoldersSetIamPolicyOptions): Promise<Policy>

[src]

Updates an IAM policy for the specified managed folder.

@param bucket

Name of the bucket containing the managed folder.

@param managedFolder

The managed folder name/path.

managedFoldersTestIamPermissions(bucket: string, managedFolder: string, opts?: ManagedFoldersTestIamPermissionsOptions): Promise<TestIamPermissionsResponse>

[src]

Tests a set of permissions on the given managed folder to see which, if any, are held by the caller.

@param bucket

Name of the bucket containing the managed folder.

@param managedFolder

The managed folder name/path.

notificationsDelete(bucket: string, notification: string, opts?: NotificationsDeleteOptions): Promise<void>

[src]

Permanently deletes a notification subscription.

@param bucket

The parent bucket of the notification.

@param notification

ID of the notification to delete.

notificationsGet(bucket: string, notification: string, opts?: NotificationsGetOptions): Promise<Notification>

[src]

View a notification configuration.

@param bucket

The parent bucket of the notification.

@param notification

Notification ID

notificationsInsert(bucket: string, req: Notification, opts?: NotificationsInsertOptions): Promise<Notification>

[src]

Creates a notification subscription for a given bucket.

@param bucket

The parent bucket of the notification.

notificationsList(bucket: string, opts?: NotificationsListOptions): Promise<Notifications>

[src]

Retrieves a list of notification subscriptions for a given bucket.

@param bucket

Name of a Google Cloud Storage bucket.

objectAccessControlsDelete(bucket: string, entity: string, object: string, opts?: ObjectAccessControlsDeleteOptions): Promise<void>

[src]

Permanently deletes the ACL entry for the specified entity on the specified object.

@param bucket

Name of a bucket.

@param entity

The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.

@param object

Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.

objectAccessControlsGet(bucket: string, entity: string, object: string, opts?: ObjectAccessControlsGetOptions): Promise<ObjectAccessControl>

[src]

Returns the ACL entry for the specified entity on the specified object.

@param bucket

Name of a bucket.

@param entity

The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.

@param object

Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.

objectAccessControlsInsert(bucket: string, object: string, req: ObjectAccessControl, opts?: ObjectAccessControlsInsertOptions): Promise<ObjectAccessControl>

[src]

Creates a new ACL entry on the specified object.

@param bucket

Name of a bucket.

@param object

Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.

objectAccessControlsList(bucket: string, object: string, opts?: ObjectAccessControlsListOptions): Promise<ObjectAccessControls>

[src]

Retrieves ACL entries on the specified object.

@param bucket

Name of a bucket.

@param object

Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.

objectAccessControlsPatch(bucket: string, entity: string, object: string, req: ObjectAccessControl, opts?: ObjectAccessControlsPatchOptions): Promise<ObjectAccessControl>

[src]

Patches an ACL entry on the specified object.

@param bucket

Name of a bucket.

@param entity

The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.

@param object

Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.

objectAccessControlsUpdate(bucket: string, entity: string, object: string, req: ObjectAccessControl, opts?: ObjectAccessControlsUpdateOptions): Promise<ObjectAccessControl>

[src]

Updates an ACL entry on the specified object.

@param bucket

Name of a bucket.

@param entity

The entity holding the permission. Can be user-userId, user-emailAddress, group-groupId, group-emailAddress, allUsers, or allAuthenticatedUsers.

@param object

Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.

objectsBulkRestore(bucket: string, req: BulkRestoreObjectsRequest): Promise<GoogleLongrunningOperation>

[src]

Initiates a long-running bulk restore operation on the specified bucket.

@param bucket

Name of the bucket in which the object resides.

objectsCompose(destinationBucket: string, destinationObject: string, req: ComposeRequest, opts?: ObjectsComposeOptions): Promise<Object>

[src]

Concatenates a list of existing objects into a new object in the same bucket.

@param destinationBucket

Name of the bucket containing the source objects. The destination object is stored in this bucket.

@param destinationObject

Name of the new object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.

objectsCopy(destinationBucket: string, destinationObject: string, sourceBucket: string, sourceObject: string, req: Object, opts?: ObjectsCopyOptions): Promise<Object>

[src]

Copies a source object to a destination object. Optionally overrides metadata.

@param 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 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 sourceBucket

Name of the bucket in which to find the source object.

@param sourceObject

Name of the source object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.

objectsDelete(bucket: string, object: string, opts?: ObjectsDeleteOptions): Promise<void>

[src]

Deletes an object and its metadata. Deletions are permanent if versioning is not enabled for the bucket, or if the generation parameter is used.

@param bucket

Name of the bucket in which the object resides.

@param object

Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.

objectsGet(bucket: string, object: string, opts?: ObjectsGetOptions): Promise<Object>

[src]

Retrieves an object or its metadata.

@param bucket

Name of the bucket in which the object resides.

@param object

Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.

objectsGetIamPolicy(bucket: string, object: string, opts?: ObjectsGetIamPolicyOptions): Promise<Policy>

[src]

Returns an IAM policy for the specified object.

@param bucket

Name of the bucket in which the object resides.

@param object

Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.

objectsInsert(bucket: string, req: Object, opts?: ObjectsInsertOptions): Promise<Object>

[src]

Stores a new object and metadata.

@param bucket

Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.

objectsList(bucket: string, opts?: ObjectsListOptions): Promise<Objects>

[src]

Retrieves a list of objects matching the criteria.

@param bucket

Name of the bucket in which to look for objects.

objectsPatch(bucket: string, object: string, req: Object, opts?: ObjectsPatchOptions): Promise<Object>

[src]

Patches an object's metadata.

@param bucket

Name of the bucket in which the object resides.

@param object

Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.

objectsRestore(bucket: string, object: string, opts?: ObjectsRestoreOptions): Promise<Object>

[src]

Restores a soft-deleted object.

@param bucket

Name of the bucket in which the object resides.

@param object

Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.

objectsRewrite(destinationBucket: string, destinationObject: string, sourceBucket: string, sourceObject: string, req: Object, opts?: ObjectsRewriteOptions): Promise<RewriteResponse>

[src]

Rewrites a source object to a destination object. Optionally overrides metadata.

@param destinationBucket

Name of the bucket in which to store the new object. Overrides the provided object metadata's bucket value, if any.

@param 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 sourceBucket

Name of the bucket in which to find the source object.

@param sourceObject

Name of the source object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.

objectsSetIamPolicy(bucket: string, object: string, req: Policy, opts?: ObjectsSetIamPolicyOptions): Promise<Policy>

[src]

Updates an IAM policy for the specified object.

@param bucket

Name of the bucket in which the object resides.

@param object

Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.

objectsTestIamPermissions(bucket: string, object: string, opts?: ObjectsTestIamPermissionsOptions): Promise<TestIamPermissionsResponse>

[src]

Tests a set of permissions on the given object to see which, if any, are held by the caller.

@param bucket

Name of the bucket in which the object resides.

@param object

Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.

objectsUpdate(bucket: string, object: string, req: Object, opts?: ObjectsUpdateOptions): Promise<Object>

[src]

Updates an object's metadata.

@param bucket

Name of the bucket in which the object resides.

@param object

Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.

objectsWatchAll(bucket: string, req: Channel, opts?: ObjectsWatchAllOptions): Promise<Channel>

[src]

Watch for changes on all objects in a bucket.

@param bucket

Name of the bucket in which to look for objects.

operationsCancel(bucket: string, operationId: string): Promise<void>

[src]

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed.

@param bucket

The parent bucket of the operation resource.

@param operationId

The ID of the operation resource.

operationsGet(bucket: string, operationId: string): Promise<GoogleLongrunningOperation>

[src]

Gets the latest state of a long-running operation.

@param bucket

The parent bucket of the operation resource.

@param operationId

The ID of the operation resource.

operationsList(bucket: string, opts?: OperationsListOptions): Promise<GoogleLongrunningListOperationsResponse>

[src]

Lists operations that match the specified filter in the request.

@param bucket

Name of the bucket in which to look for operations.

projectsHmacKeysCreate(projectId: string, opts?: ProjectsHmacKeysCreateOptions): Promise<HmacKey>

[src]

Creates a new HMAC key for the specified service account.

@param projectId

Project ID owning the service account.

projectsHmacKeysDelete(accessId: string, projectId: string, opts?: ProjectsHmacKeysDeleteOptions): Promise<void>

[src]

Deletes an HMAC key.

@param accessId

Name of the HMAC key to be deleted.

@param projectId

Project ID owning the requested key

projectsHmacKeysGet(accessId: string, projectId: string, opts?: ProjectsHmacKeysGetOptions): Promise<HmacKeyMetadata>

[src]

Retrieves an HMAC key's metadata

@param accessId

Name of the HMAC key.

@param projectId

Project ID owning the service account of the requested key.

projectsHmacKeysList(projectId: string, opts?: ProjectsHmacKeysListOptions): Promise<HmacKeysMetadata>

[src]

Retrieves a list of HMAC keys matching the criteria.

@param projectId

Name of the project in which to look for HMAC keys.

projectsHmacKeysUpdate(accessId: string, projectId: string, req: HmacKeyMetadata, opts?: ProjectsHmacKeysUpdateOptions): Promise<HmacKeyMetadata>

[src]

Updates the state of an HMAC key. See the HMAC Key resource descriptor for valid states.

@param accessId

Name of the HMAC key being updated.

@param projectId

Project ID owning the service account of the updated key.

projectsServiceAccountGet(projectId: string, opts?: ProjectsServiceAccountGetOptions): Promise<ServiceAccount>

[src]

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

@param projectId

Project ID