Class Bucket (5.11.1)

Stay organized with collections Save and categorize content based on your preferences.

constructor(storage: Storage, name: string, options?: BucketOptions);

acl: Acl;

getFilesStream: Function;

iam: Iam;

metadata: Metadata;

name: string;

signer?: URLSigner;

storage: Storage;

userProject?: string;

addLifecycleRule(rule: LifecycleRule, options?: AddLifecycleRuleOptions): Promise<SetBucketMetadataResponse>;

addLifecycleRule(rule: LifecycleRule, options: AddLifecycleRuleOptions, callback: SetBucketMetadataCallback): void;

addLifecycleRule(rule: LifecycleRule, callback: SetBucketMetadataCallback): void;

combine(sources: string[] | File[], destination: string | File, options?: CombineOptions): Promise<CombineResponse>;

combine(sources: string[] | File[], destination: string | File, options: CombineOptions, callback: CombineCallback): void;

combine(sources: string[] | File[], destination: string | File, callback: CombineCallback): void;

createChannel(id: string, config: CreateChannelConfig, options?: CreateChannelOptions): Promise<CreateChannelResponse>;

createChannel(id: string, config: CreateChannelConfig, callback: CreateChannelCallback): void;

createChannel(id: string, config: CreateChannelConfig, options: CreateChannelOptions, callback: CreateChannelCallback): void;

createNotification(topic: string, options?: CreateNotificationOptions): Promise<CreateNotificationResponse>;

createNotification(topic: string, options: CreateNotificationOptions, callback: CreateNotificationCallback): void;

createNotification(topic: string, callback: CreateNotificationCallback): void;

deleteFiles(query?: DeleteFilesOptions): Promise<void>;

deleteFiles(callback: DeleteFilesCallback): void;

deleteFiles(query: DeleteFilesOptions, callback: DeleteFilesCallback): void;

deleteLabels(labels?: string | string[]): Promise<DeleteLabelsResponse>;

deleteLabels(callback: DeleteLabelsCallback): void;

deleteLabels(labels: string | string[], callback: DeleteLabelsCallback): void;

disableRequesterPays(): Promise<DisableRequesterPaysResponse>;

disableRequesterPays(callback: DisableRequesterPaysCallback): void;

enableLogging(config: EnableLoggingOptions): Promise<SetBucketMetadataResponse>;

enableLogging(config: EnableLoggingOptions, callback: SetBucketMetadataCallback): void;

enableRequesterPays(): Promise<EnableRequesterPaysResponse>;

enableRequesterPays(callback: EnableRequesterPaysCallback): void;

file(name: string, options?: FileOptions): File;

getFiles(query?: GetFilesOptions): Promise<GetFilesResponse>;

getFiles(query: GetFilesOptions, callback: GetFilesCallback): void;

getFiles(callback: GetFilesCallback): void;

getId(): string;

getLabels(options: GetLabelsOptions): Promise<GetLabelsResponse>;

getLabels(callback: GetLabelsCallback): void;

getLabels(options: GetLabelsOptions, callback: GetLabelsCallback): void;

getNotifications(options?: GetNotificationsOptions): Promise<GetNotificationsResponse>;

getNotifications(callback: GetNotificationsCallback): void;

getNotifications(options: GetNotificationsOptions, callback: GetNotificationsCallback): void;

getSignedUrl(cfg: GetBucketSignedUrlConfig): Promise<GetSignedUrlResponse>;

getSignedUrl(cfg: GetBucketSignedUrlConfig, callback: GetSignedUrlCallback): void;

lock(metageneration: number | string): Promise<BucketLockResponse>;

lock(metageneration: number | string, callback: BucketLockCallback): void;

makeAllFilesPublicPrivate_(options?: MakeAllFilesPublicPrivateOptions): Promise<MakeAllFilesPublicPrivateResponse>;

makeAllFilesPublicPrivate_(callback: MakeAllFilesPublicPrivateCallback): void;

makeAllFilesPublicPrivate_(options: MakeAllFilesPublicPrivateOptions, callback: MakeAllFilesPublicPrivateCallback): void;

makePrivate(options?: MakeBucketPrivateOptions): Promise<MakeBucketPrivateResponse>;

makePrivate(callback: MakeBucketPrivateCallback): void;

makePrivate(options: MakeBucketPrivateOptions, callback: MakeBucketPrivateCallback): void;

makePublic(options?: MakeBucketPublicOptions): Promise<MakeBucketPublicResponse>;

makePublic(callback: MakeBucketPublicCallback): void;

makePublic(options: MakeBucketPublicOptions, callback: MakeBucketPublicCallback): void;

notification(id: string): Notification;

removeRetentionPeriod(): Promise<SetBucketMetadataResponse>;

removeRetentionPeriod(callback: SetBucketMetadataCallback): void;

request(reqOpts: DecorateRequestOptions): Promise<[ResponseBody, Metadata]>;

request(reqOpts: DecorateRequestOptions, callback: BodyResponseCallback): void;

setCorsConfiguration(corsConfiguration: Cors[]): Promise<SetBucketMetadataResponse>;

setCorsConfiguration(corsConfiguration: Cors[], callback: SetBucketMetadataCallback): void;

setLabels(labels: Labels, options?: SetLabelsOptions): Promise<SetLabelsResponse>;

setLabels(labels: Labels, callback: SetLabelsCallback): void;

setLabels(labels: Labels, options: SetLabelsOptions, callback: SetLabelsCallback): void;

setRetentionPeriod(duration: number): Promise<SetBucketMetadataResponse>;

setRetentionPeriod(duration: number, callback: SetBucketMetadataCallback): void;

setStorageClass(storageClass: string, options?: SetBucketStorageClassOptions): Promise<SetBucketMetadataResponse>;

setStorageClass(storageClass: string, callback: SetBucketStorageClassCallback): void;

setStorageClass(storageClass: string, options: SetBucketStorageClassOptions, callback: SetBucketStorageClassCallback): void;

setUserProject(userProject: string): void;

upload(pathString: string, options?: UploadOptions): Promise<UploadResponse>;

upload(pathString: string, options: UploadOptions, callback: UploadCallback): void;

upload(pathString: string, callback: UploadCallback): void;