Class: Google::Cloud::AdvisoryNotifications::V1::AdvisoryNotificationsService::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/advisory_notifications/v1/advisory_notifications_service/client.rb

Overview

Client for the AdvisoryNotificationsService service.

Service to manage Security and Privacy Notifications.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#location_path, #notification_path, #settings_path

Constructor Details

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

Create a new AdvisoryNotificationsService client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::AdvisoryNotifications::V1::AdvisoryNotificationsService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::AdvisoryNotifications::V1::AdvisoryNotificationsService::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the AdvisoryNotificationsService client.

Yield Parameters:



131
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
 
# File 'lib/google/cloud/advisory_notifications/v1/advisory_notifications_service/client.rb', line 131

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/cloud/advisorynotifications/v1/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

  @advisory_notifications_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::AdvisoryNotifications::V1::AdvisoryNotificationsService::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
  )
end

Class Method Details

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

Configure the AdvisoryNotificationsService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all AdvisoryNotificationsService clients
::Google::Cloud::AdvisoryNotifications::V1::AdvisoryNotificationsService::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/google/cloud/advisory_notifications/v1/advisory_notifications_service/client.rb', line 59

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

    default_config.rpcs.get_notification.timeout = 60.0
    default_config.rpcs.get_notification.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 AdvisoryNotificationsService 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:



101
102
103
104
 
# File 'lib/google/cloud/advisory_notifications/v1/advisory_notifications_service/client.rb', line 101

def configure
  yield @config if block_given?
  @config
end

#get_notification(request, options = nil) ⇒ ::Google::Cloud::AdvisoryNotifications::V1::Notification #get_notification(name: nil, language_code: nil) ⇒ ::Google::Cloud::AdvisoryNotifications::V1::Notification

Gets a notification.

Examples:

Basic example

require "google/cloud/advisory_notifications/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AdvisoryNotifications::V1::AdvisoryNotificationsService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AdvisoryNotifications::V1::GetNotificationRequest.new

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

# The returned object is of type Google::Cloud::AdvisoryNotifications::V1::Notification.
p result

Overloads:

  • #get_notification(request, options = nil) ⇒ ::Google::Cloud::AdvisoryNotifications::V1::Notification

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

    Parameters:

    • request (::Google::Cloud::AdvisoryNotifications::V1::GetNotificationRequest, ::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_notification(name: nil, language_code: nil) ⇒ ::Google::Cloud::AdvisoryNotifications::V1::Notification

    Pass arguments to get_notification 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. A name of the notification to retrieve. Format: organizations/{organization}/locations/{location}/notifications/{notification} or projects/{projects}/locations/{location}/notifications/{notification}.

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

      ISO code for requested localization language. If unset, will be interpereted as "en". If the requested language is valid, but not supported for this notification, English will be returned with an "Not applicable" LocalizationState. If the ISO code is invalid (i.e. not a real language), this RPC will throw an error.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/google/cloud/advisory_notifications/v1/advisory_notifications_service/client.rb', line 336

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AdvisoryNotifications::V1::GetNotificationRequest

  # 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_notification.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project 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::Cloud::AdvisoryNotifications::V1::VERSION
  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_notification.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_notification.retry_policy

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

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

#get_settings(request, options = nil) ⇒ ::Google::Cloud::AdvisoryNotifications::V1::Settings #get_settings(name: nil) ⇒ ::Google::Cloud::AdvisoryNotifications::V1::Settings

Get notification settings.

Examples:

Basic example

require "google/cloud/advisory_notifications/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AdvisoryNotifications::V1::AdvisoryNotificationsService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AdvisoryNotifications::V1::GetSettingsRequest.new

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

# The returned object is of type Google::Cloud::AdvisoryNotifications::V1::Settings.
p result

Overloads:

  • #get_settings(request, options = nil) ⇒ ::Google::Cloud::AdvisoryNotifications::V1::Settings

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

    Parameters:

    • request (::Google::Cloud::AdvisoryNotifications::V1::GetSettingsRequest, ::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_settings(name: nil) ⇒ ::Google::Cloud::AdvisoryNotifications::V1::Settings

    Pass arguments to get_settings 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 resource name of the settings to retrieve. Format: organizations/{organization}/locations/{location}/settings.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
 
# File 'lib/google/cloud/advisory_notifications/v1/advisory_notifications_service/client.rb', line 423

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AdvisoryNotifications::V1::GetSettingsRequest

  # 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_settings.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project 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::Cloud::AdvisoryNotifications::V1::VERSION
  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_settings.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_settings.retry_policy

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

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

#list_notifications(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AdvisoryNotifications::V1::Notification> #list_notifications(parent: nil, page_size: nil, page_token: nil, view: nil, language_code: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AdvisoryNotifications::V1::Notification>

Lists notifications under a given parent.

Examples:

Basic example

require "google/cloud/advisory_notifications/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AdvisoryNotifications::V1::AdvisoryNotificationsService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AdvisoryNotifications::V1::ListNotificationsRequest.new

# Call the list_notifications method.
result = client.list_notifications 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::Cloud::AdvisoryNotifications::V1::Notification.
  p item
end

Overloads:

  • #list_notifications(request, options = nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AdvisoryNotifications::V1::Notification>

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

    Parameters:

    • request (::Google::Cloud::AdvisoryNotifications::V1::ListNotificationsRequest, ::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_notifications(parent: nil, page_size: nil, page_token: nil, view: nil, language_code: nil) ⇒ ::Gapic::PagedEnumerable<::Google::Cloud::AdvisoryNotifications::V1::Notification>

    Pass arguments to list_notifications 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 parent, which owns this collection of notifications. Must be of the form "organizations/{organization}/locations/{location}" or "projects/{project}/locations/{location}"

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

      The maximum number of notifications to return. The service may return fewer than this value. If unspecified or equal to 0, at most 50 notifications will be returned. The maximum value is 50; values above 50 will be coerced to 50.

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

      A page token returned from a previous request. When paginating, all other parameters provided in the request must match the call that returned the page token.

    • view (::Google::Cloud::AdvisoryNotifications::V1::NotificationView) (defaults to: nil) —

      Specifies which parts of the notification resource should be returned in the response.

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

      ISO code for requested localization language. If unset, will be interpereted as "en". If the requested language is valid, but not supported for this notification, English will be returned with an "Not applicable" LocalizationState. If the ISO code is invalid (i.e. not a real language), this RPC will throw an error.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/google/cloud/advisory_notifications/v1/advisory_notifications_service/client.rb', line 241

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AdvisoryNotifications::V1::ListNotificationsRequest

  # 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_notifications.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project 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::Cloud::AdvisoryNotifications::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  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.list_notifications.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.list_notifications.retry_policy

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

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

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


111
112
113
 
# File 'lib/google/cloud/advisory_notifications/v1/advisory_notifications_service/client.rb', line 111

def universe_domain
  @advisory_notifications_service_stub.universe_domain
end

#update_settings(request, options = nil) ⇒ ::Google::Cloud::AdvisoryNotifications::V1::Settings #update_settings(settings: nil) ⇒ ::Google::Cloud::AdvisoryNotifications::V1::Settings

Update notification settings.

Examples:

Basic example

require "google/cloud/advisory_notifications/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::AdvisoryNotifications::V1::AdvisoryNotificationsService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::AdvisoryNotifications::V1::UpdateSettingsRequest.new

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

# The returned object is of type Google::Cloud::AdvisoryNotifications::V1::Settings.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'lib/google/cloud/advisory_notifications/v1/advisory_notifications_service/client.rb', line 508

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::AdvisoryNotifications::V1::UpdateSettingsRequest

  # 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_settings.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project 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::Cloud::AdvisoryNotifications::V1::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.settings&.name
    header_params["settings.name"] = request.settings.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_settings.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_settings.retry_policy

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

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