File: //snap/google-cloud-cli/396/lib/third_party/google/cloud/pubsublite/admin_client.py
# 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.
from typing import Optional, List, Union
from google.api_core.client_options import ClientOptions
from google.api_core.operation import Operation
from google.auth.credentials import Credentials
from cloudsdk.google.protobuf.field_mask_pb2 import FieldMask # pytype: disable=pyi-error
from google.cloud.pubsublite.admin_client_interface import AdminClientInterface
from google.cloud.pubsublite.internal.constructable_from_service_account import (
ConstructableFromServiceAccount,
)
from google.cloud.pubsublite.internal.endpoints import regional_endpoint
from google.cloud.pubsublite.internal.wire.admin_client_impl import AdminClientImpl
from google.cloud.pubsublite.types import (
CloudRegion,
SubscriptionPath,
LocationPath,
TopicPath,
BacklogLocation,
PublishTime,
EventTime,
)
from google.cloud.pubsublite.types.paths import ReservationPath
from google.cloud.pubsublite_v1 import (
AdminServiceClient,
Subscription,
Topic,
Reservation,
)
class AdminClient(AdminClientInterface, ConstructableFromServiceAccount):
"""
An admin client for Pub/Sub Lite. Only operates on a single region.
"""
_impl: AdminClientInterface
def __init__(
self,
region: CloudRegion,
credentials: Optional[Credentials] = None,
transport: Optional[str] = None,
client_options: Optional[ClientOptions] = None,
):
"""
Create a new AdminClient.
Args:
region: The cloud region to connect to.
credentials: The credentials to use when connecting.
transport: The transport to use.
client_options: The client options to use when connecting. If used, must explicitly set `api_endpoint`.
"""
if client_options is None:
client_options = ClientOptions(api_endpoint=regional_endpoint(region))
self._impl = AdminClientImpl(
AdminServiceClient(
client_options=client_options,
transport=transport,
credentials=credentials,
),
region,
)
def region(self) -> CloudRegion:
return self._impl.region()
def create_topic(self, topic: Topic) -> Topic:
return self._impl.create_topic(topic)
def get_topic(self, topic_path: TopicPath) -> Topic:
return self._impl.get_topic(topic_path)
def get_topic_partition_count(self, topic_path: TopicPath) -> int:
return self._impl.get_topic_partition_count(topic_path)
def list_topics(self, location_path: LocationPath) -> List[Topic]:
return self._impl.list_topics(location_path)
def update_topic(self, topic: Topic, update_mask: FieldMask) -> Topic:
return self._impl.update_topic(topic, update_mask)
def delete_topic(self, topic_path: TopicPath):
return self._impl.delete_topic(topic_path)
def list_topic_subscriptions(self, topic_path: TopicPath) -> List[SubscriptionPath]:
return self._impl.list_topic_subscriptions(topic_path)
def create_subscription(
self,
subscription: Subscription,
target: Union[BacklogLocation, PublishTime, EventTime] = BacklogLocation.END,
starting_offset: Optional[BacklogLocation] = None,
) -> Subscription:
return self._impl.create_subscription(subscription, target, starting_offset)
def get_subscription(self, subscription_path: SubscriptionPath) -> Subscription:
return self._impl.get_subscription(subscription_path)
def list_subscriptions(self, location_path: LocationPath) -> List[Subscription]:
return self._impl.list_subscriptions(location_path)
def update_subscription(
self, subscription: Subscription, update_mask: FieldMask
) -> Subscription:
return self._impl.update_subscription(subscription, update_mask)
def seek_subscription(
self,
subscription_path: SubscriptionPath,
target: Union[BacklogLocation, PublishTime, EventTime],
) -> Operation:
return self._impl.seek_subscription(subscription_path, target)
def delete_subscription(self, subscription_path: SubscriptionPath):
return self._impl.delete_subscription(subscription_path)
def create_reservation(self, reservation: Reservation) -> Reservation:
return self._impl.create_reservation(reservation)
def get_reservation(self, reservation_path: ReservationPath) -> Reservation:
return self._impl.get_reservation(reservation_path)
def list_reservations(self, location_path: LocationPath) -> List[Reservation]:
return self._impl.list_reservations(location_path)
def update_reservation(
self, reservation: Reservation, update_mask: FieldMask
) -> Reservation:
return self._impl.update_reservation(reservation, update_mask)
def delete_reservation(self, reservation_path: ReservationPath):
return self._impl.delete_reservation(reservation_path)
def list_reservation_topics(
self, reservation_path: ReservationPath
) -> List[TopicPath]:
return self._impl.list_reservation_topics(reservation_path)