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: expose the methods of Notifications #399

Merged
merged 18 commits into from Mar 25, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
25 changes: 25 additions & 0 deletions google-cloud-storage/clirr-ignored-differences.xml
Expand Up @@ -11,4 +11,29 @@
<method>BucketInfo$LifecycleRule$LifecycleAction()</method>
<differenceType>7004</differenceType>
</difference>
<difference>
<className>com/google/cloud/storage/Storage</className>
Copy link
Contributor

Choose a reason for hiding this comment

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

This requires a major version bump.

Copy link
Contributor Author

@athakor athakor Jul 22, 2020

Choose a reason for hiding this comment

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

This requires a major version bump.

@frankyn what do you think about this??

Copy link
Member

Choose a reason for hiding this comment

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

We've done it for others and updated the README.md to reflect this quirk in updates of the Interface. We haven't hit customer issues with these interface changes.

We are going to move forward with similar changes.

<method>*.Notification createNotification(*.String, *.NotificationInfo)</method>
<differenceType>7012</differenceType>
</difference>
<difference>
<className>com/google/cloud/storage/Storage</className>
<method>*.Notification getNotification(*.String, *.String)</method>
<differenceType>7012</differenceType>
</difference>
<difference>
<className>com/google/cloud/storage/Storage</className>
<method>java.util.List listNotifications(*.String)</method>
<differenceType>7012</differenceType>
</difference>
<difference>
<className>com/google/cloud/storage/Storage</className>
<method>boolean deleteNotification(*.String, *.String)</method>
<differenceType>7012</differenceType>
</difference>
<difference>
<className>com/google/cloud/storage/spi/v1/StorageRpc</className>
<method>*.model.Notification getNotification(*.String, *.String)</method>
<differenceType>7012</differenceType>
</difference>
</differences>
5 changes: 5 additions & 0 deletions google-cloud-storage/pom.xml
Expand Up @@ -147,6 +147,11 @@
<artifactId>truth</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-pubsub</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.easymock</groupId>
<artifactId>easymock</artifactId>
Expand Down
@@ -0,0 +1,139 @@
/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.storage;

import static com.google.common.base.Preconditions.checkNotNull;

import java.util.Map;
import java.util.Objects;

/**
* The class representing Pub/Sub notifications for the Storage. See <a
* href="https://cloud.google.com/storage/docs/pubsub-notifications">pubsub-notifications</a> for
* details.
*/
athakor marked this conversation as resolved.
Show resolved Hide resolved
athakor marked this conversation as resolved.
Show resolved Hide resolved
athakor marked this conversation as resolved.
Show resolved Hide resolved
public class Notification extends NotificationInfo {

private final StorageOptions options;
private transient Storage storage;

/** Builder for {@code Notification}. */
public static class Builder extends NotificationInfo.Builder {
private final Storage storage;
private final NotificationInfo.BuilderImpl infoBuilder;

Builder(Notification notification) {
athakor marked this conversation as resolved.
Show resolved Hide resolved
this.storage = notification.storage;
this.infoBuilder = new NotificationInfo.BuilderImpl(notification);
}

@Override
Builder setNotificationId(String notificationId) {
infoBuilder.setNotificationId(notificationId);
return this;
}
athakor marked this conversation as resolved.
Show resolved Hide resolved
athakor marked this conversation as resolved.
Show resolved Hide resolved

@Override
public Builder setSelfLink(String selfLink) {
infoBuilder.setSelfLink(selfLink);
return this;
}

@Override
public Builder setTopic(String topic) {
infoBuilder.setTopic(topic);
return this;
}
athakor marked this conversation as resolved.
Show resolved Hide resolved

@Override
public Builder setPayloadFormat(PayloadFormat payloadFormat) {
infoBuilder.setPayloadFormat(payloadFormat);
return this;
}

@Override
public Builder setObjectNamePrefix(String objectNamePrefix) {
infoBuilder.setObjectNamePrefix(objectNamePrefix);
return this;
}

@Override
public Builder setEventTypes(EventType... eventTypes) {
infoBuilder.setEventTypes(eventTypes);
return this;
}
athakor marked this conversation as resolved.
Show resolved Hide resolved

@Override
public Builder setEtag(String etag) {
infoBuilder.setEtag(etag);
return this;
}

@Override
public Builder setCustomAttributes(Map<String, String> customAttributes) {
infoBuilder.setCustomAttributes(customAttributes);
return this;
}

@Override
public Notification build() {
return new Notification(storage, infoBuilder);
}
}

Notification(Storage storage, NotificationInfo.BuilderImpl infoBuilder) {
athakor marked this conversation as resolved.
Show resolved Hide resolved
super(infoBuilder);
this.storage = checkNotNull(storage);
this.options = storage.getOptions();
}

/** Returns the notification's {@code Storage} object used to issue requests. */
public Storage getStorage() {
return storage;
}

@Override
public Builder toBuilder() {
return new Notification.Builder(this);
}

@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
if (!super.equals(o)) {
return false;
}
Notification notification = (Notification) o;
return Objects.equals(toPb(), notification.toPb())
&& Objects.equals(options, notification.options);
}

@Override
public int hashCode() {
return Objects.hash(super.hashCode(), options, storage);
}

static Notification fromPb(
Storage storage, com.google.api.services.storage.model.Notification notificationPb) {
return new Notification(
storage, new NotificationInfo.BuilderImpl(NotificationInfo.fromPb(notificationPb)));
}
}