Class: Google::Apps::Events::Subscriptions::V1::SubscriptionsService::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/apps/events/subscriptions/v1/subscriptions_service/client.rb

Overview

Client for the SubscriptionsService service.

A service that manages subscriptions to Google Workspace events.

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#subscription_path, #topic_path, #user_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new SubscriptionsService client object.

Examples:


# Create a client using the default configuration
client = ::Google::Apps::Events::Subscriptions::V1::SubscriptionsService::Client.new

# Create a client using a custom configuration
client = ::Google::Apps::Events::Subscriptions::V1::SubscriptionsService::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the SubscriptionsService client.

Yield Parameters:



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/google/apps/events/subscriptions/v1/subscriptions_service/client.rb', line 143

def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/apps/events/subscriptions/v1/subscriptions_service_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @operations_client = Operations.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
    config.universe_domain = @config.universe_domain
  end

  @subscriptions_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Apps::Events::Subscriptions::V1::SubscriptionsService::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool,
    logger: @config.logger
  )

  @subscriptions_service_stub.stub_logger&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end
end

Instance Attribute Details

#operations_client ⇒ ::Google::Apps::Events::Subscriptions::V1::SubscriptionsService::Operations (readonly)

Get the associated client for long-running operations.

Returns:



206
207
208
 
# File 'lib/google/apps/events/subscriptions/v1/subscriptions_service/client.rb', line 206

def operations_client
  @operations_client
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the SubscriptionsService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all SubscriptionsService clients
::Google::Apps::Events::Subscriptions::V1::SubscriptionsService::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/google/apps/events/subscriptions/v1/subscriptions_service/client.rb', line 63

def self.configure
  @configure ||= begin
    namespace = ["Google", "Apps", "Events", "Subscriptions", "V1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.rpcs.create_subscription.timeout = 60.0

    default_config.rpcs.delete_subscription.timeout = 60.0

    default_config.rpcs.get_subscription.timeout = 60.0
    default_config.rpcs.get_subscription.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.list_subscriptions.timeout = 60.0
    default_config.rpcs.list_subscriptions.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config.rpcs.update_subscription.timeout = 60.0

    default_config.rpcs.reactivate_subscription.timeout = 60.0

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#configure {|config| ... } ⇒ Client::Configuration

Configure the SubscriptionsService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



113
114
115
116
 
# File 'lib/google/apps/events/subscriptions/v1/subscriptions_service/client.rb', line 113

def configure
  yield @config if block_given?
  @config
end

#create_subscription(request, options = nil) ⇒ ::Gapic::Operation #create_subscription(subscription: nil, validate_only: nil) ⇒ ::Gapic::Operation

Creates a Google Workspace subscription. To learn how to use this method, see Create a Google Workspace subscription.

Examples:

Basic example

require "google/apps/events/subscriptions/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Events::Subscriptions::V1::SubscriptionsService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Events::Subscriptions::V1::CreateSubscriptionRequest.new

# Call the create_subscription method.
result = client.create_subscription request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #create_subscription(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to create_subscription via a request object, either of type CreateSubscriptionRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Apps::Events::Subscriptions::V1::CreateSubscriptionRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #create_subscription(subscription: nil, validate_only: nil) ⇒ ::Gapic::Operation

    Pass arguments to create_subscription via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • subscription (::Google::Apps::Events::Subscriptions::V1::Subscription, ::Hash) (defaults to: nil) —

      Required. The subscription resource to create.

    • validate_only (::Boolean) (defaults to: nil) —

      Optional. If set to true, validates and previews the request, but doesn't create the subscription.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/google/apps/events/subscriptions/v1/subscriptions_service/client.rb', line 275

def create_subscription request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Events::Subscriptions::V1::CreateSubscriptionRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.create_subscription.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Apps::Events::Subscriptions::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_subscription.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.create_subscription.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @subscriptions_service_stub.call_rpc :create_subscription, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_subscription(request, options = nil) ⇒ ::Gapic::Operation #delete_subscription(name: nil, validate_only: nil, allow_missing: nil, etag: nil) ⇒ ::Gapic::Operation

Deletes a Google Workspace subscription. To learn how to use this method, see Delete a Google Workspace subscription.

Examples:

Basic example

require "google/apps/events/subscriptions/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Events::Subscriptions::V1::SubscriptionsService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Events::Subscriptions::V1::DeleteSubscriptionRequest.new

# Call the delete_subscription method.
result = client.delete_subscription request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #delete_subscription(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_subscription via a request object, either of type DeleteSubscriptionRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Apps::Events::Subscriptions::V1::DeleteSubscriptionRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #delete_subscription(name: nil, validate_only: nil, allow_missing: nil, etag: nil) ⇒ ::Gapic::Operation

    Pass arguments to delete_subscription via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Resource name of the subscription to delete.

      Format: subscriptions/{subscription}

    • validate_only (::Boolean) (defaults to: nil) —

      Optional. If set to true, validates and previews the request, but doesn't delete the subscription.

    • allow_missing (::Boolean) (defaults to: nil) —

      Optional. If set to true and the subscription isn't found, the request succeeds but doesn't delete the subscription.

    • etag (::String) (defaults to: nil) —

      Optional. Etag of the subscription.

      If present, it must match with the server's etag. Otherwise, request fails with the status ABORTED.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/google/apps/events/subscriptions/v1/subscriptions_service/client.rb', line 376

def delete_subscription request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Events::Subscriptions::V1::DeleteSubscriptionRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.delete_subscription.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Apps::Events::Subscriptions::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_subscription.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.delete_subscription.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @subscriptions_service_stub.call_rpc :delete_subscription, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_subscription(request, options = nil) ⇒ ::Google::Apps::Events::Subscriptions::V1::Subscription #get_subscription(name: nil) ⇒ ::Google::Apps::Events::Subscriptions::V1::Subscription

Gets details about a Google Workspace subscription. To learn how to use this method, see Get details about a Google Workspace subscription.

Examples:

Basic example

require "google/apps/events/subscriptions/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Events::Subscriptions::V1::SubscriptionsService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Events::Subscriptions::V1::GetSubscriptionRequest.new

# Call the get_subscription method.
result = client.get_subscription request

# The returned object is of type Google::Apps::Events::Subscriptions::V1::Subscription.
p result

Overloads:

  • #get_subscription(request, options = nil) ⇒ ::Google::Apps::Events::Subscriptions::V1::Subscription

    Pass arguments to get_subscription via a request object, either of type GetSubscriptionRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Apps::Events::Subscriptions::V1::GetSubscriptionRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_subscription(name: nil) ⇒ ::Google::Apps::Events::Subscriptions::V1::Subscription

    Pass arguments to get_subscription via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Resource name of the subscription.

      Format: subscriptions/{subscription}

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
 
# File 'lib/google/apps/events/subscriptions/v1/subscriptions_service/client.rb', line 467

def get_subscription request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Events::Subscriptions::V1::GetSubscriptionRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_subscription.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Apps::Events::Subscriptions::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_subscription.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_subscription.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @subscriptions_service_stub.call_rpc :get_subscription, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_subscriptions(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Apps::Events::Subscriptions::V1::Subscription> #list_subscriptions(page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Apps::Events::Subscriptions::V1::Subscription>

Lists Google Workspace subscriptions. To learn how to use this method, see List Google Workspace subscriptions.

Examples:

Basic example

require "google/apps/events/subscriptions/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Events::Subscriptions::V1::SubscriptionsService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Events::Subscriptions::V1::ListSubscriptionsRequest.new

# Call the list_subscriptions method.
result = client.list_subscriptions request

# The returned object is of type Gapic::PagedEnumerable. You can iterate
# over elements, and API calls will be issued to fetch pages as needed.
result.each do |item|
  # Each element is of type ::Google::Apps::Events::Subscriptions::V1::Subscription.
  p item
end

Overloads:

  • #list_subscriptions(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Apps::Events::Subscriptions::V1::Subscription>

    Pass arguments to list_subscriptions via a request object, either of type ListSubscriptionsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Apps::Events::Subscriptions::V1::ListSubscriptionsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_subscriptions(page_size: nil, page_token: nil, filter: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Apps::Events::Subscriptions::V1::Subscription>

    Pass arguments to list_subscriptions via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • page_size (::Integer) (defaults to: nil) —

      Optional. The maximum number of subscriptions to return. The service might return fewer than this value.

      If unspecified or set to 0, up to 50 subscriptions are returned.

      The maximum value is 100. If you specify a value more than 100, the system only returns 100 subscriptions.

    • page_token (::String) (defaults to: nil) —

      Optional. A page token, received from a previous list subscriptions call. Provide this parameter to retrieve the subsequent page.

      When paginating, the filter value should match the call that provided the page token. Passing a different value might lead to unexpected results.

    • filter (::String) (defaults to: nil) —

      Required. A query filter.

      You can filter subscriptions by event type (event_types) and target resource (target_resource).

      You must specify at least one event type in your query. To filter for multiple event types, use the OR operator.

      To filter by both event type and target resource, use the AND operator and specify the full resource name, such as //chat.googleapis.com/spaces/{space}.

      For example, the following queries are valid:

      event_types:"google.workspace.chat.membership.v1.updated" OR
  event_types:"google.workspace.chat.message.v1.created"

event_types:"google.workspace.chat.message.v1.created" AND
  target_resource="//chat.googleapis.com/spaces/\\{space}"

( event_types:"google.workspace.chat.membership.v1.updated" OR
  event_types:"google.workspace.chat.message.v1.created" ) AND
  target_resource="//chat.googleapis.com/spaces/\\{space}"

      The server rejects invalid queries with an INVALID_ARGUMENT error.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
 
# File 'lib/google/apps/events/subscriptions/v1/subscriptions_service/client.rb', line 599

def list_subscriptions request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Events::Subscriptions::V1::ListSubscriptionsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.list_subscriptions.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Apps::Events::Subscriptions::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_subscriptions.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_subscriptions.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @subscriptions_service_stub.call_rpc :list_subscriptions, request, options: options do |response, operation|
    response = ::Gapic::PagedEnumerable.new @subscriptions_service_stub, :list_subscriptions, request, response, operation, options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


213
214
215
 
# File 'lib/google/apps/events/subscriptions/v1/subscriptions_service/client.rb', line 213

def logger
  @subscriptions_service_stub.logger
end

#reactivate_subscription(request, options = nil) ⇒ ::Gapic::Operation #reactivate_subscription(name: nil) ⇒ ::Gapic::Operation

Reactivates a suspended Google Workspace subscription.

This method resets your subscription's State field to ACTIVE. Before you use this method, you must fix the error that suspended the subscription. To learn how to use this method, see Reactivate a Google Workspace subscription.

Examples:

Basic example

require "google/apps/events/subscriptions/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Events::Subscriptions::V1::SubscriptionsService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Events::Subscriptions::V1::ReactivateSubscriptionRequest.new

# Call the reactivate_subscription method.
result = client.reactivate_subscription request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #reactivate_subscription(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to reactivate_subscription via a request object, either of type ReactivateSubscriptionRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Apps::Events::Subscriptions::V1::ReactivateSubscriptionRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #reactivate_subscription(name: nil) ⇒ ::Gapic::Operation

    Pass arguments to reactivate_subscription via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. Resource name of the subscription.

      Format: subscriptions/{subscription}

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
 
# File 'lib/google/apps/events/subscriptions/v1/subscriptions_service/client.rb', line 805

def reactivate_subscription request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Events::Subscriptions::V1::ReactivateSubscriptionRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.reactivate_subscription.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Apps::Events::Subscriptions::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.reactivate_subscription.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.reactivate_subscription.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @subscriptions_service_stub.call_rpc :reactivate_subscription, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


123
124
125
 
# File 'lib/google/apps/events/subscriptions/v1/subscriptions_service/client.rb', line 123

def universe_domain
  @subscriptions_service_stub.universe_domain
end

#update_subscription(request, options = nil) ⇒ ::Gapic::Operation #update_subscription(subscription: nil, update_mask: nil, validate_only: nil) ⇒ ::Gapic::Operation

Updates or renews a Google Workspace subscription. To learn how to use this method, see Update or renew a Google Workspace subscription.

Examples:

Basic example

require "google/apps/events/subscriptions/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Apps::Events::Subscriptions::V1::SubscriptionsService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Apps::Events::Subscriptions::V1::UpdateSubscriptionRequest.new

# Call the update_subscription method.
result = client.update_subscription request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #update_subscription(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to update_subscription via a request object, either of type UpdateSubscriptionRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Apps::Events::Subscriptions::V1::UpdateSubscriptionRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #update_subscription(subscription: nil, update_mask: nil, validate_only: nil) ⇒ ::Gapic::Operation

    Pass arguments to update_subscription via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • subscription (::Google::Apps::Events::Subscriptions::V1::Subscription, ::Hash) (defaults to: nil) —

      Required. The subscription to update.

      The subscription's name field is used to identify the subscription to update.

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Optional. Required. The field to update.

      You can update one of the following fields in a subscription:

      • expire_time: The timestamp when the subscription expires.
      • ttl: The time-to-live (TTL) or duration of the subscription.
    • validate_only (::Boolean) (defaults to: nil) —

      Optional. If set to true, validates and previews the request, but doesn't update the subscription.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
 
# File 'lib/google/apps/events/subscriptions/v1/subscriptions_service/client.rb', line 703

def update_subscription request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Apps::Events::Subscriptions::V1::UpdateSubscriptionRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_subscription.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Apps::Events::Subscriptions::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.subscription&.name
    header_params["subscription.name"] = request.subscription.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_subscription.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_subscription.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @subscriptions_service_stub.call_rpc :update_subscription, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    throw :response, response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end