Class: OCI::CloudBridge::DiscoveryClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/cloud_bridge/discovery_client.rb

Overview

API for Oracle Cloud Bridge service.

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

Creates a new DiscoveryClient. 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/cloud_bridge/discovery_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 + '/20220509'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "DiscoveryClient 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/cloud_bridge/discovery_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/cloud_bridge/discovery_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/cloud_bridge/discovery_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/cloud_bridge/discovery_client.rb', line 25

def retry_config
  @retry_config
end

Instance Method Details

#change_asset_source_compartment(asset_source_id, change_asset_source_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.

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

    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.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :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 the same action again. Retry tokens expire after 24 hours, but can be invalidated before 24 hours due to conflicting operations. For example, if a resource has been deleted and purged from the system, a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



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
156
157
158
159
160
161
162
163
 
# File 'lib/oci/cloud_bridge/discovery_client.rb', line 124

def change_asset_source_compartment(asset_source_id, change_asset_source_compartment_details, opts = {})
  logger.debug 'Calling operation DiscoveryClient#change_asset_source_compartment.' if logger

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

  path = '/assetSources/{assetSourceId}/actions/changeCompartment'.sub('{assetSourceId}', asset_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[:'if-match'] = opts[:if_match] if opts[:if_match]
  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_asset_source_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DiscoveryClient#change_asset_source_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

#change_discovery_schedule_compartment(discovery_schedule_id, change_discovery_schedule_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves the specified discovery schedule into a different compartment. When provided, If-Match is checked against ETag values of the resource.

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

    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.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :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 the same action again. Retry tokens expire after 24 hours, but can be invalidated before 24 hours due to conflicting operations. For example, if a resource has been deleted and purged from the system, a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/oci/cloud_bridge/discovery_client.rb', line 194

def change_discovery_schedule_compartment(discovery_schedule_id, change_discovery_schedule_compartment_details, opts = {})
  logger.debug 'Calling operation DiscoveryClient#change_discovery_schedule_compartment.' if logger

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

  path = '/discoverySchedules/{discoveryScheduleId}/actions/changeCompartment'.sub('{discoveryScheduleId}', discovery_schedule_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]
  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_discovery_schedule_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DiscoveryClient#change_discovery_schedule_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_asset_source(create_asset_source_details, opts = {}) ⇒ Response

Note:

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

Creates an asset 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_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 the same action again. Retry tokens expire after 24 hours, but can be invalidated before 24 hours due to conflicting operations. For example, if a resource has been deleted and purged from the system, a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



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
293
294
295
 
# File 'lib/oci/cloud_bridge/discovery_client.rb', line 258

def create_asset_source(create_asset_source_details, opts = {})
  logger.debug 'Calling operation DiscoveryClient#create_asset_source.' if logger

  raise "Missing the required parameter 'create_asset_source_details' when calling create_asset_source." if create_asset_source_details.nil?

  path = '/assetSources'
  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_asset_source_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DiscoveryClient#create_asset_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::CloudBridge::Models::AssetSource'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_discovery_schedule(create_discovery_schedule_details, opts = {}) ⇒ Response

Note:

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

Creates the discovery schedule.

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 the same action again. Retry tokens expire after 24 hours, but can be invalidated before 24 hours due to conflicting operations. For example, if a resource has been deleted and purged from the system, a retry of the original creation request might be rejected.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



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
353
354
355
356
 
# File 'lib/oci/cloud_bridge/discovery_client.rb', line 319

def create_discovery_schedule(create_discovery_schedule_details, opts = {})
  logger.debug 'Calling operation DiscoveryClient#create_discovery_schedule.' if logger

  raise "Missing the required parameter 'create_discovery_schedule_details' when calling create_discovery_schedule." if create_discovery_schedule_details.nil?

  path = '/discoverySchedules'
  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_discovery_schedule_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DiscoveryClient#create_discovery_schedule') 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::CloudBridge::Models::DiscoverySchedule'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_asset_source(asset_source_id, opts = {}) ⇒ Response

Note:

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

Deletes the asset source by ID.

Parameters:

  • asset_source_id (String) —

    The OCID of the asset source.

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

    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.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



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
416
 
# File 'lib/oci/cloud_bridge/discovery_client.rb', line 380

def delete_asset_source(asset_source_id, opts = {})
  logger.debug 'Calling operation DiscoveryClient#delete_asset_source.' if logger

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

  path = '/assetSources/{assetSourceId}'.sub('{assetSourceId}', asset_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[:'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: 'DiscoveryClient#delete_asset_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

#delete_discovery_schedule(discovery_schedule_id, opts = {}) ⇒ Response

Note:

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

Deletes the specified discovery schedule.

Parameters:

  • discovery_schedule_id (String) —

    The OCID of the discovery schedule.

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

    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.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



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
475
476
 
# File 'lib/oci/cloud_bridge/discovery_client.rb', line 440

def delete_discovery_schedule(discovery_schedule_id, opts = {})
  logger.debug 'Calling operation DiscoveryClient#delete_discovery_schedule.' if logger

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

  path = '/discoverySchedules/{discoveryScheduleId}'.sub('{discoveryScheduleId}', discovery_schedule_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: 'DiscoveryClient#delete_discovery_schedule') 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_asset_source(asset_source_id, opts = {}) ⇒ Response

Note:

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

Gets the asset source by ID.

Parameters:

  • asset_source_id (String) —

    The OCID of the asset source.

  • 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 client request ID for tracing.

Returns:



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
524
525
526
527
528
529
530
 
# File 'lib/oci/cloud_bridge/discovery_client.rb', line 494

def get_asset_source(asset_source_id, opts = {})
  logger.debug 'Calling operation DiscoveryClient#get_asset_source.' if logger

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

  path = '/assetSources/{assetSourceId}'.sub('{assetSourceId}', asset_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: 'DiscoveryClient#get_asset_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::CloudBridge::Models::AssetSource'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_discovery_schedule(discovery_schedule_id, opts = {}) ⇒ Response

Note:

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

Reads information about the specified discovery schedule.

Parameters:

  • discovery_schedule_id (String) —

    The OCID of the discovery schedule.

  • 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 client request ID for tracing.

Returns:



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
582
583
584
 
# File 'lib/oci/cloud_bridge/discovery_client.rb', line 548

def get_discovery_schedule(discovery_schedule_id, opts = {})
  logger.debug 'Calling operation DiscoveryClient#get_discovery_schedule.' if logger

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

  path = '/discoverySchedules/{discoveryScheduleId}'.sub('{discoveryScheduleId}', discovery_schedule_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: 'DiscoveryClient#get_discovery_schedule') 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::CloudBridge::Models::DiscoverySchedule'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_asset_source_connections(asset_source_id, opts = {}) ⇒ Response

Note:

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

Gets known connections to the asset source by the asset source ID.

Parameters:

  • asset_source_id (String) —

    The OCID of the asset source.

  • 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

  • :limit (Integer) —

    The maximum number of items to return. (default to 10)

  • :page (String) —

    A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



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
640
641
642
 
# File 'lib/oci/cloud_bridge/discovery_client.rb', line 604

def list_asset_source_connections(asset_source_id, opts = {})
  logger.debug 'Calling operation DiscoveryClient#list_asset_source_connections.' if logger

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

  path = '/assetSources/{assetSourceId}/actions/listConnections'.sub('{assetSourceId}', asset_source_id.to_s)
  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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DiscoveryClient#list_asset_source_connections') 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::CloudBridge::Models::AssetSourceConnectionCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Returns a list of asset sources.

Allowed values are: timeCreated, displayName

Parameters:

  • compartment_id (String) —

    The ID of the compartment in which to list resources.

  • 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

  • :asset_source_id (String) —

    The OCID of the asset source.

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. By default, the timeCreated is in descending order and displayName is in ascending order. (default to timeCreated)

  • :lifecycle_state (String) —

    The current state of the asset source.

  • :sort_order (String) —

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

  • :display_name (String) —

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

  • :limit (Integer) —

    The maximum number of items to return. (default to 10)

  • :page (String) —

    A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
 
# File 'lib/oci/cloud_bridge/discovery_client.rb', line 670

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

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

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

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

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

  path = '/assetSources'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:assetSourceId] = opts[:asset_source_id] if opts[:asset_source_id]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DiscoveryClient#list_asset_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::CloudBridge::Models::AssetSourceCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Lists discovery schedules. Allowed values are: timeCreated, displayName

Parameters:

  • compartment_id (String) —

    The ID of the compartment in which to list resources.

  • 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

  • :discovery_schedule_id (String) —

    The OCID of the discovery schedule.

  • :lifecycle_state (String) —

    The current state of the discovery schedule.

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. By default, the timeCreated is in descending order and displayName is in ascending order. (default to timeCreated)

  • :sort_order (String) —

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

  • :display_name (String) —

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

  • :limit (Integer) —

    The maximum number of items to return. (default to 10)

  • :page (String) —

    A token representing the position at which to start retrieving results. This must come from the opc-next-page header field of a previous response.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



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
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
 
# File 'lib/oci/cloud_bridge/discovery_client.rb', line 752

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

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

  if opts[:lifecycle_state] && !OCI::CloudBridge::Models::DISCOVERY_SCHEDULE_LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::CloudBridge::Models::DISCOVERY_SCHEDULE_LIFECYCLE_STATE_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

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

  path = '/discoverySchedules'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:discoveryScheduleId] = opts[:discovery_schedule_id] if opts[:discovery_schedule_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DiscoveryClient#list_discovery_schedules') 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::CloudBridge::Models::DiscoveryScheduleCollection'
    )
  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/cloud_bridge/discovery_client.rb', line 94

def logger
  @api_client.config.logger
end

#refresh_asset_source(asset_source_id, opts = {}) ⇒ Response

Note:

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

Initiates the process of asset metadata synchronization with the related asset source.

Parameters:

  • asset_source_id (String) —

    The OCID of the asset source.

  • 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 client request ID for tracing.

  • :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 the same action again. Retry tokens expire after 24 hours, but can be invalidated before 24 hours due to conflicting operations. For example, if a resource has been deleted and purged from the system, a retry of the original creation request might be rejected.

Returns:

  • (Response) —

    A Response object with data of type nil



831
832
833
834
835
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
 
# File 'lib/oci/cloud_bridge/discovery_client.rb', line 831

def refresh_asset_source(asset_source_id, opts = {})
  logger.debug 'Calling operation DiscoveryClient#refresh_asset_source.' if logger

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

  path = '/assetSources/{assetSourceId}/actions/refresh'.sub('{assetSourceId}', asset_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[:'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 = nil

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

#update_asset_source(asset_source_id, update_asset_source_details, opts = {}) ⇒ Response

Note:

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

Updates the asset 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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
 
# File 'lib/oci/cloud_bridge/discovery_client.rb', line 893

def update_asset_source(asset_source_id, update_asset_source_details, opts = {})
  logger.debug 'Calling operation DiscoveryClient#update_asset_source.' if logger

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

  path = '/assetSources/{assetSourceId}'.sub('{assetSourceId}', asset_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[:'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_asset_source_details)

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

#update_discovery_schedule(update_discovery_schedule_details, discovery_schedule_id, opts = {}) ⇒ Response

Note:

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

Updates the specified discovery schedule.

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

    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.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



955
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
 
# File 'lib/oci/cloud_bridge/discovery_client.rb', line 955

def update_discovery_schedule(update_discovery_schedule_details, discovery_schedule_id, opts = {})
  logger.debug 'Calling operation DiscoveryClient#update_discovery_schedule.' if logger

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

  path = '/discoverySchedules/{discoveryScheduleId}'.sub('{discoveryScheduleId}', discovery_schedule_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_discovery_schedule_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'DiscoveryClient#update_discovery_schedule') 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::CloudBridge::Models::DiscoverySchedule'
    )
  end
  # rubocop:enable Metrics/BlockLength
end