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

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

Merged
merged 4 commits into from Oct 11, 2022
Merged

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

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c339137
feat(pubsub): add support for snapshot labels
hongalex Oct 11, 2022
dc95994
update comments and field construction
hongalex Oct 11, 2022
9e576ac
fix typo in comment
hongalex Oct 11, 2022
4dda742
Merge branch 'main' into pubsub-snapshot-labels
hongalex Oct 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
9 changes: 9 additions & 0 deletions pubsub/integration_test.go
View file
Open in desktop
Expand Up @@ -164,6 +164,15 @@ func TestIntegration_All(t *testing.T) {
t.Fatalf("CreateSnapshot error: %v", err)
}

labels := map[string]string{"foo": "bar"}
sc, err := snap.SetLabels(ctx, labels)
if err != nil {
t.Fatalf("Snapshot.SetLabels error: %v", err)
}
if diff := testutil.Diff(sc.Labels, labels); diff != "" {
t.Fatalf("\ngot: - want: +\n%s", diff)
}

timeoutCtx, cancel := context.WithTimeout(ctx, time.Minute)
defer cancel()
err = internal.Retry(timeoutCtx, gax.Backoff{}, func() (bool, error) {
Expand Down
21 changes: 21 additions & 0 deletions pubsub/snapshot.go
View file
Open in desktop
Expand Up @@ -21,6 +21,7 @@ import (
"time"

pb "google.golang.org/genproto/googleapis/pubsub/v1"
fmpb "google.golang.org/genproto/protobuf/field_mask"
"google.golang.org/protobuf/types/known/timestamppb"
)

Expand All @@ -42,11 +43,30 @@ func (s *Snapshot) ID() string {
return s.name[slash+1:]
}

// 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.

func (s *Snapshot) SetLabels(ctx context.Context, label map[string]string) (*SnapshotConfig, error) {
sc, err := s.c.subc.UpdateSnapshot(ctx, &pb.UpdateSnapshotRequest{
Snapshot: &pb.Snapshot{
Name: s.name,
Labels: label,
},
UpdateMask: &fmpb.FieldMask{
Paths: []string{"labels"},
},
})
if err != nil {
return nil, err
}
return toSnapshotConfig(sc, s.c)
}

// SnapshotConfig contains the details of a Snapshot.
type SnapshotConfig struct {
*Snapshot
Topic *Topic
Expiration time.Time
// The set of labels for the snapshot.
Labels map[string]string
}

// Snapshot creates a reference to a snapshot.
Expand Down Expand Up @@ -151,5 +171,6 @@ func toSnapshotConfig(snap *pb.Snapshot, c *Client) (*SnapshotConfig, error) {
Snapshot: &Snapshot{c: c, name: snap.Name},
Topic: newTopic(c, snap.Topic),
Expiration: exp,
Labels: snap.Labels,
}, nil
}