def get_topic(
self,
topic,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
"""
Gets the configuration of a topic.
Example:
>>> from google.cloud import pubsub_v1
>>>
>>> client = pubsub_v1.PublisherClient()
>>>
>>> topic = client.topic_path('[PROJECT]', '[TOPIC]')
>>>
>>> response = client.get_topic(topic)
Args:
topic (str): The name of the topic to get. Format is
``projects/{project}/topics/{topic}``.
retry (Optional[google.api_core.retry.Retry]): A retry object used
to retry requests. If ``None`` is specified, requests will not
be retried.
timeout (Optional[float]): The amount of time, in seconds, to wait
for the request to complete. Note that if ``retry`` is
specified, the timeout applies to each individual attempt.
metadata (Optional[Sequence[Tuple[str, str]]]): Additional metadata
that is provided to the method.
Returns:
A :class:`~google.cloud.pubsub_v1.types.Topic` instance.
Raises:
google.api_core.exceptions.GoogleAPICallError: If the request
failed for any reason.
google.api_core.exceptions.RetryError: If the request failed due
to a retryable error and retry attempts failed.
ValueError: If the parameters are invalid.
"""
# Wrap the transport method to add retry and timeout logic.
if "get_topic" not in self._inner_api_calls:
self._inner_api_calls[
"get_topic"] = google.api_core.gapic_v1.method.wrap_method(
self.transport.get_topic,
default_retry=self._method_configs["GetTopic"].retry,
default_timeout=self._method_configs["GetTopic"].timeout,
client_info=self._client_info,
)
request = pubsub_pb2.GetTopicRequest(topic=topic)
return self._inner_api_calls["get_topic"](request,
retry=retry,
timeout=timeout,
metadata=metadata)
def test_get_topic(self):
# Setup Expected Response
name = 'name3373707'
expected_response = {'name': name}
expected_response = pubsub_pb2.Topic(**expected_response)
# Mock the API response
channel = ChannelStub(responses=[expected_response])
client = publisher_client.PublisherClient(channel=channel)
# Setup Request
topic = client.topic_path('[PROJECT]', '[TOPIC]')
response = client.get_topic(topic)
assert expected_response == response
assert len(channel.requests) == 1
expected_request = pubsub_pb2.GetTopicRequest(topic=topic)
actual_request = channel.requests[0][1]
assert expected_request == actual_request
def get_topic(self,
topic,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT):
"""
Gets the configuration of a topic.
Example:
>>> from google.cloud import pubsub_v1
>>>
>>> client = pubsub_v1.PublisherClient()
>>>
>>> topic = client.topic_path('[PROJECT]', '[TOPIC]')
>>>
>>> response = client.get_topic(topic)
Args:
topic (str): The name of the topic to get.
Format is ``projects/{project}/topics/{topic}``.
retry (Optional[google.api_core.retry.Retry]): A retry object used
to retry requests. If ``None`` is specified, requests will not
be retried.
timeout (Optional[float]): The amount of time, in seconds, to wait
for the request to complete. Note that if ``retry`` is
specified, the timeout applies to each individual attempt.
Returns:
A :class:`~google.cloud.pubsub_v1.types.Topic` instance.
Raises:
google.api_core.exceptions.GoogleAPICallError: If the request
failed for any reason.
google.api_core.exceptions.RetryError: If the request failed due
to a retryable error and retry attempts failed.
ValueError: If the parameters are invalid.
"""
request = pubsub_pb2.GetTopicRequest(topic=topic)
return self._get_topic(request, retry=retry, timeout=timeout)
def test_get_topic(self):
# Setup Expected Response
name = "name3373707"
expected_response = {"name": name}
expected_response = pubsub_pb2.Topic(**expected_response)
# Mock the API response
channel = ChannelStub(responses=[expected_response])
patch = mock.patch("google.api_core.grpc_helpers.create_channel")
with patch as create_channel:
create_channel.return_value = channel
client = publisher_client.PublisherClient()
# Setup Request
topic = client.topic_path("[PROJECT]", "[TOPIC]")
response = client.get_topic(topic)
assert expected_response == response
assert len(channel.requests) == 1
expected_request = pubsub_pb2.GetTopicRequest(topic=topic)
actual_request = channel.requests[0][1]
assert expected_request == actual_request
