Class: OCI::AnnouncementsService::AnnouncementSubscriptionClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/announcements_service/announcement_subscription_client.rb

Overview

Manage Oracle Cloud Infrastructure console announcements.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ AnnouncementSubscriptionClient

Creates a new AnnouncementSubscriptionClient. Notes: If a config is not specified, then the global OCI.config will be used.

This client is not thread-safe

Either a region or an endpoint must be specified. If an endpoint is specified, it will be used instead of the region. A region may be specified in the config or via or the region parameter. If specified in both, then the region parameter will be used.

Parameters:

  • config (Config) (defaults to: nil) —

    A Config object.

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

    A region used to determine the service endpoint. This will usually correspond to a value in Regions::REGION_ENUM, but may be an arbitrary string.

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

    The fully qualified endpoint URL

  • signer (OCI::BaseSigner) (defaults to: nil) —

    A signer implementation which can be used by this client. If this is not provided then a signer will be constructed via the provided config. One use case of this parameter is instance principals authentication, so that the instance principals signer can be provided to the client

  • proxy_settings (OCI::ApiClientProxySettings) (defaults to: nil) —

    If your environment requires you to use a proxy server for outgoing HTTP requests the details for the proxy can be provided in this parameter

  • retry_config (OCI::Retry::RetryConfig) (defaults to: nil) —

    The retry configuration for this service client. This represents the default retry configuration to apply across all operations. This can be overridden on a per-operation basis. The default retry configuration value is nil, which means that an operation will not perform any retries



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/oci/announcements_service/announcement_subscription_client.rb', line 55

def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil)
  # If the signer is an InstancePrincipalsSecurityTokenSigner or SecurityTokenSigner and no config was supplied (they are self-sufficient signers)
  # then create a dummy config to pass to the ApiClient constructor. If customers wish to create a client which uses instance principals
  # and has config (either populated programmatically or loaded from a file), they must construct that config themselves and then
  # pass it to this constructor.
  #
  # If there is no signer (or the signer is not an instance principals signer) and no config was supplied, this is not valid
  # so try and load the config from the default file.
  config = OCI::Config.validate_and_build_config_with_signer(config, signer)

  signer = OCI::Signer.config_file_auth_builder(config) if signer.nil?

  @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings)
  @retry_config = retry_config

  if endpoint
    @endpoint = endpoint + '/20180904'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "AnnouncementSubscriptionClient endpoint set to '#{@endpoint}'." if logger
end

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



15
16
17
 
# File 'lib/oci/announcements_service/announcement_subscription_client.rb', line 15

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/announcements_service/announcement_subscription_client.rb', line 19

def endpoint
  @endpoint
end

#region ⇒ String

The region, which will usually correspond to a value in Regions::REGION_ENUM.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/announcements_service/announcement_subscription_client.rb', line 29

def region
  @region
end

#retry_config ⇒ OCI::Retry::RetryConfig (readonly)

The default retry configuration to apply to all operations in this service client. This can be overridden on a per-operation basis. The default retry configuration value is nil, which means that an operation will not perform any retries

Returns:



25
26
27
 
# File 'lib/oci/announcements_service/announcement_subscription_client.rb', line 25

def retry_config
  @retry_config
end

Instance Method Details

#change_announcement_subscription_compartment(announcement_subscription_id, change_announcement_subscription_compartment_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use change_announcement_subscription_compartment API.

Moves the specified announcement subscription from one compartment to another compartment. When provided, If-Match is checked against ETag values of the resource.

This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    The locking version, used for optimistic concurrency control.

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the complete request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



118
119
120
121
122
123
124
125
126
127
128
129
130
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
 
# File 'lib/oci/announcements_service/announcement_subscription_client.rb', line 118

def change_announcement_subscription_compartment(announcement_subscription_id, change_announcement_subscription_compartment_details, opts = {})
  logger.debug 'Calling operation AnnouncementSubscriptionClient#change_announcement_subscription_compartment.' if logger

  raise "Missing the required parameter 'announcement_subscription_id' when calling change_announcement_subscription_compartment." if announcement_subscription_id.nil?
  raise "Missing the required parameter 'change_announcement_subscription_compartment_details' when calling change_announcement_subscription_compartment." if change_announcement_subscription_compartment_details.nil?
  raise "Parameter value for 'announcement_subscription_id' must not be blank" if OCI::Internal::Util.blank_string?(announcement_subscription_id)

  path = '/announcementSubscriptions/{announcementSubscriptionId}/actions/changeCompartment'.sub('{announcementSubscriptionId}', announcement_subscription_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(change_announcement_subscription_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'AnnouncementSubscriptionClient#change_announcement_subscription_compartment') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_announcement_subscription(create_announcement_subscription_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_announcement_subscription API.

Creates a new announcement subscription.

This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the complete request ID.

Returns:



184
185
186
187
188
189
190
191
192
193
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
 
# File 'lib/oci/announcements_service/announcement_subscription_client.rb', line 184

def create_announcement_subscription(create_announcement_subscription_details, opts = {})
  logger.debug 'Calling operation AnnouncementSubscriptionClient#create_announcement_subscription.' if logger

  raise "Missing the required parameter 'create_announcement_subscription_details' when calling create_announcement_subscription." if create_announcement_subscription_details.nil?

  path = '/announcementSubscriptions'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_announcement_subscription_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'AnnouncementSubscriptionClient#create_announcement_subscription') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::AnnouncementsService::Models::AnnouncementSubscription'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_filter_group(announcement_subscription_id, create_filter_group_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use create_filter_group API.

Creates a new filter group in the specified announcement subscription.

This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the complete request ID.

  • :if_match (String) —

    The locking version, used for optimistic concurrency control.

Returns:



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
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/oci/announcements_service/announcement_subscription_client.rb', line 252

def create_filter_group(announcement_subscription_id, create_filter_group_details, opts = {})
  logger.debug 'Calling operation AnnouncementSubscriptionClient#create_filter_group.' if logger

  raise "Missing the required parameter 'announcement_subscription_id' when calling create_filter_group." if announcement_subscription_id.nil?
  raise "Missing the required parameter 'create_filter_group_details' when calling create_filter_group." if create_filter_group_details.nil?
  raise "Parameter value for 'announcement_subscription_id' must not be blank" if OCI::Internal::Util.blank_string?(announcement_subscription_id)

  path = '/announcementSubscriptions/{announcementSubscriptionId}/filterGroups'.sub('{announcementSubscriptionId}', announcement_subscription_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_filter_group_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'AnnouncementSubscriptionClient#create_filter_group') do
    @api_client.call_api(
      :POST,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::AnnouncementsService::Models::FilterGroup'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_announcement_subscription(announcement_subscription_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_announcement_subscription API.

Deletes the specified announcement subscription.

This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

Parameters:

  • announcement_subscription_id (String) —

    The OCID of the announcement subscription.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    The locking version, used for optimistic concurrency control.

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the complete request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



316
317
318
319
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
 
# File 'lib/oci/announcements_service/announcement_subscription_client.rb', line 316

def delete_announcement_subscription(announcement_subscription_id, opts = {})
  logger.debug 'Calling operation AnnouncementSubscriptionClient#delete_announcement_subscription.' if logger

  raise "Missing the required parameter 'announcement_subscription_id' when calling delete_announcement_subscription." if announcement_subscription_id.nil?
  raise "Parameter value for 'announcement_subscription_id' must not be blank" if OCI::Internal::Util.blank_string?(announcement_subscription_id)

  path = '/announcementSubscriptions/{announcementSubscriptionId}'.sub('{announcementSubscriptionId}', announcement_subscription_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'AnnouncementSubscriptionClient#delete_announcement_subscription') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_filter_group(announcement_subscription_id, filter_group_name, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use delete_filter_group API.

Deletes a filter group in the specified announcement subscription.

This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

Parameters:

  • announcement_subscription_id (String) —

    The OCID of the announcement subscription.

  • filter_group_name (String) —

    The name of the filter group.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the complete request ID.

  • :if_match (String) —

    The locking version, used for optimistic concurrency control.

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/announcements_service/announcement_subscription_client.rb', line 377

def delete_filter_group(announcement_subscription_id, filter_group_name, opts = {})
  logger.debug 'Calling operation AnnouncementSubscriptionClient#delete_filter_group.' if logger

  raise "Missing the required parameter 'announcement_subscription_id' when calling delete_filter_group." if announcement_subscription_id.nil?
  raise "Missing the required parameter 'filter_group_name' when calling delete_filter_group." if filter_group_name.nil?
  raise "Parameter value for 'announcement_subscription_id' must not be blank" if OCI::Internal::Util.blank_string?(announcement_subscription_id)
  raise "Parameter value for 'filter_group_name' must not be blank" if OCI::Internal::Util.blank_string?(filter_group_name)

  path = '/announcementSubscriptions/{announcementSubscriptionId}/filterGroups/{filterGroupName}'.sub('{announcementSubscriptionId}', announcement_subscription_id.to_s).sub('{filterGroupName}', filter_group_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'AnnouncementSubscriptionClient#delete_filter_group') do
    @api_client.call_api(
      :DELETE,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_announcement_subscription(announcement_subscription_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use get_announcement_subscription API.

Gets the specified announcement subscription.

This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

Parameters:

  • announcement_subscription_id (String) —

    The OCID of the announcement subscription.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the complete request ID.

Returns:



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
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'lib/oci/announcements_service/announcement_subscription_client.rb', line 438

def get_announcement_subscription(announcement_subscription_id, opts = {})
  logger.debug 'Calling operation AnnouncementSubscriptionClient#get_announcement_subscription.' if logger

  raise "Missing the required parameter 'announcement_subscription_id' when calling get_announcement_subscription." if announcement_subscription_id.nil?
  raise "Parameter value for 'announcement_subscription_id' must not be blank" if OCI::Internal::Util.blank_string?(announcement_subscription_id)

  path = '/announcementSubscriptions/{announcementSubscriptionId}'.sub('{announcementSubscriptionId}', announcement_subscription_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'AnnouncementSubscriptionClient#get_announcement_subscription') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::AnnouncementsService::Models::AnnouncementSubscription'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_announcement_subscriptions(compartment_id, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use list_announcement_subscriptions API.

Gets a list of all announcement subscriptions in the specified compartment.

This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

Allowed values are: timeCreated, displayName

Parameters:

  • compartment_id (String) —

    The OCID of the compartment.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :lifecycle_state (String) —

    A filter to return only announcement subscriptions that match the given lifecycle state.

  • :display_name (String) —

    A filter to return only resources that match the entire display name given.

  • :id (String) —

    The OCID of the announcement subscription.

  • :limit (Integer) —

    The maximum number of items to return in a paginated "List" call.

  • :page (String) —

    The value of the opc-next-page response header from the previous "List" call.

  • :sort_order (String) —

    The sort order to use, whether ascending ('ASC') or descending ('DESC').

  • :sort_by (String) —

    The criteria to sort by. You can specify only one sort order. The default sort order for the creation date of resources is descending. The default sort order for display names is ascending. (default to timeCreated)

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the complete request ID.

Returns:



507
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
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
 
# File 'lib/oci/announcements_service/announcement_subscription_client.rb', line 507

def list_announcement_subscriptions(compartment_id, opts = {})
  logger.debug 'Calling operation AnnouncementSubscriptionClient#list_announcement_subscriptions.' if logger

  raise "Missing the required parameter 'compartment_id' when calling list_announcement_subscriptions." if compartment_id.nil?

  if opts[:lifecycle_state] && !OCI::AnnouncementsService::Models::AnnouncementSubscription::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::AnnouncementsService::Models::AnnouncementSubscription::LIFECYCLE_STATE_ENUM.'
  end

  if opts[:sort_order] && !OCI::AnnouncementsService::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::AnnouncementsService::Models::SORT_ORDER_ENUM.'
  end

  if opts[:sort_by] && !%w[timeCreated displayName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, displayName.'
  end

  path = '/announcementSubscriptions'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'AnnouncementSubscriptionClient#list_announcement_subscriptions') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::AnnouncementsService::Models::AnnouncementSubscriptionCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#logger ⇒ Logger

Returns The logger for this client. May be nil.

Returns:

  • (Logger) —

    The logger for this client. May be nil.



94
95
96
 
# File 'lib/oci/announcements_service/announcement_subscription_client.rb', line 94

def logger
  @api_client.config.logger
end

#update_announcement_subscription(announcement_subscription_id, update_announcement_subscription_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_announcement_subscription API.

Updates the specified announcement subscription.

This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

Parameters:

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :if_match (String) —

    The locking version, used for optimistic concurrency control.

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the complete request ID.

Returns:



587
588
589
590
591
592
593
594
595
596
597
598
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
 
# File 'lib/oci/announcements_service/announcement_subscription_client.rb', line 587

def update_announcement_subscription(announcement_subscription_id, update_announcement_subscription_details, opts = {})
  logger.debug 'Calling operation AnnouncementSubscriptionClient#update_announcement_subscription.' if logger

  raise "Missing the required parameter 'announcement_subscription_id' when calling update_announcement_subscription." if announcement_subscription_id.nil?
  raise "Missing the required parameter 'update_announcement_subscription_details' when calling update_announcement_subscription." if update_announcement_subscription_details.nil?
  raise "Parameter value for 'announcement_subscription_id' must not be blank" if OCI::Internal::Util.blank_string?(announcement_subscription_id)

  path = '/announcementSubscriptions/{announcementSubscriptionId}'.sub('{announcementSubscriptionId}', announcement_subscription_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_announcement_subscription_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'AnnouncementSubscriptionClient#update_announcement_subscription') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::AnnouncementsService::Models::AnnouncementSubscription'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_filter_group(announcement_subscription_id, filter_group_name, update_filter_group_details, opts = {}) ⇒ Response

Note:

Click here to see an example of how to use update_filter_group API.

Updates a filter group in the specified announcement subscription.

This call is subject to an Announcements limit that applies to the total number of requests across all read or write operations. Announcements might throttle this call to reject an otherwise valid request when the total rate of operations exceeds 20 requests per second for a given user. The service might also throttle this call to reject an otherwise valid request when the total rate of operations exceeds 100 requests per second for a given tenancy.

Parameters:

  • announcement_subscription_id (String) —

    The OCID of the announcement subscription.

  • filter_group_name (String) —

    The name of the filter group.

  • update_filter_group_details (OCI::AnnouncementsService::Models::UpdateFilterGroupDetails) —

    The filter group information to update.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :retry_config (OCI::Retry::RetryConfig) —

    The retry configuration to apply to this operation. If no key is provided then the service-level retry configuration defined by #retry_config will be used. If an explicit nil value is provided then the operation will not retry

  • :opc_request_id (String) —

    The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the complete request ID.

  • :if_match (String) —

    The locking version, used for optimistic concurrency control.

Returns:



651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
 
# File 'lib/oci/announcements_service/announcement_subscription_client.rb', line 651

def update_filter_group(announcement_subscription_id, filter_group_name, update_filter_group_details, opts = {})
  logger.debug 'Calling operation AnnouncementSubscriptionClient#update_filter_group.' if logger

  raise "Missing the required parameter 'announcement_subscription_id' when calling update_filter_group." if announcement_subscription_id.nil?
  raise "Missing the required parameter 'filter_group_name' when calling update_filter_group." if filter_group_name.nil?
  raise "Missing the required parameter 'update_filter_group_details' when calling update_filter_group." if update_filter_group_details.nil?
  raise "Parameter value for 'announcement_subscription_id' must not be blank" if OCI::Internal::Util.blank_string?(announcement_subscription_id)
  raise "Parameter value for 'filter_group_name' must not be blank" if OCI::Internal::Util.blank_string?(filter_group_name)

  path = '/announcementSubscriptions/{announcementSubscriptionId}/filterGroups/{filterGroupName}'.sub('{announcementSubscriptionId}', announcement_subscription_id.to_s).sub('{filterGroupName}', filter_group_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_filter_group_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'AnnouncementSubscriptionClient#update_filter_group') do
    @api_client.call_api(
      :PUT,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::AnnouncementsService::Models::FilterGroup'
    )
  end
  # rubocop:enable Metrics/BlockLength
end