Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

refactor!: mark bucket.setLabels and associated interfaces as deprecated #2214

Merged
merged 3 commits into from
Jul 19, 2023
Merged

refactor!: mark bucket.setLabels and associated interfaces as deprecated #2214

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d4997b6
refactor!: mark bucket.setLabels and associated interfaces as deprecated
ddelgrosso1 Jun 7, 2023
88691a4
update addBucketLabel to use setMetadata
ddelgrosso1 Jun 9, 2023
26f9ae0
mark getLabels / deleteLabels deprecated, update samples
ddelgrosso1 Jun 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/bucket.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3530,20 +3530,24 @@ class Bucket extends ServiceObject {
callback: SetLabelsCallback
): void;
/**
* @deprecated
* @typedef {array} SetLabelsResponse
* @property {object} 0 The bucket metadata.
*/
/**
* @deprecated
* @callback SetLabelsCallback
* @param {?Error} err Request error, if any.
* @param {object} metadata The bucket metadata.
*/
/**
* @deprecated
* @typedef {object} SetLabelsOptions Configuration options for Bucket#setLabels().
* @property {string} [userProject] The ID of the project which will be
* billed for the request.
*/
/**
* @deprecated Use setMetadata directly.
Copy link
Member

@frankyn frankyn Jun 7, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is the expectation to update setLabels samples as well in a follow-up PR?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah good catch, I will update that in this PR.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated addBucketLabel sample to use setMetadata.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks Denis!

* Set labels on the bucket.
*
* This makes an underlying call to {@link Bucket#setMetadata}, which
Expand Down