Google Workspace Events V1 API - Class Google::Apps::Events::Subscriptions::V1::SubscriptionsService::Rest::ServiceStub (v0.1.0)

Reference documentation and code samples for the Google Workspace Events V1 API class Google::Apps::Events::Subscriptions::V1::SubscriptionsService::Rest::ServiceStub.

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

Inherits

• Object

Methods

#create_subscription

def create_subscription(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the create_subscription REST call

Parameters

• request_pb (::Google::Apps::Events::Subscriptions::V1::CreateSubscriptionRequest) — 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

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#delete_subscription

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

Baseline implementation for the delete_subscription REST call

Parameters

• request_pb (::Google::Apps::Events::Subscriptions::V1::DeleteSubscriptionRequest) — 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

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#endpoint

def endpoint() -> String

The effective endpoint

Returns

• (String)

#get_subscription

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

Baseline implementation for the get_subscription REST call

Parameters

• request_pb (::Google::Apps::Events::Subscriptions::V1::GetSubscriptionRequest) — 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

• result (::Google::Apps::Events::Subscriptions::V1::Subscription)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Apps::Events::Subscriptions::V1::Subscription) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#initialize

def initialize(endpoint:, endpoint_template:, universe_domain:, credentials:) -> ServiceStub

Returns

• (ServiceStub) — a new instance of ServiceStub

#list_subscriptions

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

Baseline implementation for the list_subscriptions REST call

Parameters

• request_pb (::Google::Apps::Events::Subscriptions::V1::ListSubscriptionsRequest) — 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

• result (::Google::Apps::Events::Subscriptions::V1::ListSubscriptionsResponse)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Apps::Events::Subscriptions::V1::ListSubscriptionsResponse) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#reactivate_subscription

def reactivate_subscription(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the reactivate_subscription REST call

Parameters

• request_pb (::Google::Apps::Events::Subscriptions::V1::ReactivateSubscriptionRequest) — 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

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)

#universe_domain

def universe_domain() -> String

The effective universe domain

Returns

• (String)

#update_subscription

def update_subscription(request_pb, options = nil) { |result, operation| ... } -> ::Google::Longrunning::Operation

Baseline implementation for the update_subscription REST call

Parameters

• request_pb (::Google::Apps::Events::Subscriptions::V1::UpdateSubscriptionRequest) — 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

• result (::Google::Longrunning::Operation)
• operation (::Gapic::Rest::TransportOperation)

Returns

• (::Google::Longrunning::Operation) — A result object deserialized from the server's reply

Raises

• (::ArgumentError)