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

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

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

Inherits

  • Object

Methods

#acknowledge

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

Baseline implementation for the acknowledge REST call

Parameters
  • request_pb (::Google::Cloud::PubSub::V1::AcknowledgeRequest) — 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)

#create_snapshot

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

Baseline implementation for the create_snapshot REST call

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

#create_subscription

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

Baseline implementation for the create_subscription REST call

Parameters
  • request_pb (::Google::Cloud::PubSub::V1::Subscription) — 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_snapshot

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

Baseline implementation for the delete_snapshot REST call

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

#delete_subscription

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

Baseline implementation for the delete_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_snapshot

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

Baseline implementation for the get_snapshot REST call

Parameters
  • request_pb (::Google::Cloud::PubSub::V1::GetSnapshotRequest) — 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)

#get_subscription

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

Baseline implementation for the get_subscription REST call

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

#list_snapshots

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

Baseline implementation for the list_snapshots REST call

Parameters
  • request_pb (::Google::Cloud::PubSub::V1::ListSnapshotsRequest) — 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_subscriptions

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

Baseline implementation for the list_subscriptions REST call

Parameters
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)

#modify_ack_deadline

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

Baseline implementation for the modify_ack_deadline REST call

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

#modify_push_config

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

Baseline implementation for the modify_push_config REST call

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

#pull

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

Baseline implementation for the pull REST call

Parameters
  • request_pb (::Google::Cloud::PubSub::V1::PullRequest) — 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)

#seek

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

Baseline implementation for the seek REST call

Parameters
  • request_pb (::Google::Cloud::PubSub::V1::SeekRequest) — 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_snapshot

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

Baseline implementation for the update_snapshot REST call

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

#update_subscription

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

Baseline implementation for the update_subscription REST call

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