Google Workspace Events API - Module Google::Apps::Events::Subscriptions (v1.1.0)

Reference documentation and code samples for the Google Workspace Events API module Google::Apps::Events::Subscriptions.

Methods

.subscriptions_service

def self.subscriptions_service(version: :v1, transport: :grpc, &block) -> ::Object

Create a new client object for SubscriptionsService.

By default, this returns an instance of Google::Apps::Events::Subscriptions::V1::SubscriptionsService::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the SubscriptionsService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the SubscriptionsService service. You can determine whether the method will succeed by calling Subscriptions.subscriptions_service_available?.

About SubscriptionsService

A service that manages subscriptions to Google Workspace events.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (::Object) — A client object for the specified version.

.subscriptions_service_available?

def self.subscriptions_service_available?(version: :v1, transport: :grpc) -> boolean

Determines whether the SubscriptionsService service is supported by the current client. If true, you can retrieve a client object by calling Subscriptions.subscriptions_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the SubscriptionsService service, or if the versioned client gem needs an update to support the SubscriptionsService service.

Parameters
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
  • transport (:grpc, :rest) (defaults to: :grpc) — The transport to use. Defaults to :grpc.
Returns
  • (boolean) — Whether the service is available.

Constants

VERSION

value: "1.1.0"