Class: OCI::FusionApps::FusionApplicationsClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/fusion_apps/fusion_applications_client.rb

Overview

Use the Fusion Applications Environment Management API to manage the environments where your Fusion Applications run. For more information, see the Fusion Applications Environment Management documentation.

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

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

This client is not thread-safe

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

Parameters:

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

    A Config object.

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

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

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

    The fully qualified endpoint URL

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

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

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

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

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

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



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

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

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

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

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

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



15
16
17
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 15

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 19

def endpoint
  @endpoint
end

#region ⇒ String

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

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 29

def region
  @region
end

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

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

Returns:



25
26
27
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 25

def retry_config
  @retry_config
end

Instance Method Details

#change_fusion_environment_compartment(fusion_environment_id, change_fusion_environment_compartment_details, opts = {}) ⇒ Response

Note:

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

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

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 126

def change_fusion_environment_compartment(fusion_environment_id, change_fusion_environment_compartment_details, opts = {})
  logger.debug 'Calling operation FusionApplicationsClient#change_fusion_environment_compartment.' if logger

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

  path = '/fusionEnvironments/{fusionEnvironmentId}/actions/changeCompartment'.sub('{fusionEnvironmentId}', fusion_environment_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(change_fusion_environment_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'FusionApplicationsClient#change_fusion_environment_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_fusion_environment_family_compartment(fusion_environment_family_id, change_fusion_environment_family_compartment_details, opts = {}) ⇒ Response

Note:

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

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

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 198

def change_fusion_environment_family_compartment(fusion_environment_family_id, change_fusion_environment_family_compartment_details, opts = {})
  logger.debug 'Calling operation FusionApplicationsClient#change_fusion_environment_family_compartment.' if logger

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

  path = '/fusionEnvironmentFamilies/{fusionEnvironmentFamilyId}/actions/changeCompartment'.sub('{fusionEnvironmentFamilyId}', fusion_environment_family_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(change_fusion_environment_family_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'FusionApplicationsClient#change_fusion_environment_family_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_data_masking_activity(fusion_environment_id, create_data_masking_activity_details, opts = {}) ⇒ Response

Note:

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

Creates a new DataMaskingActivity.

Parameters:

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 263

def create_data_masking_activity(fusion_environment_id, create_data_masking_activity_details, opts = {})
  logger.debug 'Calling operation FusionApplicationsClient#create_data_masking_activity.' if logger

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

  path = '/fusionEnvironments/{fusionEnvironmentId}/dataMaskingActivities'.sub('{fusionEnvironmentId}', fusion_environment_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(create_data_masking_activity_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'FusionApplicationsClient#create_data_masking_activity') 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_fusion_environment(create_fusion_environment_details, opts = {}) ⇒ Response

Note:

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

Creates a new FusionEnvironment.

Parameters:

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 326

def create_fusion_environment(create_fusion_environment_details, opts = {})
  logger.debug 'Calling operation FusionApplicationsClient#create_fusion_environment.' if logger

  raise "Missing the required parameter 'create_fusion_environment_details' when calling create_fusion_environment." if create_fusion_environment_details.nil?

  path = '/fusionEnvironments'
  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_fusion_environment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'FusionApplicationsClient#create_fusion_environment') 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_fusion_environment_admin_user(create_fusion_environment_admin_user_details, fusion_environment_id, opts = {}) ⇒ Response

Note:

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

Create a FusionEnvironment admin user

Parameters:

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 387

def create_fusion_environment_admin_user(create_fusion_environment_admin_user_details, fusion_environment_id, opts = {})
  logger.debug 'Calling operation FusionApplicationsClient#create_fusion_environment_admin_user.' if logger

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

  path = '/fusionEnvironments/{fusionEnvironmentId}/adminUsers'.sub('{fusionEnvironmentId}', fusion_environment_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(create_fusion_environment_admin_user_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'FusionApplicationsClient#create_fusion_environment_admin_user') 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_fusion_environment_family(create_fusion_environment_family_details, opts = {}) ⇒ Response

Note:

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

Creates a new FusionEnvironmentFamily.

Parameters:

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 450

def create_fusion_environment_family(create_fusion_environment_family_details, opts = {})
  logger.debug 'Calling operation FusionApplicationsClient#create_fusion_environment_family.' if logger

  raise "Missing the required parameter 'create_fusion_environment_family_details' when calling create_fusion_environment_family." if create_fusion_environment_family_details.nil?

  path = '/fusionEnvironmentFamilies'
  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_fusion_environment_family_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'FusionApplicationsClient#create_fusion_environment_family') 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_refresh_activity(fusion_environment_id, create_refresh_activity_details, opts = {}) ⇒ Response

Note:

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

Creates a new RefreshActivity.

Parameters:

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 512

def create_refresh_activity(fusion_environment_id, create_refresh_activity_details, opts = {})
  logger.debug 'Calling operation FusionApplicationsClient#create_refresh_activity.' if logger

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

  path = '/fusionEnvironments/{fusionEnvironmentId}/refreshActivities'.sub('{fusionEnvironmentId}', fusion_environment_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(create_refresh_activity_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'FusionApplicationsClient#create_refresh_activity') 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_service_attachment(create_service_attachment_details, fusion_environment_id, opts = {}) ⇒ Response

Note:

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

Attaches a service instance to the fusion pod.

Parameters:

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 576

def create_service_attachment(create_service_attachment_details, fusion_environment_id, opts = {})
  logger.debug 'Calling operation FusionApplicationsClient#create_service_attachment.' if logger

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

  path = '/fusionEnvironments/{fusionEnvironmentId}/serviceAttachments'.sub('{fusionEnvironmentId}', fusion_environment_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  # 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_attachment_details)

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

#delete_fusion_environment(fusion_environment_id, opts = {}) ⇒ Response

Note:

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

Deletes the Fusion environment identified by it's OCID.

Parameters:

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 638

def delete_fusion_environment(fusion_environment_id, opts = {})
  logger.debug 'Calling operation FusionApplicationsClient#delete_fusion_environment.' if logger

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

  path = '/fusionEnvironments/{fusionEnvironmentId}'.sub('{fusionEnvironmentId}', fusion_environment_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: 'FusionApplicationsClient#delete_fusion_environment') 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_fusion_environment_admin_user(admin_username, fusion_environment_id, opts = {}) ⇒ Response

Note:

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

Deletes the FusionEnvironment administrator user identified by the username.

Parameters:

  • admin_username (String) —

    The admin user name for the fusion environment.

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 699

def delete_fusion_environment_admin_user(admin_username, fusion_environment_id, opts = {})
  logger.debug 'Calling operation FusionApplicationsClient#delete_fusion_environment_admin_user.' if logger

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

  path = '/fusionEnvironments/{fusionEnvironmentId}/adminUsers/{adminUsername}'.sub('{adminUsername}', admin_username.to_s).sub('{fusionEnvironmentId}', fusion_environment_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: 'FusionApplicationsClient#delete_fusion_environment_admin_user') 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_fusion_environment_family(fusion_environment_family_id, opts = {}) ⇒ Response

Note:

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

Deletes a FusionEnvironmentFamily resource by identifier

Parameters:

  • fusion_environment_family_id (String) —

    The unique identifier (OCID) of the FusionEnvironmentFamily.

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 761

def delete_fusion_environment_family(fusion_environment_family_id, opts = {})
  logger.debug 'Calling operation FusionApplicationsClient#delete_fusion_environment_family.' if logger

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

  path = '/fusionEnvironmentFamilies/{fusionEnvironmentFamilyId}'.sub('{fusionEnvironmentFamilyId}', fusion_environment_family_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: 'FusionApplicationsClient#delete_fusion_environment_family') 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_refresh_activity(fusion_environment_id, refresh_activity_id, opts = {}) ⇒ Response

Note:

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

Deletes a scheduled RefreshActivity resource by identifier

Parameters:

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

  • refresh_activity_id (String) —

    The unique identifier (OCID) of the Refresh activity.

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



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/fusion_apps/fusion_applications_client.rb', line 822

def delete_refresh_activity(fusion_environment_id, refresh_activity_id, opts = {})
  logger.debug 'Calling operation FusionApplicationsClient#delete_refresh_activity.' if logger

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

  path = '/fusionEnvironments/{fusionEnvironmentId}/refreshActivities/{refreshActivityId}'.sub('{fusionEnvironmentId}', fusion_environment_id.to_s).sub('{refreshActivityId}', refresh_activity_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: 'FusionApplicationsClient#delete_refresh_activity') 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_attachment(fusion_environment_id, service_attachment_id, opts = {}) ⇒ Response

Note:

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

Delete a service attachment by identifier

Parameters:

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

  • service_attachment_id (String) —

    OCID of the Service Attachment

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



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
917
918
919
920
921
922
923
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 885

def delete_service_attachment(fusion_environment_id, service_attachment_id, opts = {})
  logger.debug 'Calling operation FusionApplicationsClient#delete_service_attachment.' if logger

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

  path = '/fusionEnvironments/{fusionEnvironmentId}/serviceAttachments/{serviceAttachmentId}'.sub('{fusionEnvironmentId}', fusion_environment_id.to_s).sub('{serviceAttachmentId}', service_attachment_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: 'FusionApplicationsClient#delete_service_attachment') 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

#generate_extract_details(fusion_environment_id, opts = {}) ⇒ Response

Note:

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

Begin the process of showing the details about where to retrieve data extract for a Fusion environment.

Parameters:

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



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
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 942

def generate_extract_details(fusion_environment_id, opts = {})
  logger.debug 'Calling operation FusionApplicationsClient#generate_extract_details.' if logger

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

  path = '/fusionEnvironments/{fusionEnvironmentId}/actions/generateExtractDetails'.sub('{fusionEnvironmentId}', fusion_environment_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: 'FusionApplicationsClient#generate_extract_details') 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::FusionApps::Models::ExtractDetailsCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_data_masking_activity(fusion_environment_id, data_masking_activity_id, opts = {}) ⇒ Response

Note:

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

Gets a DataMaskingActivity by identifier

Parameters:

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

  • data_masking_activity_id (String) —

    Unique DataMasking run identifier.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 997

def get_data_masking_activity(fusion_environment_id, data_masking_activity_id, opts = {})
  logger.debug 'Calling operation FusionApplicationsClient#get_data_masking_activity.' if logger

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

  path = '/fusionEnvironments/{fusionEnvironmentId}/dataMaskingActivities/{dataMaskingActivityId}'.sub('{fusionEnvironmentId}', fusion_environment_id.to_s).sub('{dataMaskingActivityId}', data_masking_activity_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: 'FusionApplicationsClient#get_data_masking_activity') 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::FusionApps::Models::DataMaskingActivity'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_fusion_environment(fusion_environment_id, opts = {}) ⇒ Response

Note:

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

Gets a FusionEnvironment by identifier

Parameters:

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 1053

def get_fusion_environment(fusion_environment_id, opts = {})
  logger.debug 'Calling operation FusionApplicationsClient#get_fusion_environment.' if logger

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

  path = '/fusionEnvironments/{fusionEnvironmentId}'.sub('{fusionEnvironmentId}', fusion_environment_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: 'FusionApplicationsClient#get_fusion_environment') 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::FusionApps::Models::FusionEnvironment'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_fusion_environment_family(fusion_environment_family_id, opts = {}) ⇒ Response

Note:

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

Retrieves a fusion environment family identified by its OCID.

Parameters:

  • fusion_environment_family_id (String) —

    The unique identifier (OCID) of the FusionEnvironmentFamily.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 1107

def get_fusion_environment_family(fusion_environment_family_id, opts = {})
  logger.debug 'Calling operation FusionApplicationsClient#get_fusion_environment_family.' if logger

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

  path = '/fusionEnvironmentFamilies/{fusionEnvironmentFamilyId}'.sub('{fusionEnvironmentFamilyId}', fusion_environment_family_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: 'FusionApplicationsClient#get_fusion_environment_family') 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::FusionApps::Models::FusionEnvironmentFamily'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_fusion_environment_family_limits_and_usage(fusion_environment_family_id, opts = {}) ⇒ Response

Note:

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

Gets the number of environments (usage) of each type in the fusion environment family, as well as the limit that's allowed to be created based on the group's associated subscriptions.

Parameters:

  • fusion_environment_family_id (String) —

    The unique identifier (OCID) of the FusionEnvironmentFamily.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 1161

def get_fusion_environment_family_limits_and_usage(fusion_environment_family_id, opts = {})
  logger.debug 'Calling operation FusionApplicationsClient#get_fusion_environment_family_limits_and_usage.' if logger

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

  path = '/fusionEnvironmentFamilies/{fusionEnvironmentFamilyId}/limitsAndUsage'.sub('{fusionEnvironmentFamilyId}', fusion_environment_family_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: 'FusionApplicationsClient#get_fusion_environment_family_limits_and_usage') 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::FusionApps::Models::FusionEnvironmentFamilyLimitsAndUsage'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_fusion_environment_family_subscription_detail(fusion_environment_family_id, opts = {}) ⇒ Response

Note:

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

Gets the subscription details of an fusion environment family.

Parameters:

  • fusion_environment_family_id (String) —

    The unique identifier (OCID) of the FusionEnvironmentFamily.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
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
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 1215

def get_fusion_environment_family_subscription_detail(fusion_environment_family_id, opts = {})
  logger.debug 'Calling operation FusionApplicationsClient#get_fusion_environment_family_subscription_detail.' if logger

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

  path = '/fusionEnvironmentFamilies/{fusionEnvironmentFamilyId}/subscriptionDetails'.sub('{fusionEnvironmentFamilyId}', fusion_environment_family_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: 'FusionApplicationsClient#get_fusion_environment_family_subscription_detail') 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::FusionApps::Models::SubscriptionDetail'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_fusion_environment_status(fusion_environment_id, opts = {}) ⇒ Response

Note:

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

Gets the status of a Fusion environment identified by its OCID.

Parameters:

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



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
1297
1298
1299
1300
1301
1302
1303
1304
1305
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 1269

def get_fusion_environment_status(fusion_environment_id, opts = {})
  logger.debug 'Calling operation FusionApplicationsClient#get_fusion_environment_status.' if logger

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

  path = '/fusionEnvironments/{fusionEnvironmentId}/status'.sub('{fusionEnvironmentId}', fusion_environment_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: 'FusionApplicationsClient#get_fusion_environment_status') 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::FusionApps::Models::FusionEnvironmentStatus'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_refresh_activity(fusion_environment_id, refresh_activity_id, opts = {}) ⇒ Response

Note:

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

Gets a RefreshActivity by identifier

Parameters:

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

  • refresh_activity_id (String) —

    The unique identifier (OCID) of the Refresh activity.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 1324

def get_refresh_activity(fusion_environment_id, refresh_activity_id, opts = {})
  logger.debug 'Calling operation FusionApplicationsClient#get_refresh_activity.' if logger

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

  path = '/fusionEnvironments/{fusionEnvironmentId}/refreshActivities/{refreshActivityId}'.sub('{fusionEnvironmentId}', fusion_environment_id.to_s).sub('{refreshActivityId}', refresh_activity_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: 'FusionApplicationsClient#get_refresh_activity') 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::FusionApps::Models::RefreshActivity'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_scheduled_activity(fusion_environment_id, scheduled_activity_id, opts = {}) ⇒ Response

Note:

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

Gets a ScheduledActivity by identifier

Parameters:

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

  • scheduled_activity_id (String) —

    Unique ScheduledActivity identifier.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



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
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 1381

def get_scheduled_activity(fusion_environment_id, scheduled_activity_id, opts = {})
  logger.debug 'Calling operation FusionApplicationsClient#get_scheduled_activity.' if logger

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

  path = '/fusionEnvironments/{fusionEnvironmentId}/scheduledActivities/{scheduledActivityId}'.sub('{fusionEnvironmentId}', fusion_environment_id.to_s).sub('{scheduledActivityId}', scheduled_activity_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: 'FusionApplicationsClient#get_scheduled_activity') 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::FusionApps::Models::ScheduledActivity'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_service_attachment(fusion_environment_id, service_attachment_id, opts = {}) ⇒ Response

Note:

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

Gets a Service Attachment by identifier

Parameters:

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

  • service_attachment_id (String) —

    OCID of the Service Attachment

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 1438

def get_service_attachment(fusion_environment_id, service_attachment_id, opts = {})
  logger.debug 'Calling operation FusionApplicationsClient#get_service_attachment.' if logger

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

  path = '/fusionEnvironments/{fusionEnvironmentId}/serviceAttachments/{serviceAttachmentId}'.sub('{fusionEnvironmentId}', fusion_environment_id.to_s).sub('{serviceAttachmentId}', service_attachment_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: 'FusionApplicationsClient#get_service_attachment') 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::FusionApps::Models::ServiceAttachment'
    )
  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) —

    The client request ID for tracing.

Returns:



1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 1494

def get_work_request(work_request_id, opts = {})
  logger.debug 'Calling operation FusionApplicationsClient#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: 'FusionApplicationsClient#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::FusionApps::Models::WorkRequest'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#initiate_extract(fusion_environment_id, opts = {}) ⇒ Response

Note:

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

Begin the process of generating the data extract for a Fusion environment.

Parameters:

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



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
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 1549

def initiate_extract(fusion_environment_id, opts = {})
  logger.debug 'Calling operation FusionApplicationsClient#initiate_extract.' if logger

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

  path = '/fusionEnvironments/{fusionEnvironmentId}/actions/initiateExtract'.sub('{fusionEnvironmentId}', fusion_environment_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: 'FusionApplicationsClient#initiate_extract') 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

#list_admin_users(fusion_environment_id, opts = {}) ⇒ Response

Note:

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

List all FusionEnvironment admin users

Parameters:

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 1602

def list_admin_users(fusion_environment_id, opts = {})
  logger.debug 'Calling operation FusionApplicationsClient#list_admin_users.' if logger

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

  path = '/fusionEnvironments/{fusionEnvironmentId}/adminUsers'.sub('{fusionEnvironmentId}', fusion_environment_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: 'FusionApplicationsClient#list_admin_users') 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::FusionApps::Models::AdminUserCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_data_masking_activities(fusion_environment_id, opts = {}) ⇒ Response

Note:

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

Returns a list of DataMaskingActivities.

Allowed values are: TIME_CREATED, DISPLAY_NAME

Parameters:

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

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

    the optional parameters

Options Hash (opts):

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

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

  • :lifecycle_state (String) —

    A filter that returns all resources that match the specified status

  • :limit (Integer) —

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

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. (default to DESC) Allowed values are: ASC, DESC

  • :sort_by (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 1665

def list_data_masking_activities(fusion_environment_id, opts = {})
  logger.debug 'Calling operation FusionApplicationsClient#list_data_masking_activities.' if logger

  raise "Missing the required parameter 'fusion_environment_id' when calling list_data_masking_activities." if fusion_environment_id.nil?

  if opts[:lifecycle_state] && !OCI::FusionApps::Models::DataMaskingActivity::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::FusionApps::Models::DataMaskingActivity::LIFECYCLE_STATE_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[TIME_CREATED DISPLAY_NAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME.'
  end
  raise "Parameter value for 'fusion_environment_id' must not be blank" if OCI::Internal::Util.blank_string?(fusion_environment_id)

  path = '/fusionEnvironments/{fusionEnvironmentId}/dataMaskingActivities'.sub('{fusionEnvironmentId}', fusion_environment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  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: 'FusionApplicationsClient#list_data_masking_activities') 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::FusionApps::Models::DataMaskingActivityCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Returns a list of FusionEnvironmentFamilies.

Allowed values are: TIME_CREATED, DISPLAY_NAME

Parameters:

  • compartment_id (String) —

    The ID of the compartment in which to list resources.

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

    the optional parameters

Options Hash (opts):

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

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

  • :fusion_environment_family_id (String) —

    The ID of the fusion environment family in which to list resources.

  • :display_name (String) —

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

  • :lifecycle_state (String) —

    A filter that returns all resources that match the specified lifecycle state.

  • :limit (Integer) —

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

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. (default to DESC) Allowed values are: ASC, DESC

  • :sort_by (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 1747

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

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

  if opts[:lifecycle_state] && !OCI::FusionApps::Models::FusionEnvironmentFamily::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::FusionApps::Models::FusionEnvironmentFamily::LIFECYCLE_STATE_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[TIME_CREATED DISPLAY_NAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME.'
  end

  path = '/fusionEnvironmentFamilies'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:fusionEnvironmentFamilyId] = opts[:fusion_environment_family_id] if opts[:fusion_environment_family_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  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: 'FusionApplicationsClient#list_fusion_environment_families') 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::FusionApps::Models::FusionEnvironmentFamilyCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Returns a list of FusionEnvironments.

Allowed values are: TIME_CREATED, DISPLAY_NAME

Parameters:

  • compartment_id (String) —

    The ID of the compartment in which to list resources.

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

    the optional parameters

Options Hash (opts):

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

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

  • :fusion_environment_family_id (String) —

    The ID of the fusion environment family in which to list resources.

  • :display_name (String) —

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

  • :lifecycle_state (String) —

    A filter that returns all resources that match the specified lifecycle state.

  • :limit (Integer) —

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

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. (default to DESC) Allowed values are: ASC, DESC

  • :sort_by (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
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
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 1831

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

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

  if opts[:lifecycle_state] && !OCI::FusionApps::Models::FusionEnvironment::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::FusionApps::Models::FusionEnvironment::LIFECYCLE_STATE_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[TIME_CREATED DISPLAY_NAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME.'
  end

  path = '/fusionEnvironments'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:fusionEnvironmentFamilyId] = opts[:fusion_environment_family_id] if opts[:fusion_environment_family_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  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: 'FusionApplicationsClient#list_fusion_environments') 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::FusionApps::Models::FusionEnvironmentCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_refresh_activities(fusion_environment_id, opts = {}) ⇒ Response

Note:

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

Returns a list of RefreshActivities.

Allowed values are: TIME_CREATED, DISPLAY_NAME

Parameters:

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

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

    the optional parameters

Options Hash (opts):

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

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

  • :display_name (String) —

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

  • :time_scheduled_start_greater_than_or_equal_to (DateTime) —

    A filter that returns all resources that are scheduled after this date

  • :time_expected_finish_less_than_or_equal_to (DateTime) —

    A filter that returns all resources that end before this date

  • :lifecycle_state (String) —

    A filter that returns all resources that match the specified status

  • :limit (Integer) —

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

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. (default to DESC) Allowed values are: ASC, DESC

  • :sort_by (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
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
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 1916

def list_refresh_activities(fusion_environment_id, opts = {})
  logger.debug 'Calling operation FusionApplicationsClient#list_refresh_activities.' if logger

  raise "Missing the required parameter 'fusion_environment_id' when calling list_refresh_activities." if fusion_environment_id.nil?

  if opts[:lifecycle_state] && !OCI::FusionApps::Models::RefreshActivity::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::FusionApps::Models::RefreshActivity::LIFECYCLE_STATE_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[TIME_CREATED DISPLAY_NAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME.'
  end
  raise "Parameter value for 'fusion_environment_id' must not be blank" if OCI::Internal::Util.blank_string?(fusion_environment_id)

  path = '/fusionEnvironments/{fusionEnvironmentId}/refreshActivities'.sub('{fusionEnvironmentId}', fusion_environment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:timeScheduledStartGreaterThanOrEqualTo] = opts[:time_scheduled_start_greater_than_or_equal_to] if opts[:time_scheduled_start_greater_than_or_equal_to]
  query_params[:timeExpectedFinishLessThanOrEqualTo] = opts[:time_expected_finish_less_than_or_equal_to] if opts[:time_expected_finish_less_than_or_equal_to]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  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: 'FusionApplicationsClient#list_refresh_activities') 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::FusionApps::Models::RefreshActivityCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_scheduled_activities(fusion_environment_id, opts = {}) ⇒ Response

Note:

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

Returns a list of ScheduledActivities.

Allowed values are: TIME_CREATED, DISPLAY_NAME

Parameters:

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

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

    the optional parameters

Options Hash (opts):

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

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

  • :display_name (String) —

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

  • :time_scheduled_start_greater_than_or_equal_to (DateTime) —

    A filter that returns all resources that are scheduled after this date

  • :time_expected_finish_less_than_or_equal_to (DateTime) —

    A filter that returns all resources that end before this date

  • :run_cycle (String) —

    A filter that returns all resources that match the specified run cycle.

  • :lifecycle_state (String) —

    A filter that returns all resources that match the specified status

  • :scheduled_activity_association_id (String) —

    A filter that returns all resources that match the specified scheduledActivityAssociationId.

  • :scheduled_activity_phase (String) —

    A filter that returns all resources that match the specified scheduledActivityPhase.

  • :limit (Integer) —

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

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. (default to DESC) Allowed values are: ASC, DESC

  • :sort_by (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
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
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 2005

def list_scheduled_activities(fusion_environment_id, opts = {})
  logger.debug 'Calling operation FusionApplicationsClient#list_scheduled_activities.' if logger

  raise "Missing the required parameter 'fusion_environment_id' when calling list_scheduled_activities." if fusion_environment_id.nil?

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

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

  if opts[:scheduled_activity_phase] && !OCI::FusionApps::Models::ScheduledActivity::SCHEDULED_ACTIVITY_PHASE_ENUM.include?(opts[:scheduled_activity_phase])
    raise 'Invalid value for "scheduled_activity_phase", must be one of the values in OCI::FusionApps::Models::ScheduledActivity::SCHEDULED_ACTIVITY_PHASE_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[TIME_CREATED DISPLAY_NAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME.'
  end
  raise "Parameter value for 'fusion_environment_id' must not be blank" if OCI::Internal::Util.blank_string?(fusion_environment_id)

  path = '/fusionEnvironments/{fusionEnvironmentId}/scheduledActivities'.sub('{fusionEnvironmentId}', fusion_environment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:timeScheduledStartGreaterThanOrEqualTo] = opts[:time_scheduled_start_greater_than_or_equal_to] if opts[:time_scheduled_start_greater_than_or_equal_to]
  query_params[:timeExpectedFinishLessThanOrEqualTo] = opts[:time_expected_finish_less_than_or_equal_to] if opts[:time_expected_finish_less_than_or_equal_to]
  query_params[:runCycle] = opts[:run_cycle] if opts[:run_cycle]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:scheduledActivityAssociationId] = opts[:scheduled_activity_association_id] if opts[:scheduled_activity_association_id]
  query_params[:scheduledActivityPhase] = opts[:scheduled_activity_phase] if opts[:scheduled_activity_phase]
  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: 'FusionApplicationsClient#list_scheduled_activities') 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::FusionApps::Models::ScheduledActivityCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_service_attachments(fusion_environment_id, opts = {}) ⇒ Response

Note:

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

Returns a list of service attachments.

Allowed values are: TIME_CREATED, DISPLAY_NAME

Parameters:

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

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

    the optional parameters

Options Hash (opts):

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

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

  • :display_name (String) —

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

  • :lifecycle_state (String) —

    A filter that returns all resources that match the specified lifecycle state.

  • :service_instance_type (String) —

    A filter that returns all resources that match the specified lifecycle state.

  • :limit (Integer) —

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

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. (default to DESC) Allowed values are: ASC, DESC

  • :sort_by (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 2101

def list_service_attachments(fusion_environment_id, opts = {})
  logger.debug 'Calling operation FusionApplicationsClient#list_service_attachments.' if logger

  raise "Missing the required parameter 'fusion_environment_id' when calling list_service_attachments." if fusion_environment_id.nil?

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

  if opts[:service_instance_type] && !OCI::FusionApps::Models::ServiceAttachment::SERVICE_INSTANCE_TYPE_ENUM.include?(opts[:service_instance_type])
    raise 'Invalid value for "service_instance_type", must be one of the values in OCI::FusionApps::Models::ServiceAttachment::SERVICE_INSTANCE_TYPE_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[TIME_CREATED DISPLAY_NAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME.'
  end
  raise "Parameter value for 'fusion_environment_id' must not be blank" if OCI::Internal::Util.blank_string?(fusion_environment_id)

  path = '/fusionEnvironments/{fusionEnvironmentId}/serviceAttachments'.sub('{fusionEnvironmentId}', fusion_environment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:serviceInstanceType] = opts[:service_instance_type] if opts[:service_instance_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: 'FusionApplicationsClient#list_service_attachments') 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::FusionApps::Models::ServiceAttachmentCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_time_available_for_refreshes(fusion_environment_id, opts = {}) ⇒ Response

Note:

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

Gets available refresh time for this fusion environment Allowed values are: TIME_CREATED, DISPLAY_NAME

Parameters:

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :limit (Integer) —

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

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :sort_order (String) —

    The sort order to use, either 'asc' or 'desc'. (default to DESC) Allowed values are: ASC, DESC

  • :sort_by (String) —

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

Returns:



2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 2185

def list_time_available_for_refreshes(fusion_environment_id, opts = {})
  logger.debug 'Calling operation FusionApplicationsClient#list_time_available_for_refreshes.' if logger

  raise "Missing the required parameter 'fusion_environment_id' when calling list_time_available_for_refreshes." if fusion_environment_id.nil?

  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[TIME_CREATED DISPLAY_NAME].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of TIME_CREATED, DISPLAY_NAME.'
  end
  raise "Parameter value for 'fusion_environment_id' must not be blank" if OCI::Internal::Util.blank_string?(fusion_environment_id)

  path = '/fusionEnvironments/{fusionEnvironmentId}/timeAvailableForRefresh'.sub('{fusionEnvironmentId}', fusion_environment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  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: 'FusionApplicationsClient#list_time_available_for_refreshes') 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::FusionApps::Models::TimeAvailableForRefreshCollection'
    )
  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

  • :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 use, either 'asc' or 'desc'. (default to DESC) Allowed values are: ASC, DESC

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :limit (Integer) —

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

Returns:



2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 2259

def list_work_request_errors(work_request_id, opts = {})
  logger.debug 'Calling operation FusionApplicationsClient#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[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]

  # 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: 'FusionApplicationsClient#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::FusionApps::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) —

    The client request ID for tracing.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :limit (Integer) —

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

  • :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 use, either 'asc' or 'desc'. (default to DESC) Allowed values are: ASC, DESC

Returns:



2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 2333

def list_work_request_logs(work_request_id, opts = {})
  logger.debug 'Calling operation FusionApplicationsClient#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: 'FusionApplicationsClient#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::FusionApps::Models::WorkRequestLogEntryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_work_requests(compartment_id, 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:

  • compartment_id (String) —

    The ID of the compartment in which to list resources.

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

    the optional parameters

Options Hash (opts):

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

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

  • :status (String) —

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

  • :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 use, either 'asc' or 'desc'. (default to DESC) Allowed values are: ASC, DESC

  • :resource_id (String) —

    The ID of the a resource in which to list associated resources.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :page (String) —

    The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

  • :limit (Integer) —

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

Returns:



2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 2409

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

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

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

  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

  path = '/workRequests'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:status] = opts[:status] if opts[:status]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  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]

  # 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: 'FusionApplicationsClient#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::FusionApps::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.



94
95
96
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 94

def logger
  @api_client.config.logger
end

#reset_fusion_environment_password(reset_fusion_environment_password_details, fusion_environment_id, admin_username, opts = {}) ⇒ Response

Note:

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

Reset FusionEnvironment admin password. This API will be deprecated on Mon, 15 Jan 2024 01:00:00 GMT. Users can reset password themselves, FAaaS will no longer provide an API for this.

Parameters:

  • reset_fusion_environment_password_details (OCI::FusionApps::Models::ResetFusionEnvironmentPasswordDetails) —

    The information to be updated.

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

  • admin_username (String) —

    The admin user name for the fusion environment.

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

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



2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 2495

def reset_fusion_environment_password(reset_fusion_environment_password_details, fusion_environment_id, admin_username, opts = {})
  logger.debug 'Calling operation FusionApplicationsClient#reset_fusion_environment_password.' if logger

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

  path = '/fusionEnvironments/{fusionEnvironmentId}/adminUsers/{adminUsername}/actions/resetPassword'.sub('{fusionEnvironmentId}', fusion_environment_id.to_s).sub('{adminUsername}', admin_username.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(reset_fusion_environment_password_details)

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

#update_fusion_environment(fusion_environment_id, update_fusion_environment_details, opts = {}) ⇒ Response

Note:

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

Updates the FusionEnvironment

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 2561

def update_fusion_environment(fusion_environment_id, update_fusion_environment_details, opts = {})
  logger.debug 'Calling operation FusionApplicationsClient#update_fusion_environment.' if logger

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

  path = '/fusionEnvironments/{fusionEnvironmentId}'.sub('{fusionEnvironmentId}', fusion_environment_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(update_fusion_environment_details)

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

#update_fusion_environment_family(fusion_environment_family_id, update_fusion_environment_family_details, opts = {}) ⇒ Response

Note:

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

Updates the FusionEnvironmentFamily

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 2623

def update_fusion_environment_family(fusion_environment_family_id, update_fusion_environment_family_details, opts = {})
  logger.debug 'Calling operation FusionApplicationsClient#update_fusion_environment_family.' if logger

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

  path = '/fusionEnvironmentFamilies/{fusionEnvironmentFamilyId}'.sub('{fusionEnvironmentFamilyId}', fusion_environment_family_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(update_fusion_environment_family_details)

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

#update_refresh_activity(fusion_environment_id, refresh_activity_id, update_refresh_activity_details, opts = {}) ⇒ Response

Note:

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

Updates a scheduled RefreshActivity.

Parameters:

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

  • refresh_activity_id (String) —

    The unique identifier (OCID) of the Refresh activity.

  • update_refresh_activity_details (OCI::FusionApps::Models::UpdateRefreshActivityDetails) —

    Details for the updating scheduled RefreshActivity.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

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



2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 2687

def update_refresh_activity(fusion_environment_id, refresh_activity_id, update_refresh_activity_details, opts = {})
  logger.debug 'Calling operation FusionApplicationsClient#update_refresh_activity.' if logger

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

  path = '/fusionEnvironments/{fusionEnvironmentId}/refreshActivities/{refreshActivityId}'.sub('{fusionEnvironmentId}', fusion_environment_id.to_s).sub('{refreshActivityId}', refresh_activity_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_refresh_activity_details)

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

#verify_service_attachment(verify_service_attachment_details, fusion_environment_id, opts = {}) ⇒ Response

Note:

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

Verify whether a service instance can be attached to the fusion pod

Parameters:

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 2747

def verify_service_attachment(verify_service_attachment_details, fusion_environment_id, opts = {})
  logger.debug 'Calling operation FusionApplicationsClient#verify_service_attachment.' if logger

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

  path = '/fusionEnvironments/{fusionEnvironmentId}/serviceAttachments/actions/verify'.sub('{fusionEnvironmentId}', fusion_environment_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 = @api_client.object_to_http_body(verify_service_attachment_details)

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