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

Add support for bucket notifications #4127

Merged
merged 7 commits into from
Oct 10, 2017
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 67 additions & 0 deletions storage/google/cloud/storage/bucket.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@
from google.cloud.storage.acl import DefaultObjectACL
from google.cloud.storage.blob import Blob
from google.cloud.storage.blob import _get_encryption_headers
from google.cloud.storage.notification import BucketNotification
from google.cloud.storage.notification import NONE_PAYLOAD_FORMAT


def _blobs_page_start(iterator, page, response):
Expand Down Expand Up @@ -76,6 +78,26 @@ def _item_to_blob(iterator, item):
return blob


def _item_to_notification(iterator, item):
"""Convert a JSON blob to the native object.

.. note::

This assumes that the ``bucket`` attribute has been
added to the iterator after being created.

:type iterator: :class:`~google.api.core.page_iterator.Iterator`
:param iterator: The iterator that has retrieved the item.

:type item: dict
:param item: An item to be converted to a blob.

:rtype: :class:`.BucketNotification`
:returns: The next notification being iterated.
"""
return BucketNotification.from_api_repr(item, bucket=iterator.bucket)


class Bucket(_PropertyMixin):
"""A class representing a Bucket on Cloud Storage.

Expand Down Expand Up @@ -159,6 +181,27 @@ def blob(self, blob_name, chunk_size=None, encryption_key=None):
return Blob(name=blob_name, bucket=self, chunk_size=chunk_size,
encryption_key=encryption_key)

def notification(self, topic_name,
topic_project=None,
custom_attributes=None,
event_types=None,
blob_name_prefix=None,
payload_format=NONE_PAYLOAD_FORMAT):
"""Factory: create a notification resource for the bucket.

See: :class:`.BucketNotification` for parameters.

:rtype: :class:`.BucketNotification`
"""
return BucketNotification(
self, topic_name,
topic_project=topic_project,
custom_attributes=custom_attributes,
event_types=event_types,
blob_name_prefix=blob_name_prefix,
payload_format=payload_format,
)

def exists(self, client=None):
"""Determines whether or not this bucket exists.

Expand Down Expand Up @@ -382,6 +425,30 @@ def list_blobs(self, max_results=None, page_token=None, prefix=None,
iterator.prefixes = set()
return iterator

def list_notifications(self, client=None):
"""List Pub / Sub notifications for this bucket.

See:
https://cloud.google.com/storage/docs/json_api/v1/notifications/list

:type client: :class:`~google.cloud.storage.client.Client` or
``NoneType``
:param client: Optional. The client to use. If not passed, falls back
to the ``client`` stored on the current bucket.

:rtype: list of :class:`.BucketNotification`
:returns: notification instances
"""
client = self._require_client(client)
path = self.path + '/notificationConfigs'
iterator = page_iterator.HTTPIterator(
client=client,
api_request=client._connection.api_request,
path=path,
item_to_value=_item_to_notification)
iterator.bucket = self
return iterator

def delete(self, force=False, client=None):
"""Delete this bucket.

Expand Down
Loading