Class: OCI::FleetAppsManagement::FleetAppsManagementCatalogClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/fleet_apps_management/fleet_apps_management_catalog_client.rb

Overview

Fleet Application Management provides a centralized platform to help you automate resource management tasks, validate patch compliance, and enhance operational efficiency across an enterprise.

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

Creates a new FleetAppsManagementCatalogClient. 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/fleet_apps_management/fleet_apps_management_catalog_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 + '/20250228'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "FleetAppsManagementCatalogClient 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/fleet_apps_management/fleet_apps_management_catalog_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/fleet_apps_management/fleet_apps_management_catalog_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/fleet_apps_management/fleet_apps_management_catalog_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/fleet_apps_management/fleet_apps_management_catalog_client.rb', line 25

def retry_config
  @retry_config
end

Instance Method Details

#change_catalog_item_compartment(catalog_item_id, change_catalog_item_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves a CatalogItem into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

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



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
164
165
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_catalog_client.rb', line 126

def change_catalog_item_compartment(catalog_item_id, change_catalog_item_compartment_details, opts = {})
  logger.debug 'Calling operation FleetAppsManagementCatalogClient#change_catalog_item_compartment.' if logger

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

  path = '/catalogItems/{catalogItemId}/actions/changeCompartment'.sub('{catalogItemId}', catalog_item_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_catalog_item_compartment_details)

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

#clone_catalog_item(catalog_item_id, clone_catalog_item_details, opts = {}) ⇒ Response

Note:

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

Clones a CatalogItem into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

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



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
234
235
236
237
238
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_catalog_client.rb', line 198

def clone_catalog_item(catalog_item_id, clone_catalog_item_details, opts = {})
  logger.debug 'Calling operation FleetAppsManagementCatalogClient#clone_catalog_item.' if logger

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

  path = '/catalogItems/{catalogItemId}/actions/cloneCatalogItem'.sub('{catalogItemId}', catalog_item_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(clone_catalog_item_details)

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

#configure_catalog_item(catalog_item_id, configure_catalog_item_details, opts = {}) ⇒ Response

Note:

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

Configures a CatalogItem. Creating new Catalog Item.

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



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_catalog_client.rb', line 270

def configure_catalog_item(catalog_item_id, configure_catalog_item_details, opts = {})
  logger.debug 'Calling operation FleetAppsManagementCatalogClient#configure_catalog_item.' if logger

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

  path = '/catalogItems/{catalogItemId}/actions/configure'.sub('{catalogItemId}', catalog_item_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(configure_catalog_item_details)

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

#create_catalog_item(create_catalog_item_details, opts = {}) ⇒ Response

Note:

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

Creates a CatalogItem.

Parameters:

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_catalog_client.rb', line 335

def create_catalog_item(create_catalog_item_details, opts = {})
  logger.debug 'Calling operation FleetAppsManagementCatalogClient#create_catalog_item.' if logger

  raise "Missing the required parameter 'create_catalog_item_details' when calling create_catalog_item." if create_catalog_item_details.nil?

  path = '/catalogItems'
  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_catalog_item_details)

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

#delete_catalog_item(catalog_item_id, opts = {}) ⇒ Response

Note:

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

Deletes a CatalogItem.

Parameters:

  • catalog_item_id (String) —

    The OCID of the CatalogItem.

  • 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



396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_catalog_client.rb', line 396

def delete_catalog_item(catalog_item_id, opts = {})
  logger.debug 'Calling operation FleetAppsManagementCatalogClient#delete_catalog_item.' if logger

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

  path = '/catalogItems/{catalogItemId}'.sub('{catalogItemId}', catalog_item_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: 'FleetAppsManagementCatalogClient#delete_catalog_item') 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_catalog_item(catalog_item_id, opts = {}) ⇒ Response

Note:

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

Gets information about a CatalogItem.

Parameters:

  • catalog_item_id (String) —

    The OCID of the CatalogItem.

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



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
477
478
479
480
481
482
483
484
485
486
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_catalog_client.rb', line 450

def get_catalog_item(catalog_item_id, opts = {})
  logger.debug 'Calling operation FleetAppsManagementCatalogClient#get_catalog_item.' if logger

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

  path = '/catalogItems/{catalogItemId}'.sub('{catalogItemId}', catalog_item_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: 'FleetAppsManagementCatalogClient#get_catalog_item') 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::FleetAppsManagement::Models::CatalogItem'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_catalog_item_variables_definition(catalog_item_id, opts = {}) ⇒ Response

Note:

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

Gets information about a CatalogItem Variables.

Parameters:

  • catalog_item_id (String) —

    The OCID of the CatalogItem.

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



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
531
532
533
534
535
536
537
538
539
540
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_catalog_client.rb', line 504

def get_catalog_item_variables_definition(catalog_item_id, opts = {})
  logger.debug 'Calling operation FleetAppsManagementCatalogClient#get_catalog_item_variables_definition.' if logger

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

  path = '/catalogItems/{catalogItemId}/variablesDefinitions'.sub('{catalogItemId}', catalog_item_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: 'FleetAppsManagementCatalogClient#get_catalog_item_variables_definition') 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::FleetAppsManagement::Models::CatalogItemVariablesDefinition'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Gets a list of Catalog Items in a compartment.

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

  • :config_source_type (String) —

    The ConfigSourceType Eg: STACK_TEMPLATE_CATALOG_SOURCE, PAR_CATALOG_SOURCE, URL_CATALOG_SOURCE, MARKETPLACE_CATALOG_SOURCE.

  • :lifecycle_state (String) —

    A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.

  • :sort_order (String) —

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

  • :sort_by (String) —

    The field to sort by. You can provide only one sort by. Default value for timeCreated is descending. Default order for displayName is ascending

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

  • :catalog_listing_id (String) —

    catalogListingId of the package. This is an integer whose min and max length are specified.

  • :catalog_listing_version_criteria (String) —

    Parameter to list all catalog items only with latest version or list all catalog items with all versions.

  • :package_type (String) —

    A filter to return only resources that match the given package type. The state value is case-insensitive.

  • :should_list_public_items (BOOLEAN) —

    The indicator to append Public Items from the root compartment to any query, when set to TRUE. (default to false)

Returns:



577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_catalog_client.rb', line 577

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

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

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

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

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

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

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

  path = '/catalogItems'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:configSourceType] = opts[:config_source_type] if opts[:config_source_type]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  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]
  query_params[:catalogListingId] = opts[:catalog_listing_id] if opts[:catalog_listing_id]
  query_params[:catalogListingVersionCriteria] = opts[:catalog_listing_version_criteria] if opts[:catalog_listing_version_criteria]
  query_params[:packageType] = opts[:package_type] if opts[:package_type]
  query_params[:shouldListPublicItems] = opts[:should_list_public_items] if !opts[:should_list_public_items].nil?

  # 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: 'FleetAppsManagementCatalogClient#list_catalog_items') 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::FleetAppsManagement::Models::CatalogItemCollection'
    )
  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/fleet_apps_management/fleet_apps_management_catalog_client.rb', line 94

def logger
  @api_client.config.logger
end

#update_catalog_item(catalog_item_id, update_catalog_item_details, opts = {}) ⇒ Response

Note:

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

Updates a CatalogItem.

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



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
694
695
696
697
698
699
700
701
702
703
704
705
706
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_catalog_client.rb', line 669

def update_catalog_item(catalog_item_id, update_catalog_item_details, opts = {})
  logger.debug 'Calling operation FleetAppsManagementCatalogClient#update_catalog_item.' if logger

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

  path = '/catalogItems/{catalogItemId}'.sub('{catalogItemId}', catalog_item_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_catalog_item_details)

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