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_email_subdomain(fusion_environment_id, marketing_brand_id, create_email_subdomain_details, opts = {}) ⇒ Response

Note:

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

Creates an email Subdomain for a brand

Parameters:

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

  • marketing_brand_id (String) —

    unique brand identifier

  • create_email_subdomain_details (OCI::FusionApps::Models::CreateEmailSubdomainDetails) —

    Details for the new email subdomain

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

Returns:



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
363
364
365
366
367
368
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 327

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

  raise "Missing the required parameter 'fusion_environment_id' when calling create_email_subdomain." if fusion_environment_id.nil?
  raise "Missing the required parameter 'marketing_brand_id' when calling create_email_subdomain." if marketing_brand_id.nil?
  raise "Missing the required parameter 'create_email_subdomain_details' when calling create_email_subdomain." if create_email_subdomain_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 'marketing_brand_id' must not be blank" if OCI::Internal::Util.blank_string?(marketing_brand_id)

  path = '/fusionEnvironments/{fusionEnvironmentId}/marketingBrands/{marketingBrandId}/emailSubdomains'.sub('{fusionEnvironmentId}', fusion_environment_id.to_s).sub('{marketingBrandId}', marketing_brand_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_email_subdomain_details)

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



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
426
427
428
429
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 393

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



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
487
488
489
490
491
492
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 454

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



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

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_marketing_brand(fusion_environment_id, create_marketing_brand_details, opts = {}) ⇒ Response

Note:

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

Creates a marketing brand for fusion environment

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:



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

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

  raise "Missing the required parameter 'fusion_environment_id' when calling create_marketing_brand." if fusion_environment_id.nil?
  raise "Missing the required parameter 'create_marketing_brand_details' when calling create_marketing_brand." if create_marketing_brand_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}/marketingBrands'.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_marketing_brand_details)

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

#create_microsite(fusion_environment_id, marketing_brand_id, create_microsite_details, opts = {}) ⇒ Response

Note:

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

Creates a microsite for brand

Parameters:

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

  • marketing_brand_id (String) —

    unique brand identifier

  • create_microsite_details (OCI::FusionApps::Models::CreateMicrositeDetails) —

    Details for the new microsite

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

    A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing 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:



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
675
676
677
678
679
680
681
682
683
684
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 643

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

  raise "Missing the required parameter 'fusion_environment_id' when calling create_microsite." if fusion_environment_id.nil?
  raise "Missing the required parameter 'marketing_brand_id' when calling create_microsite." if marketing_brand_id.nil?
  raise "Missing the required parameter 'create_microsite_details' when calling create_microsite." if create_microsite_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 'marketing_brand_id' must not be blank" if OCI::Internal::Util.blank_string?(marketing_brand_id)

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

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

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

  post_body = @api_client.object_to_http_body(create_microsite_details)

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



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
738
739
740
741
742
743
744
745
746
747
748
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 710

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



774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 774

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

#create_vanity_domain(create_vanity_domain_details, fusion_environment_id, opts = {}) ⇒ Response

Note:

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

Create a VanityDomain

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:



838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 838

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

  raise "Missing the required parameter 'create_vanity_domain_details' when calling create_vanity_domain." if create_vanity_domain_details.nil?
  raise "Missing the required parameter 'fusion_environment_id' when calling create_vanity_domain." 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}/vanityDomains'.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_vanity_domain_details)

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

#create_vanity_domain_activity(create_vanity_domain_activity_details, fusion_environment_id, opts = {}) ⇒ Response

Note:

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

Create a VanityDomainActivity

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



903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 903

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

  raise "Missing the required parameter 'create_vanity_domain_activity_details' when calling create_vanity_domain_activity." if create_vanity_domain_activity_details.nil?
  raise "Missing the required parameter 'fusion_environment_id' when calling create_vanity_domain_activity." 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}/vanityDomainActivities'.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_vanity_domain_activity_details)

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

#delete_email_subdomain(fusion_environment_id, marketing_brand_id, email_subdomain_id, opts = {}) ⇒ Response

Note:

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

Delete an email subdomain for a brand

Parameters:

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

  • marketing_brand_id (String) —

    unique brand identifier

  • email_subdomain_id (String) —

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



967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 967

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

  raise "Missing the required parameter 'fusion_environment_id' when calling delete_email_subdomain." if fusion_environment_id.nil?
  raise "Missing the required parameter 'marketing_brand_id' when calling delete_email_subdomain." if marketing_brand_id.nil?
  raise "Missing the required parameter 'email_subdomain_id' when calling delete_email_subdomain." if email_subdomain_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 'marketing_brand_id' must not be blank" if OCI::Internal::Util.blank_string?(marketing_brand_id)
  raise "Parameter value for 'email_subdomain_id' must not be blank" if OCI::Internal::Util.blank_string?(email_subdomain_id)

  path = '/fusionEnvironments/{fusionEnvironmentId}/marketingBrands/{marketingBrandId}/emailSubdomains/{emailSubdomainId}'.sub('{fusionEnvironmentId}', fusion_environment_id.to_s).sub('{marketingBrandId}', marketing_brand_id.to_s).sub('{emailSubdomainId}', email_subdomain_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_email_subdomain') 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(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



1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 1031

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



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

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



1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 1154

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_marketing_brand(fusion_environment_id, marketing_brand_id, opts = {}) ⇒ Response

Note:

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

Deletes a Marketing brand for fusion Environment

Parameters:

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

  • marketing_brand_id (String) —

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



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

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

  raise "Missing the required parameter 'fusion_environment_id' when calling delete_marketing_brand." if fusion_environment_id.nil?
  raise "Missing the required parameter 'marketing_brand_id' when calling delete_marketing_brand." if marketing_brand_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 'marketing_brand_id' must not be blank" if OCI::Internal::Util.blank_string?(marketing_brand_id)

  path = '/fusionEnvironments/{fusionEnvironmentId}/marketingBrands/{marketingBrandId}'.sub('{fusionEnvironmentId}', fusion_environment_id.to_s).sub('{marketingBrandId}', marketing_brand_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_marketing_brand') 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_microsite(fusion_environment_id, marketing_brand_id, microsite_id, opts = {}) ⇒ Response

Note:

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

Delete microsite for a brand

Parameters:

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

  • marketing_brand_id (String) —

    unique brand identifier

  • microsite_id (String) —

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



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
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 1279

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

  raise "Missing the required parameter 'fusion_environment_id' when calling delete_microsite." if fusion_environment_id.nil?
  raise "Missing the required parameter 'marketing_brand_id' when calling delete_microsite." if marketing_brand_id.nil?
  raise "Missing the required parameter 'microsite_id' when calling delete_microsite." if microsite_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 'marketing_brand_id' must not be blank" if OCI::Internal::Util.blank_string?(marketing_brand_id)
  raise "Parameter value for 'microsite_id' must not be blank" if OCI::Internal::Util.blank_string?(microsite_id)

  path = '/fusionEnvironments/{fusionEnvironmentId}/marketingBrands/{marketingBrandId}/microsites/{micrositeId}'.sub('{fusionEnvironmentId}', fusion_environment_id.to_s).sub('{marketingBrandId}', marketing_brand_id.to_s).sub('{micrositeId}', microsite_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_microsite') 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



1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 1344

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



1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 1407

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

#delete_vanity_domain_activity(fusion_environment_id, vanity_domain_activity_id, opts = {}) ⇒ Response

Note:

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

Deletes a VanityDomainActivity

Parameters:

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

  • vanity_domain_activity_id (String) —

    The unique identifier (OCID) of the VanityDomainActivity

  • 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



1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 1471

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

  raise "Missing the required parameter 'fusion_environment_id' when calling delete_vanity_domain_activity." if fusion_environment_id.nil?
  raise "Missing the required parameter 'vanity_domain_activity_id' when calling delete_vanity_domain_activity." if vanity_domain_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 'vanity_domain_activity_id' must not be blank" if OCI::Internal::Util.blank_string?(vanity_domain_activity_id)

  path = '/fusionEnvironments/{fusionEnvironmentId}/vanityDomainActivities/{vanityDomainActivityId}'.sub('{fusionEnvironmentId}', fusion_environment_id.to_s).sub('{vanityDomainActivityId}', vanity_domain_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_vanity_domain_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

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



1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 1528

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:



1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 1583

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_email_subdomain(fusion_environment_id, marketing_brand_id, email_subdomain_id, opts = {}) ⇒ Response

Note:

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

Gets an email subdomain for the brand

Parameters:

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

  • marketing_brand_id (String) —

    unique brand identifier

  • email_subdomain_id (String) —

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



1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 1641

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

  raise "Missing the required parameter 'fusion_environment_id' when calling get_email_subdomain." if fusion_environment_id.nil?
  raise "Missing the required parameter 'marketing_brand_id' when calling get_email_subdomain." if marketing_brand_id.nil?
  raise "Missing the required parameter 'email_subdomain_id' when calling get_email_subdomain." if email_subdomain_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 'marketing_brand_id' must not be blank" if OCI::Internal::Util.blank_string?(marketing_brand_id)
  raise "Parameter value for 'email_subdomain_id' must not be blank" if OCI::Internal::Util.blank_string?(email_subdomain_id)

  path = '/fusionEnvironments/{fusionEnvironmentId}/marketingBrands/{marketingBrandId}/emailSubdomains/{emailSubdomainId}'.sub('{fusionEnvironmentId}', fusion_environment_id.to_s).sub('{marketingBrandId}', marketing_brand_id.to_s).sub('{emailSubdomainId}', email_subdomain_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_email_subdomain') 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::EmailSubdomain'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_email_subdomain_csr(fusion_environment_id, marketing_brand_id, email_subdomain_id, opts = {}) ⇒ Response

Note:

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

Gets a CSR for email subdomain for a brand

Parameters:

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

  • marketing_brand_id (String) —

    unique brand identifier

  • email_subdomain_id (String) —

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



1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 1701

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

  raise "Missing the required parameter 'fusion_environment_id' when calling get_email_subdomain_csr." if fusion_environment_id.nil?
  raise "Missing the required parameter 'marketing_brand_id' when calling get_email_subdomain_csr." if marketing_brand_id.nil?
  raise "Missing the required parameter 'email_subdomain_id' when calling get_email_subdomain_csr." if email_subdomain_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 'marketing_brand_id' must not be blank" if OCI::Internal::Util.blank_string?(marketing_brand_id)
  raise "Parameter value for 'email_subdomain_id' must not be blank" if OCI::Internal::Util.blank_string?(email_subdomain_id)

  path = '/fusionEnvironments/{fusionEnvironmentId}/marketingBrands/{marketingBrandId}/emailSubdomains/{emailSubdomainId}/csr'.sub('{fusionEnvironmentId}', fusion_environment_id.to_s).sub('{marketingBrandId}', marketing_brand_id.to_s).sub('{emailSubdomainId}', email_subdomain_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_email_subdomain_csr') 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::MarketingBrandEmailSubdomainCsr'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_email_subdomain_dns_config(fusion_environment_id, marketing_brand_id, email_subdomain_id, opts = {}) ⇒ Response

Note:

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

Get all DNS records for emailSubdomain

Parameters:

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

  • marketing_brand_id (String) —

    unique brand identifier

  • email_subdomain_id (String) —

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



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

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

  raise "Missing the required parameter 'fusion_environment_id' when calling get_email_subdomain_dns_config." if fusion_environment_id.nil?
  raise "Missing the required parameter 'marketing_brand_id' when calling get_email_subdomain_dns_config." if marketing_brand_id.nil?
  raise "Missing the required parameter 'email_subdomain_id' when calling get_email_subdomain_dns_config." if email_subdomain_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 'marketing_brand_id' must not be blank" if OCI::Internal::Util.blank_string?(marketing_brand_id)
  raise "Parameter value for 'email_subdomain_id' must not be blank" if OCI::Internal::Util.blank_string?(email_subdomain_id)

  path = '/fusionEnvironments/{fusionEnvironmentId}/marketingBrands/{marketingBrandId}/emailSubdomains/{emailSubdomainId}/dnsConfig'.sub('{fusionEnvironmentId}', fusion_environment_id.to_s).sub('{marketingBrandId}', marketing_brand_id.to_s).sub('{emailSubdomainId}', email_subdomain_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_email_subdomain_dns_config') 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::MarketingBrandEmailSubdomainDnsConfig'
    )
  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:



1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
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
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 1819

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:



1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 1873

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:



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

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:



1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 1981

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:



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

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_marketing_brand(fusion_environment_id, marketing_brand_id, opts = {}) ⇒ Response

Note:

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

Gets a Marketing Brand by identifier

Parameters:

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

  • marketing_brand_id (String) —

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



2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 2090

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

  raise "Missing the required parameter 'fusion_environment_id' when calling get_marketing_brand." if fusion_environment_id.nil?
  raise "Missing the required parameter 'marketing_brand_id' when calling get_marketing_brand." if marketing_brand_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 'marketing_brand_id' must not be blank" if OCI::Internal::Util.blank_string?(marketing_brand_id)

  path = '/fusionEnvironments/{fusionEnvironmentId}/marketingBrands/{marketingBrandId}'.sub('{fusionEnvironmentId}', fusion_environment_id.to_s).sub('{marketingBrandId}', marketing_brand_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_marketing_brand') 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::MarketingBrand'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_microsite(fusion_environment_id, marketing_brand_id, microsite_id, opts = {}) ⇒ Response

Note:

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

Get the microsite for the brand

Parameters:

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

  • marketing_brand_id (String) —

    unique brand identifier

  • microsite_id (String) —

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



2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 2148

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

  raise "Missing the required parameter 'fusion_environment_id' when calling get_microsite." if fusion_environment_id.nil?
  raise "Missing the required parameter 'marketing_brand_id' when calling get_microsite." if marketing_brand_id.nil?
  raise "Missing the required parameter 'microsite_id' when calling get_microsite." if microsite_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 'marketing_brand_id' must not be blank" if OCI::Internal::Util.blank_string?(marketing_brand_id)
  raise "Parameter value for 'microsite_id' must not be blank" if OCI::Internal::Util.blank_string?(microsite_id)

  path = '/fusionEnvironments/{fusionEnvironmentId}/marketingBrands/{marketingBrandId}/microsites/{micrositeId}'.sub('{fusionEnvironmentId}', fusion_environment_id.to_s).sub('{marketingBrandId}', marketing_brand_id.to_s).sub('{micrositeId}', microsite_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_microsite') 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::Microsite'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_microsite_dns_config(fusion_environment_id, marketing_brand_id, microsite_id, opts = {}) ⇒ Response

Note:

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

Get DNS records for microsite

Parameters:

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

  • marketing_brand_id (String) —

    unique brand identifier

  • microsite_id (String) —

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



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
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 2208

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

  raise "Missing the required parameter 'fusion_environment_id' when calling get_microsite_dns_config." if fusion_environment_id.nil?
  raise "Missing the required parameter 'marketing_brand_id' when calling get_microsite_dns_config." if marketing_brand_id.nil?
  raise "Missing the required parameter 'microsite_id' when calling get_microsite_dns_config." if microsite_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 'marketing_brand_id' must not be blank" if OCI::Internal::Util.blank_string?(marketing_brand_id)
  raise "Parameter value for 'microsite_id' must not be blank" if OCI::Internal::Util.blank_string?(microsite_id)

  path = '/fusionEnvironments/{fusionEnvironmentId}/marketingBrands/{marketingBrandId}/microsites/{micrositeId}/dnsConfig'.sub('{fusionEnvironmentId}', fusion_environment_id.to_s).sub('{marketingBrandId}', marketing_brand_id.to_s).sub('{micrositeId}', microsite_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_microsite_dns_config') 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::MarketingBrandMicrositeDnsConfig'
    )
  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:



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

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:



2324
2325
2326
2327
2328
2329
2330
2331
2332
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
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 2324

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:



2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 2381

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_vanity_domain(fusion_environment_id, vanity_domain_id, opts = {}) ⇒ Response

Note:

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

Gets a VanityDomain

Parameters:

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

  • vanity_domain_id (String) —

    The unique identifier (OCID) of the VanityDomain

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

  • :does_download_origin_csr (BOOLEAN) —

    A parameter indicating whether to download the Origin Csr or not

  • :does_download_akamai_csr (BOOLEAN) —

    A parameter indicating whether to download the Akamai Csr or not

Returns:



2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 2441

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

  raise "Missing the required parameter 'fusion_environment_id' when calling get_vanity_domain." if fusion_environment_id.nil?
  raise "Missing the required parameter 'vanity_domain_id' when calling get_vanity_domain." if vanity_domain_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 'vanity_domain_id' must not be blank" if OCI::Internal::Util.blank_string?(vanity_domain_id)

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

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:doesDownloadOriginCsr] = opts[:does_download_origin_csr] if !opts[:does_download_origin_csr].nil?
  query_params[:doesDownloadAkamaiCsr] = opts[:does_download_akamai_csr] if !opts[:does_download_akamai_csr].nil?

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

  post_body = nil

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

#get_vanity_domain_activity(fusion_environment_id, vanity_domain_activity_id, opts = {}) ⇒ Response

Note:

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

Gets a VanityDomainActivity

Parameters:

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

  • vanity_domain_activity_id (String) —

    The unique identifier (OCID) of the VanityDomainActivity

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



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

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

  raise "Missing the required parameter 'fusion_environment_id' when calling get_vanity_domain_activity." if fusion_environment_id.nil?
  raise "Missing the required parameter 'vanity_domain_activity_id' when calling get_vanity_domain_activity." if vanity_domain_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 'vanity_domain_activity_id' must not be blank" if OCI::Internal::Util.blank_string?(vanity_domain_activity_id)

  path = '/fusionEnvironments/{fusionEnvironmentId}/vanityDomainActivities/{vanityDomainActivityId}'.sub('{fusionEnvironmentId}', fusion_environment_id.to_s).sub('{vanityDomainActivityId}', vanity_domain_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_vanity_domain_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::VanityDomainActivity'
    )
  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:



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

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



2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
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
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 2612

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:



2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 2665

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:



2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
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
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 2728

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_email_subdomains(fusion_environment_id, marketing_brand_id, opts = {}) ⇒ Response

Note:

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

Returns a list of email subdomains for a brand Allowed values are: TIME_CREATED, NAME, ID

Parameters:

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

  • marketing_brand_id (String) —

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

  • :email_subdomain_id (String) —

    unique emailSubdomain identifier

  • :name (String) —

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

  • :lifecycle_state (String) —

    A filter that returns all resources that match the specified status

  • :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 name is ascending. If no value is specified timeCreated is default. (default to TIME_CREATED)

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 2810

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

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

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

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

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

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

  post_body = nil

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



2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 2896

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:



2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 2980

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_marketing_brands(fusion_environment_id, opts = {}) ⇒ Response

Note:

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

Returns a list of marketing brands Allowed values are: TIME_CREATED, NAME, ID

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

  • :marketing_brand_id (String) —

    unique brand identifier

  • :name (String) —

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

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



3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 3063

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

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

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

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

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:marketingBrandId] = opts[:marketing_brand_id] if opts[:marketing_brand_id]
  query_params[:name] = opts[:name] if opts[: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_marketing_brands') 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::MarketingBrandCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_microsites(fusion_environment_id, marketing_brand_id, opts = {}) ⇒ Response

Note:

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

Returns a list of microsites Allowed values are: TIME_CREATED, NAME, ID

Parameters:

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

  • marketing_brand_id (String) —

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

  • :microsite_id (String) —

    unique microsite identifier

  • :name (String) —

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

  • :lifecycle_state (String) —

    A filter that returns all resources that match the specified status

  • :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 name is ascending. If no value is specified timeCreated is default. (default to TIME_CREATED)

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 3147

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

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

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

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

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

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

  post_body = nil

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



3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 3234

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:



3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 3323

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:



3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 3419

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:



3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 3503

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_vanity_domains(fusion_environment_id, compartment_id, is_full_vanity_domain, opts = {}) ⇒ Response

Note:

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

Lists all VanityDomains.

Allowed values are: TIME_CREATED, DISPLAY_NAME

Parameters:

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

  • compartment_id (String) —

    The ID of the compartment in which to list resources.

  • is_full_vanity_domain (BOOLEAN) —

    The boolean filter to distinguish prefix or full vanity

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

    the optional parameters

Options Hash (opts):

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

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

  • :limit (Integer) —

    The maximum number of items to return. (default to 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:



3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 3579

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

  raise "Missing the required parameter 'fusion_environment_id' when calling list_vanity_domains." if fusion_environment_id.nil?
  raise "Missing the required parameter 'compartment_id' when calling list_vanity_domains." if compartment_id.nil?
  raise "Missing the required parameter 'is_full_vanity_domain' when calling list_vanity_domains." if is_full_vanity_domain.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}/vanityDomains'.sub('{fusionEnvironmentId}', fusion_environment_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:isFullVanityDomain] = is_full_vanity_domain
  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_vanity_domains') 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::VanityDomainCollection'
    )
  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:



3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 3657

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:



3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 3731

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:



3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 3807

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

#request_email_subdomain_csr(fusion_environment_id, marketing_brand_id, email_subdomain_id, request_email_subdomain_csr_details, opts = {}) ⇒ Response

Note:

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

Request Email Subdomain CSR

Parameters:

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

  • marketing_brand_id (String) —

    unique brand identifier

  • email_subdomain_id (String) —

    unique emailSubdomain identifier

  • request_email_subdomain_csr_details (OCI::FusionApps::Models::RequestEmailSubdomainCsrDetails) —

    Request CSR for email subdomain

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



3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 3888

def request_email_subdomain_csr(fusion_environment_id, marketing_brand_id, email_subdomain_id, request_email_subdomain_csr_details, opts = {})
  logger.debug 'Calling operation FusionApplicationsClient#request_email_subdomain_csr.' if logger

  raise "Missing the required parameter 'fusion_environment_id' when calling request_email_subdomain_csr." if fusion_environment_id.nil?
  raise "Missing the required parameter 'marketing_brand_id' when calling request_email_subdomain_csr." if marketing_brand_id.nil?
  raise "Missing the required parameter 'email_subdomain_id' when calling request_email_subdomain_csr." if email_subdomain_id.nil?
  raise "Missing the required parameter 'request_email_subdomain_csr_details' when calling request_email_subdomain_csr." if request_email_subdomain_csr_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 'marketing_brand_id' must not be blank" if OCI::Internal::Util.blank_string?(marketing_brand_id)
  raise "Parameter value for 'email_subdomain_id' must not be blank" if OCI::Internal::Util.blank_string?(email_subdomain_id)

  path = '/fusionEnvironments/{fusionEnvironmentId}/marketingBrands/{marketingBrandId}/emailSubdomains/{emailSubdomainId}/actions/requestEmailSubdomainCsr'.sub('{fusionEnvironmentId}', fusion_environment_id.to_s).sub('{marketingBrandId}', marketing_brand_id.to_s).sub('{emailSubdomainId}', email_subdomain_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(request_email_subdomain_csr_details)

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



3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 3962

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

#submit_vanity_domain_validation(vanity_domain_id, fusion_environment_id, opts = {}) ⇒ Response

Note:

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

Submit Vanity Domain Validation

Parameters:

  • vanity_domain_id (String) —

    The unique identifier (OCID) of the VanityDomain

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

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



4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 4029

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

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

  path = '/fusionEnvironments/{fusionEnvironmentId}/vanityDomains/{vanityDomainId}/actions/submitValidation'.sub('{vanityDomainId}', vanity_domain_id.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[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  # rubocop:enable Style/NegatedIf

  post_body = nil

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

Note:

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

Updates an email subdomain

Parameters:

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

  • marketing_brand_id (String) —

    unique brand identifier

  • email_subdomain_id (String) —

    unique emailSubdomain identifier

  • update_email_subdomain_details (OCI::FusionApps::Models::UpdateEmailSubdomainDetails) —

    The information to be updated.

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



4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 4094

def update_email_subdomain(fusion_environment_id, marketing_brand_id, email_subdomain_id, update_email_subdomain_details, opts = {})
  logger.debug 'Calling operation FusionApplicationsClient#update_email_subdomain.' if logger

  raise "Missing the required parameter 'fusion_environment_id' when calling update_email_subdomain." if fusion_environment_id.nil?
  raise "Missing the required parameter 'marketing_brand_id' when calling update_email_subdomain." if marketing_brand_id.nil?
  raise "Missing the required parameter 'email_subdomain_id' when calling update_email_subdomain." if email_subdomain_id.nil?
  raise "Missing the required parameter 'update_email_subdomain_details' when calling update_email_subdomain." if update_email_subdomain_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 'marketing_brand_id' must not be blank" if OCI::Internal::Util.blank_string?(marketing_brand_id)
  raise "Parameter value for 'email_subdomain_id' must not be blank" if OCI::Internal::Util.blank_string?(email_subdomain_id)

  path = '/fusionEnvironments/{fusionEnvironmentId}/marketingBrands/{marketingBrandId}/emailSubdomains/{emailSubdomainId}'.sub('{fusionEnvironmentId}', fusion_environment_id.to_s).sub('{marketingBrandId}', marketing_brand_id.to_s).sub('{emailSubdomainId}', email_subdomain_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_email_subdomain_details)

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



4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 4161

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



4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 4223

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_marketing_brand(fusion_environment_id, marketing_brand_id, update_marketing_brand_details, opts = {}) ⇒ Response

Note:

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

Updates a Marketing Brand

Parameters:

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

  • marketing_brand_id (String) —

    unique brand identifier

  • update_marketing_brand_details (OCI::FusionApps::Models::UpdateMarketingBrandDetails) —

    The information to be updated.

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



4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 4286

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

  raise "Missing the required parameter 'fusion_environment_id' when calling update_marketing_brand." if fusion_environment_id.nil?
  raise "Missing the required parameter 'marketing_brand_id' when calling update_marketing_brand." if marketing_brand_id.nil?
  raise "Missing the required parameter 'update_marketing_brand_details' when calling update_marketing_brand." if update_marketing_brand_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 'marketing_brand_id' must not be blank" if OCI::Internal::Util.blank_string?(marketing_brand_id)

  path = '/fusionEnvironments/{fusionEnvironmentId}/marketingBrands/{marketingBrandId}'.sub('{fusionEnvironmentId}', fusion_environment_id.to_s).sub('{marketingBrandId}', marketing_brand_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_marketing_brand_details)

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

#update_microsite(fusion_environment_id, marketing_brand_id, microsite_id, update_microsite_details, opts = {}) ⇒ Response

Note:

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

Updates an microsite

Parameters:

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

  • marketing_brand_id (String) —

    unique brand identifier

  • microsite_id (String) —

    unique microsite identifier

  • update_microsite_details (OCI::FusionApps::Models::UpdateMicrositeDetails) —

    The information to be updated.

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



4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 4353

def update_microsite(fusion_environment_id, marketing_brand_id, microsite_id, update_microsite_details, opts = {})
  logger.debug 'Calling operation FusionApplicationsClient#update_microsite.' if logger

  raise "Missing the required parameter 'fusion_environment_id' when calling update_microsite." if fusion_environment_id.nil?
  raise "Missing the required parameter 'marketing_brand_id' when calling update_microsite." if marketing_brand_id.nil?
  raise "Missing the required parameter 'microsite_id' when calling update_microsite." if microsite_id.nil?
  raise "Missing the required parameter 'update_microsite_details' when calling update_microsite." if update_microsite_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 'marketing_brand_id' must not be blank" if OCI::Internal::Util.blank_string?(marketing_brand_id)
  raise "Parameter value for 'microsite_id' must not be blank" if OCI::Internal::Util.blank_string?(microsite_id)

  path = '/fusionEnvironments/{fusionEnvironmentId}/marketingBrands/{marketingBrandId}/microsites/{micrositeId}'.sub('{fusionEnvironmentId}', fusion_environment_id.to_s).sub('{marketingBrandId}', marketing_brand_id.to_s).sub('{micrositeId}', microsite_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_microsite_details)

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



4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 4422

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

#update_vanity_domain(fusion_environment_id, vanity_domain_id, update_vanity_domain_details, opts = {}) ⇒ Response

Note:

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

Updates a VanityDomain

Parameters:

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

  • vanity_domain_id (String) —

    The unique identifier (OCID) of the VanityDomain

  • update_vanity_domain_details (OCI::FusionApps::Models::UpdateVanityDomainDetails) —

    Details for the updating scheduled VanityDomain

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

  • (Response) —

    A Response object with data of type nil



4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 4489

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

  raise "Missing the required parameter 'fusion_environment_id' when calling update_vanity_domain." if fusion_environment_id.nil?
  raise "Missing the required parameter 'vanity_domain_id' when calling update_vanity_domain." if vanity_domain_id.nil?
  raise "Missing the required parameter 'update_vanity_domain_details' when calling update_vanity_domain." if update_vanity_domain_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 'vanity_domain_id' must not be blank" if OCI::Internal::Util.blank_string?(vanity_domain_id)

  path = '/fusionEnvironments/{fusionEnvironmentId}/vanityDomains/{vanityDomainId}'.sub('{fusionEnvironmentId}', fusion_environment_id.to_s).sub('{vanityDomainId}', vanity_domain_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_vanity_domain_details)

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

Note:

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

Updates a VanityDomainActivity

Parameters:

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

  • vanity_domain_activity_id (String) —

    The unique identifier (OCID) of the VanityDomainActivity

  • update_vanity_domain_activity_details (OCI::FusionApps::Models::UpdateVanityDomainActivityDetails) —

    Details for the updating scheduled VanityDomainActivity

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

  • (Response) —

    A Response object with data of type nil



4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 4555

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

  raise "Missing the required parameter 'fusion_environment_id' when calling update_vanity_domain_activity." if fusion_environment_id.nil?
  raise "Missing the required parameter 'vanity_domain_activity_id' when calling update_vanity_domain_activity." if vanity_domain_activity_id.nil?
  raise "Missing the required parameter 'update_vanity_domain_activity_details' when calling update_vanity_domain_activity." if update_vanity_domain_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 'vanity_domain_activity_id' must not be blank" if OCI::Internal::Util.blank_string?(vanity_domain_activity_id)

  path = '/fusionEnvironments/{fusionEnvironmentId}/vanityDomainActivities/{vanityDomainActivityId}'.sub('{fusionEnvironmentId}', fusion_environment_id.to_s).sub('{vanityDomainActivityId}', vanity_domain_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_vanity_domain_activity_details)

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

#upload_email_subdomain_certificate(fusion_environment_id, marketing_brand_id, email_subdomain_id, upload_email_subdomain_certificate_details, opts = {}) ⇒ Response

Note:

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

upload certificate for emailSubdomain

Parameters:

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

  • marketing_brand_id (String) —

    unique brand identifier

  • email_subdomain_id (String) —

    unique emailSubdomain identifier

  • upload_email_subdomain_certificate_details (OCI::FusionApps::Models::UploadEmailSubdomainCertificateDetails) —

    Certificate for email subdomain

  • 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



4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 4621

def upload_email_subdomain_certificate(fusion_environment_id, marketing_brand_id, email_subdomain_id, upload_email_subdomain_certificate_details, opts = {})
  logger.debug 'Calling operation FusionApplicationsClient#upload_email_subdomain_certificate.' if logger

  raise "Missing the required parameter 'fusion_environment_id' when calling upload_email_subdomain_certificate." if fusion_environment_id.nil?
  raise "Missing the required parameter 'marketing_brand_id' when calling upload_email_subdomain_certificate." if marketing_brand_id.nil?
  raise "Missing the required parameter 'email_subdomain_id' when calling upload_email_subdomain_certificate." if email_subdomain_id.nil?
  raise "Missing the required parameter 'upload_email_subdomain_certificate_details' when calling upload_email_subdomain_certificate." if upload_email_subdomain_certificate_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 'marketing_brand_id' must not be blank" if OCI::Internal::Util.blank_string?(marketing_brand_id)
  raise "Parameter value for 'email_subdomain_id' must not be blank" if OCI::Internal::Util.blank_string?(email_subdomain_id)

  path = '/fusionEnvironments/{fusionEnvironmentId}/marketingBrands/{marketingBrandId}/emailSubdomains/{emailSubdomainId}/actions/uploadEmailSubdomainCertificate'.sub('{fusionEnvironmentId}', fusion_environment_id.to_s).sub('{marketingBrandId}', marketing_brand_id.to_s).sub('{emailSubdomainId}', email_subdomain_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(upload_email_subdomain_certificate_details)

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

#upload_vanity_domain_certificate(upload_vanity_domain_certificate_details, vanity_domain_id, fusion_environment_id, opts = {}) ⇒ Response

Note:

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

Upload Vanity Domain certificate

Parameters:

  • upload_vanity_domain_certificate_details (OCI::FusionApps::Models::UploadVanityDomainCertificateDetails) —

    The Certificate Details of Vanity Domain to be uploaded

  • vanity_domain_id (String) —

    The unique identifier (OCID) of the VanityDomain

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

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



4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 4689

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

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

  path = '/fusionEnvironments/{fusionEnvironmentId}/vanityDomains/{vanityDomainId}/actions/uploadCertificate'.sub('{vanityDomainId}', vanity_domain_id.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[:'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(upload_vanity_domain_certificate_details)

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

#validate_and_configure_email_subdomain_certificate(fusion_environment_id, marketing_brand_id, email_subdomain_id, opts = {}) ⇒ Response

Note:

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

Validate and configure certificate for emailSubdomain

Parameters:

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

  • marketing_brand_id (String) —

    unique brand identifier

  • email_subdomain_id (String) —

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



4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 4754

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

  raise "Missing the required parameter 'fusion_environment_id' when calling validate_and_configure_email_subdomain_certificate." if fusion_environment_id.nil?
  raise "Missing the required parameter 'marketing_brand_id' when calling validate_and_configure_email_subdomain_certificate." if marketing_brand_id.nil?
  raise "Missing the required parameter 'email_subdomain_id' when calling validate_and_configure_email_subdomain_certificate." if email_subdomain_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 'marketing_brand_id' must not be blank" if OCI::Internal::Util.blank_string?(marketing_brand_id)
  raise "Parameter value for 'email_subdomain_id' must not be blank" if OCI::Internal::Util.blank_string?(email_subdomain_id)

  path = '/fusionEnvironments/{fusionEnvironmentId}/marketingBrands/{marketingBrandId}/emailSubdomains/{emailSubdomainId}/actions/validateAndConfigureCertificate'.sub('{fusionEnvironmentId}', fusion_environment_id.to_s).sub('{marketingBrandId}', marketing_brand_id.to_s).sub('{emailSubdomainId}', email_subdomain_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#validate_and_configure_email_subdomain_certificate') 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

#validate_and_configure_email_subdomain_dns(fusion_environment_id, marketing_brand_id, email_subdomain_id, opts = {}) ⇒ Response

Note:

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

Validate and configure DNS records for emailSubdomain

Parameters:

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

  • marketing_brand_id (String) —

    unique brand identifier

  • email_subdomain_id (String) —

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



4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 4820

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

  raise "Missing the required parameter 'fusion_environment_id' when calling validate_and_configure_email_subdomain_dns." if fusion_environment_id.nil?
  raise "Missing the required parameter 'marketing_brand_id' when calling validate_and_configure_email_subdomain_dns." if marketing_brand_id.nil?
  raise "Missing the required parameter 'email_subdomain_id' when calling validate_and_configure_email_subdomain_dns." if email_subdomain_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 'marketing_brand_id' must not be blank" if OCI::Internal::Util.blank_string?(marketing_brand_id)
  raise "Parameter value for 'email_subdomain_id' must not be blank" if OCI::Internal::Util.blank_string?(email_subdomain_id)

  path = '/fusionEnvironments/{fusionEnvironmentId}/marketingBrands/{marketingBrandId}/emailSubdomains/{emailSubdomainId}/actions/validateAndConfigureDns'.sub('{fusionEnvironmentId}', fusion_environment_id.to_s).sub('{marketingBrandId}', marketing_brand_id.to_s).sub('{emailSubdomainId}', email_subdomain_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#validate_and_configure_email_subdomain_dns') 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

#validate_and_configure_microsite_dns(fusion_environment_id, marketing_brand_id, microsite_id, opts = {}) ⇒ Response

Note:

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

Validate and configure DNS records for microsite

Parameters:

  • fusion_environment_id (String) —

    unique FusionEnvironment identifier

  • marketing_brand_id (String) —

    unique brand identifier

  • microsite_id (String) —

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



4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 4886

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

  raise "Missing the required parameter 'fusion_environment_id' when calling validate_and_configure_microsite_dns." if fusion_environment_id.nil?
  raise "Missing the required parameter 'marketing_brand_id' when calling validate_and_configure_microsite_dns." if marketing_brand_id.nil?
  raise "Missing the required parameter 'microsite_id' when calling validate_and_configure_microsite_dns." if microsite_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 'marketing_brand_id' must not be blank" if OCI::Internal::Util.blank_string?(marketing_brand_id)
  raise "Parameter value for 'microsite_id' must not be blank" if OCI::Internal::Util.blank_string?(microsite_id)

  path = '/fusionEnvironments/{fusionEnvironmentId}/marketingBrands/{marketingBrandId}/microsites/{micrositeId}/actions/validateAndConfigureDns'.sub('{fusionEnvironmentId}', fusion_environment_id.to_s).sub('{marketingBrandId}', marketing_brand_id.to_s).sub('{micrositeId}', microsite_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#validate_and_configure_microsite_dns') 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

#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



4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
 
# File 'lib/oci/fusion_apps/fusion_applications_client.rb', line 4946

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