Class: OCI::OsManagementHub::SoftwareSourceClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/os_management_hub/software_source_client.rb

Overview

Use the OS Management Hub API to manage and monitor updates and patches for the operating system environments in your private data centers through a single management console. For more information, see Overview of OS Management Hub.

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) ⇒ SoftwareSourceClient

Creates a new SoftwareSourceClient. 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/os_management_hub/software_source_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 + '/20220901'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "SoftwareSourceClient 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/os_management_hub/software_source_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/os_management_hub/software_source_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/os_management_hub/software_source_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/os_management_hub/software_source_client.rb', line 25

def retry_config
  @retry_config
end

Instance Method Details

#change_availability_of_software_sources(change_availability_of_software_sources_details, opts = {}) ⇒ Response

Note:

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

Updates the availability for a list of specified software sources.

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) —

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

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

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
 
# File 'lib/oci/os_management_hub/software_source_client.rb', line 118

def change_availability_of_software_sources(change_availability_of_software_sources_details, opts = {})
  logger.debug 'Calling operation SoftwareSourceClient#change_availability_of_software_sources.' if logger

  raise "Missing the required parameter 'change_availability_of_software_sources_details' when calling change_availability_of_software_sources." if change_availability_of_software_sources_details.nil?

  path = '/softwareSources/actions/changeAvailability'
  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[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(change_availability_of_software_sources_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'SoftwareSourceClient#change_availability_of_software_sources') 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_entitlement(create_entitlement_details, opts = {}) ⇒ Response

Note:

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

Registers the necessary entitlement credentials for OS vendor software sources.

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) —

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

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

Returns:

  • (Response) —

    A Response object with data of type nil



179
180
181
182
183
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
 
# File 'lib/oci/os_management_hub/software_source_client.rb', line 179

def create_entitlement(create_entitlement_details, opts = {})
  logger.debug 'Calling operation SoftwareSourceClient#create_entitlement.' if logger

  raise "Missing the required parameter 'create_entitlement_details' when calling create_entitlement." if create_entitlement_details.nil?

  path = '/entitlements'
  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[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_entitlement_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'SoftwareSourceClient#create_entitlement') 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_software_source(create_software_source_details, opts = {}) ⇒ Response

Note:

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

Creates a new versioned or custom software source.

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) —

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

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

Returns:



240
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
 
# File 'lib/oci/os_management_hub/software_source_client.rb', line 240

def create_software_source(create_software_source_details, opts = {})
  logger.debug 'Calling operation SoftwareSourceClient#create_software_source.' if logger

  raise "Missing the required parameter 'create_software_source_details' when calling create_software_source." if create_software_source_details.nil?

  path = '/softwareSources'
  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[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  # rubocop:enable Style/NegatedIf
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(create_software_source_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'SoftwareSourceClient#create_software_source') 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::OsManagementHub::Models::SoftwareSource'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_software_source(software_source_id, opts = {}) ⇒ Response

Note:

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

Deletes the specified software source.

Parameters:

  • software_source_id (String) —

    The software source OCID.

  • 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) —

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

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:

  • (Response) —

    A Response object with data of type nil



301
302
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
337
 
# File 'lib/oci/os_management_hub/software_source_client.rb', line 301

def delete_software_source(software_source_id, opts = {})
  logger.debug 'Calling operation SoftwareSourceClient#delete_software_source.' if logger

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

  path = '/softwareSources/{softwareSourceId}'.sub('{softwareSourceId}', software_source_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]
  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: 'SoftwareSourceClient#delete_software_source') 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_erratum(compartment_id, name, opts = {}) ⇒ Response

Note:

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

Gets information about the specified erratum by its advisory name.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment that contains the resources to list. This parameter is required.

  • name (String) —

    The erratum name (e.g. ELSA-2023-34678).

  • 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) —

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

Returns:



357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/oci/os_management_hub/software_source_client.rb', line 357

def get_erratum(compartment_id, name, opts = {})
  logger.debug 'Calling operation SoftwareSourceClient#get_erratum.' if logger

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

  path = '/errata/{name}'.sub('{name}', name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id

  # 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: 'SoftwareSourceClient#get_erratum') 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::OsManagementHub::Models::Erratum'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_module_stream(software_source_id, module_name, stream_name, opts = {}) ⇒ Response

Note:

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

Gets information about the specified module stream in a software source.

Parameters:

  • software_source_id (String) —

    The software source OCID.

  • module_name (String) —

    The name of the module.

  • stream_name (String) —

    The name of the stream of the containing module.

  • 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) —

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

Returns:



417
418
419
420
421
422
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
 
# File 'lib/oci/os_management_hub/software_source_client.rb', line 417

def get_module_stream(software_source_id, module_name, stream_name, opts = {})
  logger.debug 'Calling operation SoftwareSourceClient#get_module_stream.' if logger

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

  path = '/softwareSources/{softwareSourceId}/moduleStreams/{moduleName}'.sub('{softwareSourceId}', software_source_id.to_s).sub('{moduleName}', module_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:streamName] = stream_name

  # 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: 'SoftwareSourceClient#get_module_stream') 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::OsManagementHub::Models::ModuleStream'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_module_stream_profile(software_source_id, profile_name, module_name, stream_name, opts = {}) ⇒ Response

Note:

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

Gets information about the specified module stream profile in a software source.

Parameters:

  • software_source_id (String) —

    The software source OCID.

  • profile_name (String) —

    The name of the profile of the containing module stream.

  • module_name (String) —

    The name of a module.

  • stream_name (String) —

    The name of the stream of the containing module.

  • 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) —

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

Returns:



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
513
514
515
516
517
518
519
520
521
522
523
 
# File 'lib/oci/os_management_hub/software_source_client.rb', line 481

def get_module_stream_profile(software_source_id, profile_name, module_name, stream_name, opts = {})
  logger.debug 'Calling operation SoftwareSourceClient#get_module_stream_profile.' if logger

  raise "Missing the required parameter 'software_source_id' when calling get_module_stream_profile." if software_source_id.nil?
  raise "Missing the required parameter 'profile_name' when calling get_module_stream_profile." if profile_name.nil?
  raise "Missing the required parameter 'module_name' when calling get_module_stream_profile." if module_name.nil?
  raise "Missing the required parameter 'stream_name' when calling get_module_stream_profile." if stream_name.nil?
  raise "Parameter value for 'software_source_id' must not be blank" if OCI::Internal::Util.blank_string?(software_source_id)
  raise "Parameter value for 'profile_name' must not be blank" if OCI::Internal::Util.blank_string?(profile_name)

  path = '/softwareSources/{softwareSourceId}/moduleStreamProfiles/{profileName}'.sub('{softwareSourceId}', software_source_id.to_s).sub('{profileName}', profile_name.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:moduleName] = module_name
  query_params[:streamName] = stream_name

  # 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: 'SoftwareSourceClient#get_module_stream_profile') 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::OsManagementHub::Models::ModuleStreamProfile'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_package_group(software_source_id, package_group_id, opts = {}) ⇒ Response

Note:

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

Gets information about the specified package group from a software source.

Parameters:

  • software_source_id (String) —

    The software source OCID.

  • package_group_id (String) —

    The unique package group identifier.

  • 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) —

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

Returns:



543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
 
# File 'lib/oci/os_management_hub/software_source_client.rb', line 543

def get_package_group(software_source_id, package_group_id, opts = {})
  logger.debug 'Calling operation SoftwareSourceClient#get_package_group.' if logger

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

  path = '/softwareSources/{softwareSourceId}/packageGroups/{packageGroupId}'.sub('{softwareSourceId}', software_source_id.to_s).sub('{packageGroupId}', package_group_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: 'SoftwareSourceClient#get_package_group') 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::OsManagementHub::Models::PackageGroup'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_software_package(software_source_id, software_package_name, opts = {}) ⇒ Response

Note:

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

Gets information about the specified software package.

Parameters:

  • software_source_id (String) —

    The software source OCID.

  • software_package_name (String) —

    The name of the software package.

  • 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) —

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

Returns:



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
626
627
628
629
630
631
632
633
634
635
636
637
638
639
 
# File 'lib/oci/os_management_hub/software_source_client.rb', line 601

def get_software_package(software_source_id, software_package_name, opts = {})
  logger.debug 'Calling operation SoftwareSourceClient#get_software_package.' if logger

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

  path = '/softwareSources/{softwareSourceId}/softwarePackages/{softwarePackageName}'.sub('{softwareSourceId}', software_source_id.to_s).sub('{softwarePackageName}', software_package_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]
  # rubocop:enable Style/NegatedIf

  post_body = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'SoftwareSourceClient#get_software_package') 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::OsManagementHub::Models::SoftwarePackage'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_software_source(software_source_id, opts = {}) ⇒ Response

Note:

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

Gets information about the specified software source.

Parameters:

  • software_source_id (String) —

    The software source OCID.

  • 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) —

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

Returns:



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
692
693
 
# File 'lib/oci/os_management_hub/software_source_client.rb', line 657

def get_software_source(software_source_id, opts = {})
  logger.debug 'Calling operation SoftwareSourceClient#get_software_source.' if logger

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

  path = '/softwareSources/{softwareSourceId}'.sub('{softwareSourceId}', software_source_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: 'SoftwareSourceClient#get_software_source') 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::OsManagementHub::Models::SoftwareSource'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Lists entitlements in the specified tenancy OCID. Filter the list against a variety of criteria including but not limited to its CSI, and vendor name.

Allowed values are: csi, vendorName

Parameters:

  • compartment_id (String) —

    The OCID of the compartment that contains the resources to list. This parameter is required.

  • 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

  • :csi (String) —

    A filter to return entitlements that match the given CSI.

  • :vendor_name (String) —

    A filter to return only profiles that match the given vendorName.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50 (default to 10)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

    Example: 3

  • :sort_order (String) —

    The sort order to use, either 'ASC' or 'DESC'.

  • :sort_by (String) —

    The field to sort entitlements by. Only one sort order may be provided. (default to vendorName)

  • :opc_request_id (String) —

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

Returns:



729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
 
# File 'lib/oci/os_management_hub/software_source_client.rb', line 729

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

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

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

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

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

  path = '/entitlements'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:csi] = opts[:csi] if opts[:csi]
  query_params[:vendorName] = opts[:vendor_name] if opts[:vendor_name]
  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: 'SoftwareSourceClient#list_entitlements') 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::OsManagementHub::Models::EntitlementCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Lists all of the currently available errata. Filter the list against a variety of criteria including but not limited to its name, classification type, advisory severity, and OS family.

Allowed values are: timeIssued, name

Parameters:

  • compartment_id (String) —

    The OCID of the compartment that contains the resources to list. This parameter is required.

  • 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

  • :name (Array<String>) —

    The assigned erratum name. It's unique and not changeable.

    Example: ELSA-2020-5804

  • :name_contains (String) —

    A filter to return resources that may partially match the erratum name given.

  • :classification_type (Array<String>) —

    A filter to return only packages that match the given update classification type. Allowed values are: SECURITY, BUGFIX, ENHANCEMENT, OTHER

  • :os_family (String) —

    A filter to return only profiles that match the given osFamily.

  • :advisory_severity (Array<String>) —

    The advisory severity.

    Allowed values are: LOW, MODERATE, IMPORTANT, CRITICAL

  • :time_issue_date_start (DateTime) —

    The issue date after which to list all errata, in ISO 8601 format

    Example: 2017-07-14T02:40:00.000Z

  • :time_issue_date_end (DateTime) —

    The issue date before which to list all errata, in ISO 8601 format

    Example: 2017-07-14T02:40:00.000Z

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50 (default to 10)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

    Example: 3

  • :sort_order (String) —

    The sort order to use, either 'ASC' or 'DESC'.

  • :sort_by (String) —

    The field to sort errata by. Only one sort order may be provided. Default order for timeIssued is descending. Default order for name is ascending. If no value is specified timeIssued is default. (default to timeIssued)

  • :opc_request_id (String) —

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

Returns:



836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
 
# File 'lib/oci/os_management_hub/software_source_client.rb', line 836

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

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


  classification_type_allowable_values = %w[SECURITY BUGFIX ENHANCEMENT OTHER]
  if opts[:classification_type] && !opts[:classification_type].empty?
    opts[:classification_type].each do |val_to_check|
      unless classification_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "classification_type", must be one of SECURITY, BUGFIX, ENHANCEMENT, OTHER.'
      end
    end
  end

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


  advisory_severity_allowable_values = %w[LOW MODERATE IMPORTANT CRITICAL]
  if opts[:advisory_severity] && !opts[:advisory_severity].empty?
    opts[:advisory_severity].each do |val_to_check|
      unless advisory_severity_allowable_values.include?(val_to_check)
        raise 'Invalid value for "advisory_severity", must be one of LOW, MODERATE, IMPORTANT, CRITICAL.'
      end
    end
  end

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

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

  path = '/errata'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:name] = OCI::ApiClient.build_collection_params(opts[:name], :multi) if opts[:name] && !opts[:name].empty?
  query_params[:nameContains] = opts[:name_contains] if opts[:name_contains]
  query_params[:classificationType] = OCI::ApiClient.build_collection_params(opts[:classification_type], :multi) if opts[:classification_type] && !opts[:classification_type].empty?
  query_params[:osFamily] = opts[:os_family] if opts[:os_family]
  query_params[:advisorySeverity] = OCI::ApiClient.build_collection_params(opts[:advisory_severity], :multi) if opts[:advisory_severity] && !opts[:advisory_severity].empty?
  query_params[:timeIssueDateStart] = opts[:time_issue_date_start] if opts[:time_issue_date_start]
  query_params[:timeIssueDateEnd] = opts[:time_issue_date_end] if opts[:time_issue_date_end]
  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: 'SoftwareSourceClient#list_errata') 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::OsManagementHub::Models::ErratumCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_module_stream_profiles(software_source_id, opts = {}) ⇒ Response

Note:

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

Lists module stream profiles from the specified software source OCID. Filter the list against a variety of criteria including but not limited to its module name, stream name, and (profile) name.

Allowed values are: moduleName

Parameters:

  • software_source_id (String) —

    The software source OCID.

  • 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

  • :module_name (String) —

    The name of a module. This parameter is required if a streamName is specified.

  • :stream_name (String) —

    The name of the stream of the containing module. This parameter is required if a profileName is specified.

  • :name (String) —

    The name of the entity to be queried.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50 (default to 10)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

    Example: 3

  • :sort_order (String) —

    The sort order to use, either 'ASC' or 'DESC'.

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for moduleName is ascending. (default to moduleName)

  • :opc_request_id (String) —

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

Returns:



956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
 
# File 'lib/oci/os_management_hub/software_source_client.rb', line 956

def list_module_stream_profiles(software_source_id, opts = {})
  logger.debug 'Calling operation SoftwareSourceClient#list_module_stream_profiles.' if logger

  raise "Missing the required parameter 'software_source_id' when calling list_module_stream_profiles." if software_source_id.nil?

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

  if opts[:sort_by] && !%w[moduleName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of moduleName.'
  end
  raise "Parameter value for 'software_source_id' must not be blank" if OCI::Internal::Util.blank_string?(software_source_id)

  path = '/softwareSources/{softwareSourceId}/moduleStreamProfiles'.sub('{softwareSourceId}', software_source_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:moduleName] = opts[:module_name] if opts[:module_name]
  query_params[:streamName] = opts[:stream_name] if opts[:stream_name]
  query_params[:name] = opts[:name] if opts[:name]
  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: 'SoftwareSourceClient#list_module_stream_profiles') 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::OsManagementHub::Models::ModuleStreamProfileCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_module_streams(software_source_id, opts = {}) ⇒ Response

Note:

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

Lists module streams from the specified software source OCID. Filter the list against a variety of criteria including but not limited to its module name and (stream) name.

Allowed values are: moduleName

Parameters:

  • software_source_id (String) —

    The software source OCID.

  • 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

  • :module_name (String) —

    The name of a module. This parameter is required if a streamName is specified.

  • :name (String) —

    The name of the entity to be queried.

  • :is_latest (BOOLEAN) —

    A boolean variable that is used to list only the latest versions of packages, module streams, and stream profiles when set to true. All packages, module streams, and stream profiles are returned when set to false.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50 (default to 10)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

    Example: 3

  • :sort_order (String) —

    The sort order to use, either 'ASC' or 'DESC'.

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for moduleName is ascending. (default to moduleName)

  • :module_name_contains (String) —

    A filter to return resources that may partially match the module name given.

  • :opc_request_id (String) —

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

Returns:



1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
 
# File 'lib/oci/os_management_hub/software_source_client.rb', line 1050

def list_module_streams(software_source_id, opts = {})
  logger.debug 'Calling operation SoftwareSourceClient#list_module_streams.' if logger

  raise "Missing the required parameter 'software_source_id' when calling list_module_streams." if software_source_id.nil?

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

  if opts[:sort_by] && !%w[moduleName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of moduleName.'
  end
  raise "Parameter value for 'software_source_id' must not be blank" if OCI::Internal::Util.blank_string?(software_source_id)

  path = '/softwareSources/{softwareSourceId}/moduleStreams'.sub('{softwareSourceId}', software_source_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:moduleName] = opts[:module_name] if opts[:module_name]
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:isLatest] = opts[:is_latest] if !opts[:is_latest].nil?
  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]
  query_params[:moduleNameContains] = opts[:module_name_contains] if opts[:module_name_contains]

  # 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: 'SoftwareSourceClient#list_module_streams') 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::OsManagementHub::Models::ModuleStreamCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_package_groups(software_source_id, opts = {}) ⇒ Response

Note:

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

Lists package groups that associate with the specified software source OCID. Filter the list against a variety of criteria including but not limited to its name, and package group type.

Allowed values are: timeCreated, displayName

Parameters:

  • software_source_id (String) —

    The software source OCID.

  • 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

  • :compartment_id (String) —

    The OCID of the compartment that contains the resources to list.

  • :name (String) —

    The name of the entity to be queried.

  • :name_contains (String) —

    A filter to return resources that may partially match the name given.

  • :group_type (Array<OCI::OsManagementHub::Models::OCI::OsManagementHub::Models::PackageGroupGroupType>) —

    A filter to return only package groups of the specified type.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50 (default to 10)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

    Example: 3

  • :sort_order (String) —

    The sort order to use, either 'ASC' or 'DESC'.

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. (default to timeCreated)

  • :opc_request_id (String) —

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

Returns:



1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
 
# File 'lib/oci/os_management_hub/software_source_client.rb', line 1140

def list_package_groups(software_source_id, opts = {})
  logger.debug 'Calling operation SoftwareSourceClient#list_package_groups.' if logger

  raise "Missing the required parameter 'software_source_id' when calling list_package_groups." if software_source_id.nil?

  if opts[:sort_order] && !OCI::OsManagementHub::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::OsManagementHub::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
  raise "Parameter value for 'software_source_id' must not be blank" if OCI::Internal::Util.blank_string?(software_source_id)

  path = '/softwareSources/{softwareSourceId}/packageGroups'.sub('{softwareSourceId}', software_source_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:nameContains] = opts[:name_contains] if opts[:name_contains]
  query_params[:groupType] = OCI::ApiClient.build_collection_params(opts[:group_type], :multi) if opts[:group_type] && !opts[:group_type].empty?
  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: 'SoftwareSourceClient#list_package_groups') 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::OsManagementHub::Models::PackageGroupCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_software_packages(software_source_id, opts = {}) ⇒ Response

Note:

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

Lists software packages in the specified software source. Filter the list against a variety of criteria including but not limited to its name.

Allowed values are: timeCreated, displayName

Parameters:

  • software_source_id (String) —

    The software source OCID.

  • 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

  • :display_name (String) —

    A user-friendly name. Does not have to be unique, and it's changeable.

    Example: My new resource

  • :display_name_contains (String) —

    A filter to return resources that may partially match the given display name.

  • :is_latest (BOOLEAN) —

    A boolean variable that is used to list only the latest versions of packages, module streams, and stream profiles when set to true. All packages, module streams, and stream profiles are returned when set to false.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50 (default to 10)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

    Example: 3

  • :sort_order (String) —

    The sort order to use, either 'ASC' or 'DESC'.

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. (default to timeCreated)

  • :opc_request_id (String) —

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

Returns:



1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
 
# File 'lib/oci/os_management_hub/software_source_client.rb', line 1235

def list_software_packages(software_source_id, opts = {})
  logger.debug 'Calling operation SoftwareSourceClient#list_software_packages.' if logger

  raise "Missing the required parameter 'software_source_id' when calling list_software_packages." if software_source_id.nil?

  if opts[:sort_order] && !OCI::OsManagementHub::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::OsManagementHub::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
  raise "Parameter value for 'software_source_id' must not be blank" if OCI::Internal::Util.blank_string?(software_source_id)

  path = '/softwareSources/{softwareSourceId}/softwarePackages'.sub('{softwareSourceId}', software_source_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:displayNameContains] = opts[:display_name_contains] if opts[:display_name_contains]
  query_params[:isLatest] = opts[:is_latest] if !opts[:is_latest].nil?
  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: 'SoftwareSourceClient#list_software_packages') 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::OsManagementHub::Models::SoftwarePackageCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Lists available software source vendors. Filter the list against a variety of criteria including but not limited to its name.

Allowed values are: name

Parameters:

  • compartment_id (String) —

    The OCID of the compartment that contains the resources to list. This parameter is required.

  • 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) —

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

  • :sort_order (String) —

    The sort order to use, either 'ASC' or 'DESC'.

  • :sort_by (String) —

    The field to sort software source vendors by. Only one sort order may be provided. Default order for name is ascending. (default to name)

  • :name (String) —

    The name of the entity to be queried.

Returns:



1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
 
# File 'lib/oci/os_management_hub/software_source_client.rb', line 1311

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

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

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

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

  path = '/softwareSourceVendors'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:name] = opts[:name] if opts[:name]

  # 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: 'SoftwareSourceClient#list_software_source_vendors') 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::OsManagementHub::Models::SoftwareSourceVendorCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_software_sources(opts = {}) ⇒ Response

Note:

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

Lists software sources that match the specified tenancy or software source OCID. Filter the list against a variety of criteria including but not limited to its name, status, architecture, and OS family.

Allowed values are: timeCreated, displayName

Parameters:

  • 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

  • :compartment_id (String) —

    The OCID of the compartment that contains the resources to list.

  • :software_source_id (String) —

    The OCID for the software source.

  • :software_source_type (Array<String>) —

    The type of the software source. Allowed values are: VENDOR, CUSTOM, VERSIONED

  • :vendor_name (String) —

    A filter to return only profiles that match the given vendorName.

  • :os_family (Array<String>) —

    A filter to return only instances whose OS family type matches the given OS family. Allowed values are: ORACLE_LINUX_9, ORACLE_LINUX_8, ORACLE_LINUX_7

  • :arch_type (Array<String>) —

    A filter to return only instances whose architecture type matches the given architecture. Allowed values are: X86_64, AARCH64, I686, NOARCH, SRC

  • :availability (Array<String>) —

    The availabilities of the software source for a tenant. Allowed values are: AVAILABLE, SELECTED, RESTRICTED

  • :display_name (String) —

    A user-friendly name. Does not have to be unique, and it's changeable.

    Example: My new resource

  • :display_name_contains (String) —

    A filter to return resources that may partially match the given display name.

  • :display_name_not_equal_to (Array<String>) —

    A multi filter to return resources that do not contains the given display names.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50 (default to 10)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

    Example: 3

  • :sort_order (String) —

    The sort order to use, either 'ASC' or 'DESC'.

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. (default to timeCreated)

  • :lifecycle_state (Array<OCI::OsManagementHub::Models::OCI::OsManagementHub::Models::SoftwareSourceLifecycleState>) —

    A filter to return only resources whose lifecycleState matches the given lifecycleStates.

  • :opc_request_id (String) —

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

Returns:



1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
 
# File 'lib/oci/os_management_hub/software_source_client.rb', line 1409

def list_software_sources(opts = {})
  logger.debug 'Calling operation SoftwareSourceClient#list_software_sources.' if logger



  software_source_type_allowable_values = %w[VENDOR CUSTOM VERSIONED]
  if opts[:software_source_type] && !opts[:software_source_type].empty?
    opts[:software_source_type].each do |val_to_check|
      unless software_source_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "software_source_type", must be one of VENDOR, CUSTOM, VERSIONED.'
      end
    end
  end

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


  os_family_allowable_values = %w[ORACLE_LINUX_9 ORACLE_LINUX_8 ORACLE_LINUX_7]
  if opts[:os_family] && !opts[:os_family].empty?
    opts[:os_family].each do |val_to_check|
      unless os_family_allowable_values.include?(val_to_check)
        raise 'Invalid value for "os_family", must be one of ORACLE_LINUX_9, ORACLE_LINUX_8, ORACLE_LINUX_7.'
      end
    end
  end


  arch_type_allowable_values = %w[X86_64 AARCH64 I686 NOARCH SRC]
  if opts[:arch_type] && !opts[:arch_type].empty?
    opts[:arch_type].each do |val_to_check|
      unless arch_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "arch_type", must be one of X86_64, AARCH64, I686, NOARCH, SRC.'
      end
    end
  end


  availability_allowable_values = %w[AVAILABLE SELECTED RESTRICTED]
  if opts[:availability] && !opts[:availability].empty?
    opts[:availability].each do |val_to_check|
      unless availability_allowable_values.include?(val_to_check)
        raise 'Invalid value for "availability", must be one of AVAILABLE, SELECTED, RESTRICTED.'
      end
    end
  end

  if opts[:sort_order] && !OCI::OsManagementHub::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::OsManagementHub::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 = '/softwareSources'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:softwareSourceId] = opts[:software_source_id] if opts[:software_source_id]
  query_params[:softwareSourceType] = OCI::ApiClient.build_collection_params(opts[:software_source_type], :multi) if opts[:software_source_type] && !opts[:software_source_type].empty?
  query_params[:vendorName] = opts[:vendor_name] if opts[:vendor_name]
  query_params[:osFamily] = OCI::ApiClient.build_collection_params(opts[:os_family], :multi) if opts[:os_family] && !opts[:os_family].empty?
  query_params[:archType] = OCI::ApiClient.build_collection_params(opts[:arch_type], :multi) if opts[:arch_type] && !opts[:arch_type].empty?
  query_params[:availability] = OCI::ApiClient.build_collection_params(opts[:availability], :multi) if opts[:availability] && !opts[:availability].empty?
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:displayNameContains] = opts[:display_name_contains] if opts[:display_name_contains]
  query_params[:displayNameNotEqualTo] = OCI::ApiClient.build_collection_params(opts[:display_name_not_equal_to], :multi) if opts[:display_name_not_equal_to] && !opts[:display_name_not_equal_to].empty?
  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]
  query_params[:lifecycleState] = OCI::ApiClient.build_collection_params(opts[:lifecycle_state], :multi) if opts[:lifecycle_state] && !opts[:lifecycle_state].empty?

  # 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: 'SoftwareSourceClient#list_software_sources') 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::OsManagementHub::Models::SoftwareSourceCollection'
    )
  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/os_management_hub/software_source_client.rb', line 94

def logger
  @api_client.config.logger
end

#search_software_source_module_streams(search_software_source_module_streams_details, opts = {}) ⇒ Response

Note:

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

Lists modules from a list of software sources. Filter the list against a variety of criteria including the module name.

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) —

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

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50 (default to 10)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

    Example: 3

Returns:



1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
 
# File 'lib/oci/os_management_hub/software_source_client.rb', line 1540

def search_software_source_module_streams(search_software_source_module_streams_details, opts = {})
  logger.debug 'Calling operation SoftwareSourceClient#search_software_source_module_streams.' if logger

  raise "Missing the required parameter 'search_software_source_module_streams_details' when calling search_software_source_module_streams." if search_software_source_module_streams_details.nil?

  path = '/softwareSourceModuleStreams/actions/search'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # 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 = @api_client.object_to_http_body(search_software_source_module_streams_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'SoftwareSourceClient#search_software_source_module_streams') 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::OsManagementHub::Models::ModuleStreamCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#search_software_source_modules(search_software_source_modules_details, opts = {}) ⇒ Response

Note:

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

Lists modules from a list of software sources. Filter the list against a variety of criteria including the (module) name.

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) —

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

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50 (default to 10)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

    Example: 3

Returns:



1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
 
# File 'lib/oci/os_management_hub/software_source_client.rb', line 1607

def search_software_source_modules(search_software_source_modules_details, opts = {})
  logger.debug 'Calling operation SoftwareSourceClient#search_software_source_modules.' if logger

  raise "Missing the required parameter 'search_software_source_modules_details' when calling search_software_source_modules." if search_software_source_modules_details.nil?

  path = '/softwareSourceModules/actions/search'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # 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 = @api_client.object_to_http_body(search_software_source_modules_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'SoftwareSourceClient#search_software_source_modules') 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::OsManagementHub::Models::ModuleCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#search_software_source_package_groups(search_software_source_package_groups_details, opts = {}) ⇒ Response

Note:

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

Searches the package groups from the specified list of software sources. Filter the list against a variety of criteria including but not limited to its name, and group type.

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) —

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

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination.

    Example: 50 (default to 10)

  • :page (String) —

    For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

    Example: 3

Returns:



1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
 
# File 'lib/oci/os_management_hub/software_source_client.rb', line 1674

def search_software_source_package_groups(search_software_source_package_groups_details, opts = {})
  logger.debug 'Calling operation SoftwareSourceClient#search_software_source_package_groups.' if logger

  raise "Missing the required parameter 'search_software_source_package_groups_details' when calling search_software_source_package_groups." if search_software_source_package_groups_details.nil?

  path = '/softwareSourcePackageGroups/actions/search'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]

  # 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 = @api_client.object_to_http_body(search_software_source_package_groups_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'SoftwareSourceClient#search_software_source_package_groups') 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::OsManagementHub::Models::PackageGroupCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_software_source(software_source_id, update_software_source_details, opts = {}) ⇒ Response

Note:

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

Updates the specified software source's details, including but not limited to name, description, and tags.

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) —

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

  • :if_match (String) —

    For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.

Returns:



1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
 
# File 'lib/oci/os_management_hub/software_source_client.rb', line 1737

def update_software_source(software_source_id, update_software_source_details, opts = {})
  logger.debug 'Calling operation SoftwareSourceClient#update_software_source.' if logger

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

  path = '/softwareSources/{softwareSourceId}'.sub('{softwareSourceId}', software_source_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]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = @api_client.object_to_http_body(update_software_source_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'SoftwareSourceClient#update_software_source') 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::OsManagementHub::Models::SoftwareSource'
    )
  end
  # rubocop:enable Metrics/BlockLength
end