Cloud Pub/Sub V1 API - Class Google::Cloud::PubSub::V1::TopicAdmin::Rest::ServiceStub (v1.18.0)

Reference documentation and code samples for the Cloud Pub/Sub V1 API class Google::Cloud::PubSub::V1::TopicAdmin::Rest::ServiceStub.

REST service stub for the TopicAdmin service. Service stub contains baseline method implementations including transcoding, making the REST call, and deserialing the response.

Inherits

  • Object

Methods

#create_topic

def create_topic(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::PubSub::V1::Topic

Baseline implementation for the create_topic REST call

Parameters
  • request_pb (::Google::Cloud::PubSub::V1::Topic) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#delete_topic

def delete_topic(request_pb, options = nil) { |result, operation| ... } -> ::Google::Protobuf::Empty

Baseline implementation for the delete_topic REST call

Parameters
  • request_pb (::Google::Cloud::PubSub::V1::DeleteTopicRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#detach_subscription

def detach_subscription(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::PubSub::V1::DetachSubscriptionResponse

Baseline implementation for the detach_subscription REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#endpoint

def endpoint() -> String

The effective endpoint

Returns
  • (String)

#get_topic

def get_topic(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::PubSub::V1::Topic

Baseline implementation for the get_topic REST call

Parameters
  • request_pb (::Google::Cloud::PubSub::V1::GetTopicRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_topic_snapshots

def list_topic_snapshots(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::PubSub::V1::ListTopicSnapshotsResponse

Baseline implementation for the list_topic_snapshots REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_topic_subscriptions

def list_topic_subscriptions(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::PubSub::V1::ListTopicSubscriptionsResponse

Baseline implementation for the list_topic_subscriptions REST call

Parameters
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#list_topics

def list_topics(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::PubSub::V1::ListTopicsResponse

Baseline implementation for the list_topics REST call

Parameters
  • request_pb (::Google::Cloud::PubSub::V1::ListTopicsRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#logger

def logger(stub: false) -> Logger

The logger used for request/response debug logging.

Returns
  • (Logger)

#publish

def publish(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::PubSub::V1::PublishResponse

Baseline implementation for the publish REST call

Parameters
  • request_pb (::Google::Cloud::PubSub::V1::PublishRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns
  • (String)

#update_topic

def update_topic(request_pb, options = nil) { |result, operation| ... } -> ::Google::Cloud::PubSub::V1::Topic

Baseline implementation for the update_topic REST call

Parameters
  • request_pb (::Google::Cloud::PubSub::V1::UpdateTopicRequest) — A request object representing the call parameters. Required.
  • options (::Gapic::CallOptions) — Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
Yields
  • (result, operation) — Access the result along with the TransportOperation object
Yield Parameters
Returns
Raises
  • (::ArgumentError)