Class: Google::Cloud::AdvisoryNotifications::V1::AdvisoryNotificationsService::Rest::Client
- Inherits:
-
Object
- Object
- Google::Cloud::AdvisoryNotifications::V1::AdvisoryNotificationsService::Rest::Client
- Includes:
- Paths
- Defined in:
- lib/google/cloud/advisory_notifications/v1/advisory_notifications_service/rest/client.rb
Overview
REST client for the AdvisoryNotificationsService service.
Service to manage Security and Privacy Notifications.
Defined Under Namespace
Classes: Configuration
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the AdvisoryNotificationsService Client class.
Instance Method Summary collapse
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the AdvisoryNotificationsService Client instance.
-
#get_notification(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::AdvisoryNotifications::V1::Notification
Gets a notification.
-
#get_settings(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::AdvisoryNotifications::V1::Settings
Get notification settings.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new AdvisoryNotificationsService REST client object.
-
#list_notifications(request, options = nil) {|result, operation| ... } ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::AdvisoryNotifications::V1::Notification>
Lists notifications under a given parent.
-
#update_settings(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::AdvisoryNotifications::V1::Settings
Update notification settings.
Methods included from Paths
#location_path, #notification_path, #settings_path
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new AdvisoryNotificationsService REST client object.
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 |
# File 'lib/google/cloud/advisory_notifications/v1/advisory_notifications_service/rest/client.rb', line 121 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 == 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 = ::Google::Cloud::AdvisoryNotifications::V1::AdvisoryNotificationsService::Rest::ServiceStub.new endpoint: @config.endpoint, credentials: credentials end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the AdvisoryNotificationsService Client class.
See Configuration for a description of the configuration fields.
58 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 |
# File 'lib/google/cloud/advisory_notifications/v1/advisory_notifications_service/rest/client.rb', line 58 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.
100 101 102 103 |
# File 'lib/google/cloud/advisory_notifications/v1/advisory_notifications_service/rest/client.rb', line 100 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.
303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 |
# File 'lib/google/cloud/advisory_notifications/v1/advisory_notifications_service/rest/client.rb', line 303 def get_notification request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.get_notification..to_h # Set x-goog-api-client and x-goog-user-project headers [:"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, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.get_notification.timeout, metadata: , retry_policy: @config.rpcs.get_notification.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @advisory_notifications_service_stub.get_notification request, do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => 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.
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 |
# File 'lib/google/cloud/advisory_notifications/v1/advisory_notifications_service/rest/client.rb', line 383 def get_settings request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.get_settings..to_h # Set x-goog-api-client and x-goog-user-project headers [:"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, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.get_settings.timeout, metadata: , retry_policy: @config.rpcs.get_settings.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @advisory_notifications_service_stub.get_settings request, do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#list_notifications(request, options = nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::AdvisoryNotifications::V1::Notification> #list_notifications(parent: nil, page_size: nil, page_token: nil, view: nil, language_code: nil) ⇒ ::Gapic::Rest::PagedEnumerable<::Google::Cloud::AdvisoryNotifications::V1::Notification>
Lists notifications under a given parent.
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 |
# File 'lib/google/cloud/advisory_notifications/v1/advisory_notifications_service/rest/client.rb', line 215 def list_notifications request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.list_notifications..to_h # Set x-goog-api-client and x-goog-user-project headers [:"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, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.list_notifications.timeout, metadata: , retry_policy: @config.rpcs.list_notifications.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @advisory_notifications_service_stub.list_notifications request, do |result, operation| result = ::Gapic::Rest::PagedEnumerable.new @advisory_notifications_service_stub, :list_notifications, "notifications", request, result, yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#update_settings(request, options = nil) ⇒ ::Google::Cloud::AdvisoryNotifications::V1::Settings #update_settings(settings: nil) ⇒ ::Google::Cloud::AdvisoryNotifications::V1::Settings
Update notification settings.
461 462 463 464 465 466 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 |
# File 'lib/google/cloud/advisory_notifications/v1/advisory_notifications_service/rest/client.rb', line 461 def update_settings request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.update_settings..to_h # Set x-goog-api-client and x-goog-user-project headers [:"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, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.update_settings.timeout, metadata: , retry_policy: @config.rpcs.update_settings.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @advisory_notifications_service_stub.update_settings request, do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |