Class: Google::Shopping::Merchant::Notifications::V1beta::NotificationsApiService::Rest::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/shopping/merchant/notifications/v1beta/notifications_api_service/rest/client.rb

Overview

REST client for the NotificationsApiService service.

Service to manage notification subscriptions for merchants

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#account_path, #notification_subscription_path

Constructor Details

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

Create a new NotificationsApiService REST client object.

Examples:


# Create a client using the default configuration
client = ::Google::Shopping::Merchant::Notifications::V1beta::NotificationsApiService::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Shopping::Merchant::Notifications::V1beta::NotificationsApiService::Rest::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the NotificationsApiService client.

Yield Parameters:



132
133
134
135
136
137
138
139
140
141
142
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
 
# File 'lib/google/shopping/merchant/notifications/v1beta/notifications_api_service/rest/client.rb', line 132

def initialize
  # 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

  @notifications_api_service_stub = ::Google::Shopping::Merchant::Notifications::V1beta::NotificationsApiService::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials,
    logger: @config.logger
  )

  @notifications_api_service_stub.logger(stub: true)&.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

Class Method Details

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

Configure the NotificationsApiService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all NotificationsApiService clients
::Google::Shopping::Merchant::Notifications::V1beta::NotificationsApiService::Rest::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/google/shopping/merchant/notifications/v1beta/notifications_api_service/rest/client.rb', line 65

def self.configure
  @configure ||= begin
    namespace = ["Google", "Shopping", "Merchant", "Notifications", "V1beta"]
    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.timeout = 60.0
    default_config.retry_policy = {
      initial_delay: 1.0, max_delay: 10.0, multiplier: 1.3, retry_codes: [14]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

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

Configure the NotificationsApiService 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:



102
103
104
105
 
# File 'lib/google/shopping/merchant/notifications/v1beta/notifications_api_service/rest/client.rb', line 102

def configure
  yield @config if block_given?
  @config
end

#create_notification_subscription(request, options = nil) ⇒ ::Google::Shopping::Merchant::Notifications::V1beta::NotificationSubscription #create_notification_subscription(parent: nil, notification_subscription: nil) ⇒ ::Google::Shopping::Merchant::Notifications::V1beta::NotificationSubscription

Creates a notification subscription for a merchant. We will allow the following types of notification subscriptions to exist together (per merchant as a subscriber per event type):

  1. Subscription for all managed accounts + subscription for self
  2. Multiple "partial" subscriptions for managed accounts + subscription for self

we will not allow (per merchant as a subscriber per event type):

  1. multiple self subscriptions.
  2. multiple "all managed accounts" subscriptions.
  3. all and partial subscriptions at the same time.
  4. multiple partial subscriptions for the same target account

Examples:

Basic example

require "google/shopping/merchant/notifications/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Shopping::Merchant::Notifications::V1beta::NotificationsApiService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Shopping::Merchant::Notifications::V1beta::CreateNotificationSubscriptionRequest.new

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

# The returned object is of type Google::Shopping::Merchant::Notifications::V1beta::NotificationSubscription.
p result

Overloads:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/google/shopping/merchant/notifications/v1beta/notifications_api_service/rest/client.rb', line 320

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Notifications::V1beta::CreateNotificationSubscriptionRequest

  # 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
  call_metadata = @config.rpcs.create_notification_subscription.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Shopping::Merchant::Notifications::V1beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_notification_subscription.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_notification_subscription.retry_policy

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

  @notifications_api_service_stub.create_notification_subscription request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_notification_subscription(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_notification_subscription(name: nil) ⇒ ::Google::Protobuf::Empty

Deletes a notification subscription for a merchant.

Examples:

Basic example

require "google/shopping/merchant/notifications/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Shopping::Merchant::Notifications::V1beta::NotificationsApiService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Shopping::Merchant::Notifications::V1beta::DeleteNotificationSubscriptionRequest.new

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

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #delete_notification_subscription(request, options = nil) ⇒ ::Google::Protobuf::Empty

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

    Parameters:

  • #delete_notification_subscription(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_notification_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. The name of the notification subscription to be deleted.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



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
507
508
509
510
511
512
 
# File 'lib/google/shopping/merchant/notifications/v1beta/notifications_api_service/rest/client.rb', line 479

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Notifications::V1beta::DeleteNotificationSubscriptionRequest

  # 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
  call_metadata = @config.rpcs.delete_notification_subscription.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Shopping::Merchant::Notifications::V1beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_notification_subscription.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_notification_subscription.retry_policy

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

  @notifications_api_service_stub.delete_notification_subscription request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_notification_subscription(request, options = nil) ⇒ ::Google::Shopping::Merchant::Notifications::V1beta::NotificationSubscription #get_notification_subscription(name: nil) ⇒ ::Google::Shopping::Merchant::Notifications::V1beta::NotificationSubscription

Gets notification subscriptions for an account.

Examples:

Basic example

require "google/shopping/merchant/notifications/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Shopping::Merchant::Notifications::V1beta::NotificationsApiService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Shopping::Merchant::Notifications::V1beta::GetNotificationSubscriptionRequest.new

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

# The returned object is of type Google::Shopping::Merchant::Notifications::V1beta::NotificationSubscription.
p result

Overloads:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/google/shopping/merchant/notifications/v1beta/notifications_api_service/rest/client.rb', line 228

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Notifications::V1beta::GetNotificationSubscriptionRequest

  # 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
  call_metadata = @config.rpcs.get_notification_subscription.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Shopping::Merchant::Notifications::V1beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_notification_subscription.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_notification_subscription.retry_policy

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

  @notifications_api_service_stub.get_notification_subscription request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#list_notification_subscriptions(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Shopping::Merchant::Notifications::V1beta::NotificationSubscription> #list_notification_subscriptions(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Shopping::Merchant::Notifications::V1beta::NotificationSubscription>

Gets all the notification subscriptions for a merchant.

Examples:

Basic example

require "google/shopping/merchant/notifications/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Shopping::Merchant::Notifications::V1beta::NotificationsApiService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Shopping::Merchant::Notifications::V1beta::ListNotificationSubscriptionsRequest.new

# Call the list_notification_subscriptions method.
result = client.list_notification_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::Shopping::Merchant::Notifications::V1beta::NotificationSubscription.
  p item
end

Overloads:

  • #list_notification_subscriptions(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Shopping::Merchant::Notifications::V1beta::NotificationSubscription>

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

    Parameters:

  • #list_notification_subscriptions(parent: nil, page_size: nil, page_token: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Shopping::Merchant::Notifications::V1beta::NotificationSubscription>

    Pass arguments to list_notification_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:

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

      Required. The merchant account who owns the notification subscriptions. Format: accounts/{account}

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

      The maximum number of notification subscriptions to return in a page. The default value for page_size is 100. The maximum value is 200. Values above 200 will be coerced to 200.

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

      Token (if provided) to retrieve the subsequent page. All other parameters must match the original call that provided the page token.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
 
# File 'lib/google/shopping/merchant/notifications/v1beta/notifications_api_service/rest/client.rb', line 569

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Notifications::V1beta::ListNotificationSubscriptionsRequest

  # 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
  call_metadata = @config.rpcs.list_notification_subscriptions.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Shopping::Merchant::Notifications::V1beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_notification_subscriptions.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.list_notification_subscriptions.retry_policy

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

  @notifications_api_service_stub.list_notification_subscriptions request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @notifications_api_service_stub, :list_notification_subscriptions, "notification_subscriptions", request, result, options
    yield result, operation if block_given?
    throw :response, result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


179
180
181
 
# File 'lib/google/shopping/merchant/notifications/v1beta/notifications_api_service/rest/client.rb', line 179

def logger
  @notifications_api_service_stub.logger
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


112
113
114
 
# File 'lib/google/shopping/merchant/notifications/v1beta/notifications_api_service/rest/client.rb', line 112

def universe_domain
  @notifications_api_service_stub.universe_domain
end

#update_notification_subscription(request, options = nil) ⇒ ::Google::Shopping::Merchant::Notifications::V1beta::NotificationSubscription #update_notification_subscription(notification_subscription: nil, update_mask: nil) ⇒ ::Google::Shopping::Merchant::Notifications::V1beta::NotificationSubscription

Updates an existing notification subscription for a merchant.

Examples:

Basic example

require "google/shopping/merchant/notifications/v1beta"

# Create a client object. The client can be reused for multiple calls.
client = Google::Shopping::Merchant::Notifications::V1beta::NotificationsApiService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Shopping::Merchant::Notifications::V1beta::UpdateNotificationSubscriptionRequest.new

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

# The returned object is of type Google::Shopping::Merchant::Notifications::V1beta::NotificationSubscription.
p result

Overloads:

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
 
# File 'lib/google/shopping/merchant/notifications/v1beta/notifications_api_service/rest/client.rb', line 401

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Shopping::Merchant::Notifications::V1beta::UpdateNotificationSubscriptionRequest

  # 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
  call_metadata = @config.rpcs.update_notification_subscription.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Shopping::Merchant::Notifications::V1beta::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_notification_subscription.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_notification_subscription.retry_policy

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

  @notifications_api_service_stub.update_notification_subscription request, options do |result, operation|
    yield result, operation if block_given?
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end