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

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Methods included from Paths

#location_path, #notification_path

Constructor Details

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

Create a new AdvisoryNotificationsService REST client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the AdvisoryNotificationsService client.

Yield Parameters:



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.

Examples:


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

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



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.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



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.

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}.

    • 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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/google/cloud/advisory_notifications/v1/advisory_notifications_service/rest/client.rb', line 265

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

  # Set x-goog-api-client and x-goog-user-project 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::Cloud::AdvisoryNotifications::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_notification.timeout,
                         metadata:     call_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.get_notification request, options 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.

Overloads:

  • #list_notifications(request, options = nil) ⇒ ::Gapic::Rest::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::Rest::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}".

    • 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:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

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

    if the REST call is aborted.



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/google/cloud/advisory_notifications/v1/advisory_notifications_service/rest/client.rb', line 194

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

  # Set x-goog-api-client and x-goog-user-project 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::Cloud::AdvisoryNotifications::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_notifications.timeout,
                         metadata:     call_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.list_notifications request, options do |result, operation|
    result = ::Gapic::Rest::PagedEnumerable.new @advisory_notifications_service_stub, :list_notifications, "notifications", request, result, options
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end