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.

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

feat(pubsub): add support for snapshot labels #6835

Merged
merged 4 commits into from Oct 11, 2022

Conversation

hongalex
Copy link
Member

@hongalex hongalex commented Oct 11, 2022

The way to update labels for snapshots will be a bit different than for topic/subscriptions. You need to call snapshot.SetLabels after one has been created.

I decided against adding labels through a new UpdateSnapshot method since snapshots cannot be meaningfully modified after creation. In addition, subscription.CreateSnapshot doesn't support SnapshotConfigs so supporting that would expand the API surface. Not adding this is consistent with the UI in Cloud Console where snapshots can be labelled only after creation.

Closes #6838

@hongalex hongalex requested review from a team and shollyman as code owners October 11, 2022 00:53
@product-auto-label product-auto-label bot added size: s Pull request size is small. api: pubsub Issues related to the Pub/Sub API. labels Oct 11, 2022
@@ -42,11 +43,32 @@ func (s *Snapshot) ID() string {
return s.name[slash+1:]
}

// SetLabels replaces the current set of labels completely with the new set.
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe "SetLabels set or replaces the labels on a given snapshot."

The existing docstring seems overly focused on the replace case.

Labels: label,
},
UpdateMask: &fmpb.FieldMask{
Paths: fields,
Copy link
Contributor

Choose a reason for hiding this comment

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

you don't appear to manipulate the fields in the mask, maybe just declare the paths using a literal ex:

Paths: []string{"labels"},

@@ -43,17 +43,15 @@ func (s *Snapshot) ID() string {
return s.name[slash+1:]
}

// SetLabels replaces the current set of labels completely with the new set.
// SetLabels set or replaces the labels on a given snapshot.
Copy link
Contributor

Choose a reason for hiding this comment

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

set -> sets? Clearly I am a dubious provider of docstring advice.

@hongalex hongalex merged commit c17851b into googleapis:main Oct 11, 2022
@hongalex hongalex deleted the pubsub-snapshot-labels branch October 11, 2022 19:56
gcf-merge-on-green bot pushed a commit that referenced this pull request Oct 24, 2022
🤖 I have created a release *beep* *boop*
---


## [1.26.0](https://togithub.com/googleapis/google-cloud-go/compare/pubsub/v1.25.1...pubsub/v1.26.0) (2022-10-24)


### Features

* **pubsub:** Add support for snapshot labels ([#6835](https://togithub.com/googleapis/google-cloud-go/issues/6835)) ([c17851b](https://togithub.com/googleapis/google-cloud-go/commit/c17851b5c3d811cd3e6a28162f0e399bb31a1363))


### Bug Fixes

* **pubsub:** Remove unused AckResult map ([#6656](https://togithub.com/googleapis/google-cloud-go/issues/6656)) ([5f69002](https://togithub.com/googleapis/google-cloud-go/commit/5f690022551ac584e5c66af4324a17d7044a898d))


### Documentation

* **pubsub:** Fix comments on message for exactly once delivery ([#6878](https://togithub.com/googleapis/google-cloud-go/issues/6878)) ([a8109e2](https://togithub.com/googleapis/google-cloud-go/commit/a8109e2d3257d1698ce1b751618428ef25cbb859)), refs [#6877](https://togithub.com/googleapis/google-cloud-go/issues/6877)
* **pubsub:** Update streams section ([#6682](https://togithub.com/googleapis/google-cloud-go/issues/6682)) ([7b4e2b4](https://togithub.com/googleapis/google-cloud-go/commit/7b4e2b412058f965a9f9159231afe551a6f58a74))
* **pubsub:** Update subscription retry policy defaults ([#6909](https://togithub.com/googleapis/google-cloud-go/issues/6909)) ([c5c2f8f](https://togithub.com/googleapis/google-cloud-go/commit/c5c2f8f7125034c611edf1d08ca35ece6554c454)), refs [#6903](https://togithub.com/googleapis/google-cloud-go/issues/6903)

---
This PR was generated with [Release Please](https://togithub.com/googleapis/release-please). See [documentation](https://togithub.com/googleapis/release-please#release-please).
kimihrr pushed a commit to kimihrr/google-cloud-go-kimia that referenced this pull request Oct 25, 2022
🤖 I have created a release *beep* *boop*
---


## [1.26.0](https://togithub.com/googleapis/google-cloud-go/compare/pubsub/v1.25.1...pubsub/v1.26.0) (2022-10-24)


### Features

* **pubsub:** Add support for snapshot labels ([googleapis#6835](https://togithub.com/googleapis/google-cloud-go/issues/6835)) ([c17851b](https://togithub.com/googleapis/google-cloud-go/commit/c17851b5c3d811cd3e6a28162f0e399bb31a1363))


### Bug Fixes

* **pubsub:** Remove unused AckResult map ([googleapis#6656](https://togithub.com/googleapis/google-cloud-go/issues/6656)) ([5f69002](https://togithub.com/googleapis/google-cloud-go/commit/5f690022551ac584e5c66af4324a17d7044a898d))


### Documentation

* **pubsub:** Fix comments on message for exactly once delivery ([googleapis#6878](https://togithub.com/googleapis/google-cloud-go/issues/6878)) ([a8109e2](https://togithub.com/googleapis/google-cloud-go/commit/a8109e2d3257d1698ce1b751618428ef25cbb859)), refs [googleapis#6877](https://togithub.com/googleapis/google-cloud-go/issues/6877)
* **pubsub:** Update streams section ([googleapis#6682](https://togithub.com/googleapis/google-cloud-go/issues/6682)) ([7b4e2b4](https://togithub.com/googleapis/google-cloud-go/commit/7b4e2b412058f965a9f9159231afe551a6f58a74))
* **pubsub:** Update subscription retry policy defaults ([googleapis#6909](https://togithub.com/googleapis/google-cloud-go/issues/6909)) ([c5c2f8f](https://togithub.com/googleapis/google-cloud-go/commit/c5c2f8f7125034c611edf1d08ca35ece6554c454)), refs [googleapis#6903](https://togithub.com/googleapis/google-cloud-go/issues/6903)

---
This PR was generated with [Release Please](https://togithub.com/googleapis/release-please). See [documentation](https://togithub.com/googleapis/release-please#release-please).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: pubsub Issues related to the Pub/Sub API. size: s Pull request size is small.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

pubsub: support labels for snapshots
2 participants