Class: OCI::ServiceCatalog::ServiceCatalogClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/service_catalog/service_catalog_client.rb

Overview

Use the Service Catalog API to manage solutions in Oracle Cloud Infrastructure Service Catalog. For more information, see Overview of Service Catalog.

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

Creates a new ServiceCatalogClient. 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



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

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 + '/20210527'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "ServiceCatalogClient endpoint set to '#{@endpoint}'." if logger
end

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



16
17
18
 
# File 'lib/oci/service_catalog/service_catalog_client.rb', line 16

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/service_catalog/service_catalog_client.rb', line 20

def endpoint
  @endpoint
end

#region ⇒ String

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

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/service_catalog/service_catalog_client.rb', line 30

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:



26
27
28
 
# File 'lib/oci/service_catalog/service_catalog_client.rb', line 26

def retry_config
  @retry_config
end

Instance Method Details

#bulk_replace_service_catalog_associations(service_catalog_id, bulk_replace_service_catalog_associations_details, opts = {}) ⇒ Response

Note:

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

Replace all associations of a given service catalog in one bulk transaction.

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

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

Returns:

  • (Response) —

    A Response object with data of type nil



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/oci/service_catalog/service_catalog_client.rb', line 119

def bulk_replace_service_catalog_associations(service_catalog_id, bulk_replace_service_catalog_associations_details, opts = {})
  logger.debug 'Calling operation ServiceCatalogClient#bulk_replace_service_catalog_associations.' if logger

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

  path = '/serviceCatalogs/{serviceCatalogId}/actions/bulkReplaceAssociations'.sub('{serviceCatalogId}', service_catalog_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(bulk_replace_service_catalog_associations_details)

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

#change_private_application_compartment(private_application_id, change_private_application_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves the specified private application from one compartment to another.

Parameters:

  • private_application_id (String) —

    The unique identifier for the private application.

  • change_private_application_compartment_details (OCI::ServiceCatalog::Models::ChangePrivateApplicationCompartmentDetails) —

    The details of the request to change the compartment of a given private application.

  • 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



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
216
217
218
 
# File 'lib/oci/service_catalog/service_catalog_client.rb', line 181

def change_private_application_compartment(private_application_id, change_private_application_compartment_details, opts = {})
  logger.debug 'Calling operation ServiceCatalogClient#change_private_application_compartment.' if logger

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

  path = '/privateApplications/{privateApplicationId}/actions/changeCompartment'.sub('{privateApplicationId}', private_application_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(change_private_application_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ServiceCatalogClient#change_private_application_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_service_catalog_compartment(service_catalog_id, change_service_catalog_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves the specified service catalog from one compartment to another.

Parameters:

  • service_catalog_id (String) —

    The unique identifier for the service catalog.

  • change_service_catalog_compartment_details (OCI::ServiceCatalog::Models::ChangeServiceCatalogCompartmentDetails) —

    The details of the request to change the compartment of a given service catalog.

  • 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



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
278
279
280
 
# File 'lib/oci/service_catalog/service_catalog_client.rb', line 243

def change_service_catalog_compartment(service_catalog_id, change_service_catalog_compartment_details, opts = {})
  logger.debug 'Calling operation ServiceCatalogClient#change_service_catalog_compartment.' if logger

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

  path = '/serviceCatalogs/{serviceCatalogId}/actions/changeCompartment'.sub('{serviceCatalogId}', service_catalog_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(change_service_catalog_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ServiceCatalogClient#change_service_catalog_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_private_application(create_private_application_details, opts = {}) ⇒ Response

Note:

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

Creates a private application along with a single package to be hosted.

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

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

Returns:



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
338
339
340
341
342
 
# File 'lib/oci/service_catalog/service_catalog_client.rb', line 305

def create_private_application(create_private_application_details, opts = {})
  logger.debug 'Calling operation ServiceCatalogClient#create_private_application.' if logger

  raise "Missing the required parameter 'create_private_application_details' when calling create_private_application." if create_private_application_details.nil?

  path = '/privateApplications'
  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_private_application_details)

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

#create_service_catalog(create_service_catalog_details, opts = {}) ⇒ Response

Note:

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

Creates a brand new service catalog in a given 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

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

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

Returns:



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
396
397
398
399
400
401
402
403
404
 
# File 'lib/oci/service_catalog/service_catalog_client.rb', line 367

def create_service_catalog(create_service_catalog_details, opts = {})
  logger.debug 'Calling operation ServiceCatalogClient#create_service_catalog.' if logger

  raise "Missing the required parameter 'create_service_catalog_details' when calling create_service_catalog." if create_service_catalog_details.nil?

  path = '/serviceCatalogs'
  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_service_catalog_details)

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

#create_service_catalog_association(create_service_catalog_association_details, opts = {}) ⇒ Response

Note:

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

Creates an association between service catalog and a 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

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

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

Returns:



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
458
459
460
461
462
463
464
465
466
 
# File 'lib/oci/service_catalog/service_catalog_client.rb', line 429

def create_service_catalog_association(create_service_catalog_association_details, opts = {})
  logger.debug 'Calling operation ServiceCatalogClient#create_service_catalog_association.' if logger

  raise "Missing the required parameter 'create_service_catalog_association_details' when calling create_service_catalog_association." if create_service_catalog_association_details.nil?

  path = '/serviceCatalogAssociations'
  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_service_catalog_association_details)

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

#delete_private_application(private_application_id, opts = {}) ⇒ Response

Note:

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

Deletes an existing private application.

Parameters:

  • private_application_id (String) —

    The unique identifier for the private application.

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

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

Returns:

  • (Response) —

    A Response object with data of type nil



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
524
525
526
 
# File 'lib/oci/service_catalog/service_catalog_client.rb', line 490

def delete_private_application(private_application_id, opts = {})
  logger.debug 'Calling operation ServiceCatalogClient#delete_private_application.' if logger

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

  path = '/privateApplications/{privateApplicationId}'.sub('{privateApplicationId}', private_application_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: 'ServiceCatalogClient#delete_private_application') 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_service_catalog(service_catalog_id, opts = {}) ⇒ Response

Note:

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

Deletes the specified service catalog from the compartment.

Parameters:

  • service_catalog_id (String) —

    The unique identifier for the service catalog.

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

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

Returns:

  • (Response) —

    A Response object with data of type nil



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
585
586
 
# File 'lib/oci/service_catalog/service_catalog_client.rb', line 550

def delete_service_catalog(service_catalog_id, opts = {})
  logger.debug 'Calling operation ServiceCatalogClient#delete_service_catalog.' if logger

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

  path = '/serviceCatalogs/{serviceCatalogId}'.sub('{serviceCatalogId}', service_catalog_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: 'ServiceCatalogClient#delete_service_catalog') 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_service_catalog_association(service_catalog_association_id, opts = {}) ⇒ Response

Note:

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

Removes an association between service catalog and a resource.

Parameters:

  • service_catalog_association_id (String) —

    The unique identifier of the service catalog association.

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

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

Returns:

  • (Response) —

    A Response object with data of type nil



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
645
646
 
# File 'lib/oci/service_catalog/service_catalog_client.rb', line 610

def delete_service_catalog_association(service_catalog_association_id, opts = {})
  logger.debug 'Calling operation ServiceCatalogClient#delete_service_catalog_association.' if logger

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

  path = '/serviceCatalogAssociations/{serviceCatalogAssociationId}'.sub('{serviceCatalogAssociationId}', service_catalog_association_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: 'ServiceCatalogClient#delete_service_catalog_association') 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_configuration(compartment_id, opts = {}) ⇒ Response

Note:

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

Get the detail of whether the tenancy is in service catalog mode or not.

Parameters:

  • compartment_id (String) —

    The unique identifier for the compartment.

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

    the optional parameters

Options Hash (opts):

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

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

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



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
694
695
696
697
698
699
700
701
702
 
# File 'lib/oci/service_catalog/service_catalog_client.rb', line 666

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

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

  path = '/configuration'
  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: 'ServiceCatalogClient#get_configuration') 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::ServiceCatalog::Models::Configuration'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_private_application(private_application_id, opts = {}) ⇒ Response

Note:

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

Gets the details of the specified private application.

Parameters:

  • private_application_id (String) —

    The unique identifier for the private application.

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



722
723
724
725
726
727
728
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
 
# File 'lib/oci/service_catalog/service_catalog_client.rb', line 722

def get_private_application(private_application_id, opts = {})
  logger.debug 'Calling operation ServiceCatalogClient#get_private_application.' if logger

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

  path = '/privateApplications/{privateApplicationId}'.sub('{privateApplicationId}', private_application_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: 'ServiceCatalogClient#get_private_application') 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::ServiceCatalog::Models::PrivateApplication'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_private_application_action_download_logo(private_application_id, opts = {}, &block) ⇒ Response

Note:

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

Downloads the binary payload of the logo image of the private application.

Parameters:

  • private_application_id (String) —

    The unique identifier for the private application.

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

    the optional parameters

  • [Block] (Hash) —

    a customizable set of options

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.

  • :response_target (String, IO) —

    Streaming http body into a file (specified by file name or File object) or IO object if the block is not given

Returns:

  • (Response) —

    A Response object with data of type String if response_target and block are not given, otherwise with nil data



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
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
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
 
# File 'lib/oci/service_catalog/service_catalog_client.rb', line 780

def (private_application_id, opts = {}, &block)
  logger.debug 'Calling operation ServiceCatalogClient#get_private_application_action_download_logo.' if logger

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

  path = '/privateApplications/{privateApplicationId}/actions/downloadLogo'.sub('{privateApplicationId}', private_application_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'image/bmp, image/gif, image/jpeg, image/png, image/tiff'
  header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding]
  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: 'ServiceCatalogClient#get_private_application_action_download_logo') do
    if !block.nil?
      @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: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @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: 'Stream',
          &proc { |chunk, _response| opts[:response_target].write(chunk) }
        )
      elsif opts[:response_target].is_a?(String)
        File.open(opts[:response_target], 'wb') do |output|
          return @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: 'Stream',
            &proc { |chunk, _response| output.write(chunk) }
          )
        end
      end
    else
      @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: 'String'
      )
    end
  end
  # rubocop:enable Metrics/BlockLength
end

#get_private_application_package(private_application_package_id, opts = {}) ⇒ Response

Note:

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

Gets the details of a specific package within a given private application.

Parameters:

  • private_application_package_id (String) —

    The unique identifier for the private application 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:



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
916
 
# File 'lib/oci/service_catalog/service_catalog_client.rb', line 880

def get_private_application_package(private_application_package_id, opts = {})
  logger.debug 'Calling operation ServiceCatalogClient#get_private_application_package.' if logger

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

  path = '/privateApplicationPackages/{privateApplicationPackageId}'.sub('{privateApplicationPackageId}', private_application_package_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: 'ServiceCatalogClient#get_private_application_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::ServiceCatalog::Models::PrivateApplicationPackage'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_private_application_package_action_download_config(private_application_package_id, opts = {}, &block) ⇒ Response

Note:

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

Downloads the configuration that was used to create the private application package.

Parameters:

  • private_application_package_id (String) —

    The unique identifier for the private application package.

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

    the optional parameters

  • [Block] (Hash) —

    a customizable set of options

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.

  • :response_target (String, IO) —

    Streaming http body into a file (specified by file name or File object) or IO object if the block is not given

Returns:

  • (Response) —

    A Response object with data of type String if response_target and block are not given, otherwise with nil data



938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
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
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
 
# File 'lib/oci/service_catalog/service_catalog_client.rb', line 938

def get_private_application_package_action_download_config(private_application_package_id, opts = {}, &block)
  logger.debug 'Calling operation ServiceCatalogClient#get_private_application_package_action_download_config.' if logger

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

  path = '/privateApplicationPackages/{privateApplicationPackageId}/actions/downloadConfig'.sub('{privateApplicationPackageId}', private_application_package_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'application/zip'
  header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding]
  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: 'ServiceCatalogClient#get_private_application_package_action_download_config') do
    if !block.nil?
      @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: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @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: 'Stream',
          &proc { |chunk, _response| opts[:response_target].write(chunk) }
        )
      elsif opts[:response_target].is_a?(String)
        File.open(opts[:response_target], 'wb') do |output|
          return @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: 'Stream',
            &proc { |chunk, _response| output.write(chunk) }
          )
        end
      end
    else
      @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: 'String'
      )
    end
  end
  # rubocop:enable Metrics/BlockLength
end

#get_service_catalog(service_catalog_id, opts = {}) ⇒ Response

Note:

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

Gets detailed information about the service catalog including name, compartmentId

Parameters:

  • service_catalog_id (String) —

    The unique identifier for the service catalog.

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



1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
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
 
# File 'lib/oci/service_catalog/service_catalog_client.rb', line 1038

def get_service_catalog(service_catalog_id, opts = {})
  logger.debug 'Calling operation ServiceCatalogClient#get_service_catalog.' if logger

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

  path = '/serviceCatalogs/{serviceCatalogId}'.sub('{serviceCatalogId}', service_catalog_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: 'ServiceCatalogClient#get_service_catalog') 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::ServiceCatalog::Models::ServiceCatalog'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_service_catalog_association(service_catalog_association_id, opts = {}) ⇒ Response

Note:

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

Gets detailed information about specific service catalog association.

Parameters:

  • service_catalog_association_id (String) —

    The unique identifier of the service catalog association.

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



1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
 
# File 'lib/oci/service_catalog/service_catalog_client.rb', line 1094

def get_service_catalog_association(service_catalog_association_id, opts = {})
  logger.debug 'Calling operation ServiceCatalogClient#get_service_catalog_association.' if logger

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

  path = '/serviceCatalogAssociations/{serviceCatalogAssociationId}'.sub('{serviceCatalogAssociationId}', service_catalog_association_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: 'ServiceCatalogClient#get_service_catalog_association') 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::ServiceCatalog::Models::ServiceCatalogAssociation'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_work_request(work_request_id, opts = {}) ⇒ Response

Note:

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

Gets the status of the work request with the given ID.

Parameters:

  • work_request_id (String) —

    The ID of the asynchronous request.

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



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
 
# File 'lib/oci/service_catalog/service_catalog_client.rb', line 1150

def get_work_request(work_request_id, opts = {})
  logger.debug 'Calling operation ServiceCatalogClient#get_work_request.' if logger

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

  path = '/workRequests/{workRequestId}'.sub('{workRequestId}', work_request_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: 'ServiceCatalogClient#get_work_request') 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::ServiceCatalog::Models::WorkRequest'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_all_applications(opts = {}) ⇒ Response

Note:

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

Lists all the available listings and private applications in a compartment. A new API for catalog manager use when creating/updating a service catalog.

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 unique identifier for the compartment.

  • :entity_type (String) —

    The type of the application in the service catalog.

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

    How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30. (default to 30)

  • :page (String) —

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

  • :display_name (String) —

    Exact match name filter.

  • :entity_id (String) —

    The unique identifier of the entity associated with service catalog.

  • :publisher_id (Array<String>) —

    Limit results to just this publisher.

  • :package_type (Array<String>) —

    Name of the package type. If multiple package types are provided, then any resource with one or more matching package types will be returned.

    Allowed values are: STACK, IMAGE

  • :pricing (Array<String>) —

    Name of the pricing type. If multiple pricing types are provided, then any resource with one or more matching pricing models will be returned.

    Allowed values are: FREE, BYOL, PAYGO

  • :is_featured (BOOLEAN) —

    Indicates whether to show only featured resources. If this is set to false or is omitted, then all resources will be returned. (default to false)

  • :sort_order (String) —

    The sort order to apply, either ASC or DESC. Default is ASC. (default to ASC) Allowed values are: ASC, DESC

Returns:



1227
1228
1229
1230
1231
1232
1233
1234
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
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
 
# File 'lib/oci/service_catalog/service_catalog_client.rb', line 1227

def list_all_applications(opts = {})
  logger.debug 'Calling operation ServiceCatalogClient#list_all_applications.' if logger



  package_type_allowable_values = %w[STACK IMAGE]
  if opts[:package_type] && !opts[:package_type].empty?
    opts[:package_type].each do |val_to_check|
      unless package_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "package_type", must be one of STACK, IMAGE.'
      end
    end
  end


  pricing_allowable_values = %w[FREE BYOL PAYGO]
  if opts[:pricing] && !opts[:pricing].empty?
    opts[:pricing].each do |val_to_check|
      unless pricing_allowable_values.include?(val_to_check)
        raise 'Invalid value for "pricing", must be one of FREE, BYOL, PAYGO.'
      end
    end
  end

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

  path = '/allApplications'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:entityType] = opts[:entity_type] if opts[:entity_type]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:entityId] = opts[:entity_id] if opts[:entity_id]
  query_params[:publisherId] = OCI::ApiClient.build_collection_params(opts[:publisher_id], :multi) if opts[:publisher_id] && !opts[:publisher_id].empty?
  query_params[:packageType] = OCI::ApiClient.build_collection_params(opts[:package_type], :multi) if opts[:package_type] && !opts[:package_type].empty?
  query_params[:pricing] = OCI::ApiClient.build_collection_params(opts[:pricing], :multi) if opts[:pricing] && !opts[:pricing].empty?
  query_params[:isFeatured] = opts[:is_featured] if !opts[:is_featured].nil?
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

  # 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: 'ServiceCatalogClient#list_all_applications') 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::ServiceCatalog::Models::ApplicationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_applications(opts = {}) ⇒ Response

Note:

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

Lists all the applications in a service catalog or a tenancy. If no parameter is specified, all catalogs from all compartments in the tenancy will be scanned for any type of content.

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 unique identifier for the compartment.

  • :service_catalog_id (String) —

    The unique identifier for the service catalog.

  • :entity_type (String) —

    The type of the application in the service catalog.

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

    How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30. (default to 30)

  • :page (String) —

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

  • :display_name (String) —

    Exact match name filter.

  • :entity_id (String) —

    The unique identifier of the entity associated with service catalog.

  • :publisher_id (Array<String>) —

    Limit results to just this publisher.

  • :package_type (Array<String>) —

    Name of the package type. If multiple package types are provided, then any resource with one or more matching package types will be returned.

    Allowed values are: STACK, IMAGE

  • :pricing (Array<String>) —

    Name of the pricing type. If multiple pricing types are provided, then any resource with one or more matching pricing models will be returned.

    Allowed values are: FREE, BYOL, PAYGO

  • :is_featured (BOOLEAN) —

    Indicates whether to show only featured resources. If this is set to false or is omitted, then all resources will be returned. (default to false)

  • :sort_order (String) —

    The sort order to apply, either ASC or DESC. Default is ASC. (default to ASC) Allowed values are: ASC, DESC

Returns:



1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
 
# File 'lib/oci/service_catalog/service_catalog_client.rb', line 1339

def list_applications(opts = {})
  logger.debug 'Calling operation ServiceCatalogClient#list_applications.' if logger



  package_type_allowable_values = %w[STACK IMAGE]
  if opts[:package_type] && !opts[:package_type].empty?
    opts[:package_type].each do |val_to_check|
      unless package_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "package_type", must be one of STACK, IMAGE.'
      end
    end
  end


  pricing_allowable_values = %w[FREE BYOL PAYGO]
  if opts[:pricing] && !opts[:pricing].empty?
    opts[:pricing].each do |val_to_check|
      unless pricing_allowable_values.include?(val_to_check)
        raise 'Invalid value for "pricing", must be one of FREE, BYOL, PAYGO.'
      end
    end
  end

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

  path = '/applications'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:serviceCatalogId] = opts[:service_catalog_id] if opts[:service_catalog_id]
  query_params[:entityType] = opts[:entity_type] if opts[:entity_type]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:entityId] = opts[:entity_id] if opts[:entity_id]
  query_params[:publisherId] = OCI::ApiClient.build_collection_params(opts[:publisher_id], :multi) if opts[:publisher_id] && !opts[:publisher_id].empty?
  query_params[:packageType] = OCI::ApiClient.build_collection_params(opts[:package_type], :multi) if opts[:package_type] && !opts[:package_type].empty?
  query_params[:pricing] = OCI::ApiClient.build_collection_params(opts[:pricing], :multi) if opts[:pricing] && !opts[:pricing].empty?
  query_params[:isFeatured] = opts[:is_featured] if !opts[:is_featured].nil?
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

  # 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: 'ServiceCatalogClient#list_applications') 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::ServiceCatalog::Models::ApplicationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_private_application_packages(private_application_id, opts = {}) ⇒ Response

Note:

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

Lists the packages in the specified private application.

Parameters:

  • private_application_id (String) —

    The unique identifier for the private application.

  • 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

  • :private_application_package_id (String) —

    The unique identifier for the private application package.

  • :package_type (Array<String>) —

    Name of the package type. If multiple package types are provided, then any resource with one or more matching package types will be returned.

    Allowed values are: STACK, IMAGE

  • :limit (Integer) —

    How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30. (default to 30)

  • :page (String) —

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

  • :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_by (String) —

    The field to use to sort listed results. You can only specify one field to sort by. TIMECREATED displays results in descending order by default. You can change your preference by specifying a different sort order. (default to TIMECREATED) Allowed values are: TIMECREATED, VERSION

  • :sort_order (String) —

    The sort order to apply, either ASC or DESC. Default is ASC. (default to ASC) Allowed values are: ASC, DESC

  • :display_name (String) —

    Exact match name filter.

Returns:



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
 
# File 'lib/oci/service_catalog/service_catalog_client.rb', line 1445

def list_private_application_packages(private_application_id, opts = {})
  logger.debug 'Calling operation ServiceCatalogClient#list_private_application_packages.' if logger

  raise "Missing the required parameter 'private_application_id' when calling list_private_application_packages." if private_application_id.nil?


  package_type_allowable_values = %w[STACK IMAGE]
  if opts[:package_type] && !opts[:package_type].empty?
    opts[:package_type].each do |val_to_check|
      unless package_type_allowable_values.include?(val_to_check)
        raise 'Invalid value for "package_type", must be one of STACK, IMAGE.'
      end
    end
  end

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

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

  path = '/privateApplicationPackages'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:privateApplicationId] = private_application_id
  query_params[:privateApplicationPackageId] = opts[:private_application_package_id] if opts[:private_application_package_id]
  query_params[:packageType] = OCI::ApiClient.build_collection_params(opts[:package_type], :multi) if opts[:package_type] && !opts[:package_type].empty?
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  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]

  # 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: 'ServiceCatalogClient#list_private_application_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::ServiceCatalog::Models::PrivateApplicationPackageCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Lists all the private applications in a given compartment.

Parameters:

  • compartment_id (String) —

    The unique identifier for the compartment.

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

    the optional parameters

Options Hash (opts):

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

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

  • :private_application_id (String) —

    The unique identifier for the private application.

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

    How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30. (default to 30)

  • :page (String) —

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

  • :sort_by (String) —

    The field to use to sort listed results. You can only specify one field to sort by. Default is TIMECREATED. (default to TIMECREATED) Allowed values are: TIMECREATED, LIFECYCLESTATE

  • :sort_order (String) —

    The sort order to apply, either ASC or DESC. Default is ASC. (default to ASC) Allowed values are: ASC, DESC

  • :display_name (String) —

    Exact match name filter.

Returns:



1537
1538
1539
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
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
 
# File 'lib/oci/service_catalog/service_catalog_client.rb', line 1537

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

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

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

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

  path = '/privateApplications'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:privateApplicationId] = opts[:private_application_id] if opts[:private_application_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  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]

  # 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: 'ServiceCatalogClient#list_private_applications') 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::ServiceCatalog::Models::PrivateApplicationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_service_catalog_associations(opts = {}) ⇒ Response

Note:

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

Lists all the resource associations for a specific service catalog.

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

  • :service_catalog_association_id (String) —

    The unique identifier for the service catalog association.

  • :service_catalog_id (String) —

    The unique identifier for the service catalog.

  • :entity_id (String) —

    The unique identifier of the entity associated with service catalog.

  • :entity_type (String) —

    The type of the application in the service catalog.

  • :limit (Integer) —

    How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30. (default to 30)

  • :page (String) —

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

  • :sort_order (String) —

    The sort order to apply, either ASC or DESC. Default is ASC. (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

    Default is TIMECREATED (default to TIMECREATED) Allowed values are: 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:



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
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
 
# File 'lib/oci/service_catalog/service_catalog_client.rb', line 1617

def list_service_catalog_associations(opts = {})
  logger.debug 'Calling operation ServiceCatalogClient#list_service_catalog_associations.' if logger


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

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

  path = '/serviceCatalogAssociations'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:serviceCatalogAssociationId] = opts[:service_catalog_association_id] if opts[:service_catalog_association_id]
  query_params[:serviceCatalogId] = opts[:service_catalog_id] if opts[:service_catalog_id]
  query_params[:entityId] = opts[:entity_id] if opts[:entity_id]
  query_params[:entityType] = opts[:entity_type] if opts[:entity_type]
  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: 'ServiceCatalogClient#list_service_catalog_associations') 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::ServiceCatalog::Models::ServiceCatalogAssociationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Lists all the service catalogs in the given compartment.

Parameters:

  • compartment_id (String) —

    The unique identifier for the compartment.

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

    the optional parameters

Options Hash (opts):

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

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

  • :service_catalog_id (String) —

    The unique identifier for the service catalog.

  • :status (String) —

    Status of the service catalog, use as a filter to filter out all active catalogs.

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

    How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30. (default to 30)

  • :page (String) —

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

  • :sort_by (String) —

    Default is TIMECREATED (default to TIMECREATED) Allowed values are: TIMECREATED

  • :sort_order (String) —

    The sort order to apply, either ASC or DESC. Default is ASC. (default to ASC) Allowed values are: ASC, DESC

  • :display_name (String) —

    Exact match name filter.

Returns:



1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
 
# File 'lib/oci/service_catalog/service_catalog_client.rb', line 1697

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

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

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

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

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

  path = '/serviceCatalogs'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:serviceCatalogId] = opts[:service_catalog_id] if opts[:service_catalog_id]
  query_params[:status] = opts[:status] if opts[:status]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  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]

  # 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: 'ServiceCatalogClient#list_service_catalogs') 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::ServiceCatalog::Models::ServiceCatalogCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_work_request_errors(work_request_id, opts = {}) ⇒ Response

Note:

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

Return a (paginated) list of errors for a given work request.

Allowed values are: timeAccepted

Parameters:

  • work_request_id (String) —

    The ID of the asynchronous request.

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

  • :page (String) —

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

  • :limit (Integer) —

    How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30. (default to 30)

  • :sort_by (String) —

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

  • :sort_order (String) —

    The sort order to apply, either ASC or DESC. Default is ASC. (default to ASC) Allowed values are: ASC, DESC

Returns:



1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
 
# File 'lib/oci/service_catalog/service_catalog_client.rb', line 1781

def list_work_request_errors(work_request_id, opts = {})
  logger.debug 'Calling operation ServiceCatalogClient#list_work_request_errors.' if logger

  raise "Missing the required parameter 'work_request_id' when calling list_work_request_errors." if work_request_id.nil?

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

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

  path = '/workRequests/{workRequestId}/errors'.sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

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

  # 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: 'ServiceCatalogClient#list_work_request_errors') 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::ServiceCatalog::Models::WorkRequestErrorCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_work_request_logs(work_request_id, opts = {}) ⇒ Response

Note:

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

Return a (paginated) list of logs for a given work request.

Allowed values are: timeAccepted

Parameters:

  • work_request_id (String) —

    The ID of the asynchronous request.

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

  • :page (String) —

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

  • :limit (Integer) —

    How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30. (default to 30)

  • :sort_by (String) —

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

  • :sort_order (String) —

    The sort order to apply, either ASC or DESC. Default is ASC. (default to ASC) Allowed values are: ASC, DESC

Returns:



1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
 
# File 'lib/oci/service_catalog/service_catalog_client.rb', line 1858

def list_work_request_logs(work_request_id, opts = {})
  logger.debug 'Calling operation ServiceCatalogClient#list_work_request_logs.' if logger

  raise "Missing the required parameter 'work_request_id' when calling list_work_request_logs." if work_request_id.nil?

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

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

  path = '/workRequests/{workRequestId}/logs'.sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

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

  # 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: 'ServiceCatalogClient#list_work_request_logs') 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::ServiceCatalog::Models::WorkRequestLogEntryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_work_requests(opts = {}) ⇒ Response

Note:

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

Lists the work requests in a compartment.

Allowed values are: timeAccepted

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 unique identifier for the compartment.

  • :work_request_id (String) —

    The ID of the asynchronous work request.

  • :status (String) —

    A filter to return only resources their lifecycleState matches the given OperationStatus.

  • :resource_id (String) —

    The ID of the resource affected by the work request

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

  • :page (String) —

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

  • :limit (Integer) —

    How many records to return. Specify a value greater than zero and less than or equal to 1000. The default is 30. (default to 30)

  • :sort_order (String) —

    The sort order to apply, either ASC or DESC. Default is ASC. (default to ASC) Allowed values are: ASC, DESC

  • :sort_by (String) —

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

Returns:



1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
 
# File 'lib/oci/service_catalog/service_catalog_client.rb', line 1938

def list_work_requests(opts = {})
  logger.debug 'Calling operation ServiceCatalogClient#list_work_requests.' if logger


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

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

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

  path = '/workRequests'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:workRequestId] = opts[:work_request_id] if opts[:work_request_id]
  query_params[:status] = opts[:status] if opts[:status]
  query_params[:resourceId] = opts[:resource_id] if opts[:resource_id]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  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: 'ServiceCatalogClient#list_work_requests') 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::ServiceCatalog::Models::WorkRequestSummaryCollection'
    )
  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.



95
96
97
 
# File 'lib/oci/service_catalog/service_catalog_client.rb', line 95

def logger
  @api_client.config.logger
end

#update_private_application(private_application_id, update_private_application_details, opts = {}) ⇒ Response

Note:

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

Updates the details of an existing private application.

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:



2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
 
# File 'lib/oci/service_catalog/service_catalog_client.rb', line 2017

def update_private_application(private_application_id, update_private_application_details, opts = {})
  logger.debug 'Calling operation ServiceCatalogClient#update_private_application.' if logger

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

  path = '/privateApplications/{privateApplicationId}'.sub('{privateApplicationId}', private_application_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_private_application_details)

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

#update_service_catalog(service_catalog_id, update_service_catalog_details, opts = {}) ⇒ Response

Note:

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

Updates the details of a previously created service catalog.

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:



2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
 
# File 'lib/oci/service_catalog/service_catalog_client.rb', line 2080

def update_service_catalog(service_catalog_id, update_service_catalog_details, opts = {})
  logger.debug 'Calling operation ServiceCatalogClient#update_service_catalog.' if logger

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

  path = '/serviceCatalogs/{serviceCatalogId}'.sub('{serviceCatalogId}', service_catalog_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_service_catalog_details)

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