samples: add samples (#37)

samples/snippets/create_lite_subscription_example.py

@@ -0,0 +1,92 @@
+#!/usr/bin/env python
+
+# Copyright 2020 Google Inc. All Rights Reserved.
+#
+# 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.
+
+"""This application demonstrates how to create a subscription with the Pub/Sub
+Lite API. For more information, see the root level README.md and the
+documentation at https://cloud.google.com/pubsub/lite/docs/subscriptions.
+"""
+
+import argparse
+
+
+def create_lite_subscription(
+    project_number, cloud_region, zone_id, topic_id, subscription_id
+):
+    # [START pubsublite_create_subscription]
+    from google.api_core.exceptions import AlreadyExists
+    from google.cloud.pubsublite import AdminClient
+    from google.cloud.pubsublite.types import (
+        CloudRegion,
+        CloudZone,
+        SubscriptionPath,
+        TopicPath,
+    )
+    from google.cloud.pubsublite_v1 import Subscription
+
+    # TODO(developer):
+    # project_number = 1122334455
+    # cloud_region = "us-central1"
+    # zone_id = "a"
+    # topic_id = "your-topic-id"
+    # subscription_id = "your-subscription-id"
+
+    client = AdminClient(cloud_region)
+
+    location = CloudZone(CloudRegion(cloud_region), zone_id)
+    topic_path = TopicPath(project_number, location, topic_id)
+    subscription_path = SubscriptionPath(project_number, location, subscription_id)
+
+    subscription = Subscription(
+        name=str(subscription_path),
+        topic=str(topic_path),
+        delivery_config=Subscription.DeliveryConfig(
+            # Possible values for delivery_requirement:
+            # - `DELIVER_IMMEDIATELY`
+            # - `DELIVER_AFTER_STORED`
+            # You may choose whether to wait for a published message to be successfully written
+            # to storage before the server delivers it to subscribers. `DELIVER_IMMEDIATELY` is
+            # suitable for applications that need higher throughput.
+            delivery_requirement=Subscription.DeliveryConfig.DeliveryRequirement.DELIVER_IMMEDIATELY,
+        ),
+    )
+
+    try:
+        response = client.create_subscription(subscription)
+        print(f"{response.name} created successfully.")
+    except AlreadyExists:
+        print(f"{subscription_path} already exists.")
+    # [END pubsublite_create_subscription]
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(
+        description=__doc__, formatter_class=argparse.RawDescriptionHelpFormatter,
+    )
+    parser.add_argument("project_number", help="Your Google Cloud Project Number")
+    parser.add_argument("cloud_region", help="Your Cloud Region, e.g. 'us-central1'")
+    parser.add_argument("zone_id", help="Your Zone ID, e.g. 'a'")
+    parser.add_argument("topic_id", help="Your topic ID")
+    parser.add_argument("subscription_id", help="Your subscription ID")
+
+    args = parser.parse_args()
+
+    create_lite_subscription(
+        args.project_number,
+        args.cloud_region,
+        args.zone_id,
+        args.topic_id,
+        args.subscription_id,
+    )

samples/snippets/create_lite_topic_example.py

@@ -0,0 +1,96 @@
+#!/usr/bin/env python
+
+# Copyright 2020 Google Inc. All Rights Reserved.
+#
+# 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.
+
+"""This application demonstrates how to create a topic with the Pub/Sub
+Lite API. For more information, see the root level README.md and the
+documentation at https://cloud.google.com/pubsub/lite/docs/topics.
+"""
+
+import argparse
+
+
+def create_lite_topic(project_number, cloud_region, zone_id, topic_id, num_partitions):
+    # [START pubsublite_create_topic]
+    from google.api_core.exceptions import AlreadyExists
+    from google.cloud.pubsublite import AdminClient
+    from google.cloud.pubsublite.types import CloudRegion, CloudZone, TopicPath
+    from google.cloud.pubsublite_v1 import Topic
+    from google.protobuf.duration_pb2 import Duration
+
+    # TODO(developer):
+    # project_number = 1122334455
+    # cloud_region = "us-central1"
+    # zone_id = "a"
+    # topic_id = "your-topic-id"
+    # num_partitions = 1
+
+    client = AdminClient(cloud_region)
+
+    location = CloudZone(CloudRegion(cloud_region), zone_id)
+    topic_path = TopicPath(project_number, location, topic_id)
+    topic = Topic(
+        name=str(topic_path),
+        partition_config=Topic.PartitionConfig(
+            # A topic must have at least one partition.
+            count=num_partitions,
+            # Set throughput capacity per partition in MiB/s.
+            capacity=Topic.PartitionConfig.Capacity(
+                # Set publish throughput capacity per partition to 4 MiB/s. Must be >= 4 and <= 16.
+                publish_mib_per_sec=4,
+                # Set subscribe throughput capacity per partition to 4 MiB/s. Must be >= 4 and <= 32.
+                subscribe_mib_per_sec=8,
+            ),
+        ),
+        retention_config=Topic.RetentionConfig(
+            # Set storage per partition to 30 GiB. This must be in the range 30 GiB-10TiB.
+            # If the number of byptes stored in any of the topic's partitions grows beyond
+            # this value, older messages will be dropped to make room for newer ones,
+            # regardless of the value of `period`.
+            per_partition_bytes=30 * 1024 * 1024 * 1024,
+            # Allow messages to be retained for 7 days.
+            period=Duration(seconds=60 * 60 * 24 * 7),
+        ),
+    )
+
+    try:
+        response = client.create_topic(topic)
+        print(f"{response.name} created successfully.")
+    except AlreadyExists:
+        print(f"{topic_path} already exists.")
+    # [END pubsublite_create_topic]
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(
+        description=__doc__, formatter_class=argparse.RawDescriptionHelpFormatter,
+    )
+    parser.add_argument("project_number", help="Your Google Cloud Project Number")
+    parser.add_argument("cloud_region", help="Your Cloud Region, e.g. 'us-central1'")
+    parser.add_argument("zone_id", help="Your Zone ID, e.g. 'a'")
+    parser.add_argument("topic_id", help="Your topic ID")
+    parser.add_argument(
+        "num_partitions", type=int, help="Number of partitions in the topic"
+    )
+
+    args = parser.parse_args()
+
+    create_lite_topic(
+        args.project_number,
+        args.cloud_region,
+        args.zone_id,
+        args.topic_id,
+        args.num_partitions,
+    )

samples/snippets/delete_lite_subscription_example.py

@@ -0,0 +1,63 @@
+#!/usr/bin/env python
+
+# Copyright 2020 Google Inc. All Rights Reserved.
+#
+# 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.
+
+"""This application demonstrates how to delete a subscription with the Pub/Sub
+Lite API. For more information, see the root level README.md and the
+documentation at https://cloud.google.com/pubsub/lite/docs/subscriptions.
+"""
+
+import argparse
+
+
+def delete_lite_subscription(project_number, cloud_region, zone_id, subscription_id):
+    # [START pubsublite_delete_subscription]
+    from google.api_core.exceptions import NotFound
+    from google.cloud.pubsublite import AdminClient
+    from google.cloud.pubsublite.types import CloudRegion, CloudZone, SubscriptionPath
+
+    # TODO(developer):
+    # project_number = 1122334455
+    # cloud_region = "us-central1"
+    # zone_id = "a"
+    # subscription_id = "your-subscription-id"
+
+    client = AdminClient(cloud_region)
+
+    location = CloudZone(CloudRegion(cloud_region), zone_id)
+    subscription_path = SubscriptionPath(project_number, location, subscription_id)
+
+    try:
+        client.delete_subscription(subscription_path)
+        print(f"{subscription_path} deleted successfully.")
+    except NotFound:
+        print(f"{subscription_path} not found.")
+    # [END pubsublite_delete_subscription]
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(
+        description=__doc__, formatter_class=argparse.RawDescriptionHelpFormatter,
+    )
+    parser.add_argument("project_number", help="Your Google Cloud Project Number")
+    parser.add_argument("cloud_region", help="Your Cloud Region, e.g. 'us-central1'")
+    parser.add_argument("zone_id", help="Your Zone ID, e.g. 'a'")
+    parser.add_argument("subscription_id", help="Your subscription ID")
+
+    args = parser.parse_args()
+
+    delete_lite_subscription(
+        args.project_number, args.cloud_region, args.zone_id, args.subscription_id,
+    )

samples/snippets/delete_lite_topic_example.py

@@ -0,0 +1,63 @@
+#!/usr/bin/env python
+
+# Copyright 2020 Google Inc. All Rights Reserved.
+#
+# 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.
+
+"""This application demonstrates how to delete a topic with the Pub/Sub
+Lite API. For more information, see the root level README.md and the
+documentation at https://cloud.google.com/pubsub/lite/docs/topics.
+"""
+
+import argparse
+
+
+def delete_lite_topic(project_number, cloud_region, zone_id, topic_id):
+    # [START pubsublite_delete_topic]
+    from google.api_core.exceptions import NotFound
+    from google.cloud.pubsublite import AdminClient
+    from google.cloud.pubsublite.types import CloudRegion, CloudZone, TopicPath
+
+    # TODO(developer):
+    # project_number = 1122334455
+    # cloud_region = "us-central1"
+    # zone_id = "a"
+    # topic_id = "your-topic-id"
+
+    client = AdminClient(cloud_region)
+
+    location = CloudZone(CloudRegion(cloud_region), zone_id)
+    topic_path = TopicPath(project_number, location, topic_id)
+
+    try:
+        client.delete_topic(topic_path)
+        print(f"{topic_path} deleted successfully.")
+    except NotFound:
+        print(f"{topic_path} not found.")
+    # [END pubsublite_delete_topic]
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(
+        description=__doc__, formatter_class=argparse.RawDescriptionHelpFormatter,
+    )
+    parser.add_argument("project_number", help="Your Google Cloud Project Number")
+    parser.add_argument("cloud_region", help="Your Cloud Region, e.g. 'us-central1'")
+    parser.add_argument("zone_id", help="Your Zone ID, e.g. 'a'")
+    parser.add_argument("topic_id", help="Your topic ID")
+
+    args = parser.parse_args()
+
+    delete_lite_topic(
+        args.project_number, args.cloud_region, args.zone_id, args.topic_id,
+    )

samples/snippets/get_lite_subscription_example.py

@@ -0,0 +1,63 @@
+#!/usr/bin/env python
+
+# Copyright 2020 Google Inc. All Rights Reserved.
+#
+# 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.
+
+"""This application demonstrates how to get a subscription with the Pub/Sub
+Lite API. For more information, see the root level README.md and the
+documentation at https://cloud.google.com/pubsub/lite/docs/subscriptions.
+"""
+
+import argparse
+
+
+def get_lite_subscription(project_number, cloud_region, zone_id, subscription_id):
+    # [START pubsublite_get_subscription]
+    from google.api_core.exceptions import NotFound
+    from google.cloud.pubsublite import AdminClient
+    from google.cloud.pubsublite.types import CloudRegion, CloudZone, SubscriptionPath
+
+    # TODO(developer):
+    # project_number = 1122334455
+    # cloud_region = "us-central1"
+    # zone_id = "a"
+    # subscription_id = "your-subscription-id"
+
+    client = AdminClient(cloud_region)
+
+    location = CloudZone(CloudRegion(cloud_region), zone_id)
+    subscription_path = SubscriptionPath(project_number, location, subscription_id)
+
+    try:
+        response = client.get_subscription(subscription_path)
+        print(f"{response.name} exists.")
+    except NotFound:
+        print(f"{subscription_path} not found.")
+    # [END pubsublite_get_subscription]
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(
+        description=__doc__, formatter_class=argparse.RawDescriptionHelpFormatter,
+    )
+    parser.add_argument("project_number", help="Your Google Cloud Project Number")
+    parser.add_argument("cloud_region", help="Your Cloud Region, e.g. 'us-central1'")
+    parser.add_argument("zone_id", help="Your Zone ID, e.g. 'a'")
+    parser.add_argument("subscription_id", help="Your subscription ID")
+
+    args = parser.parse_args()
+
+    get_lite_subscription(
+        args.project_number, args.cloud_region, args.zone_id, args.subscription_id,
+    )