Class: OCI::FleetAppsManagement::FleetAppsManagementAdminClient

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ FleetAppsManagementAdminClient

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

This client is not thread-safe

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

Parameters:

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

    A Config object.

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

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

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

    The fully qualified endpoint URL

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

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

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

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

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

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



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

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

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

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

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

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



15
16
17
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_admin_client.rb', line 15

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_admin_client.rb', line 19

def endpoint
  @endpoint
end

#region ⇒ String

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

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_admin_client.rb', line 29

def region
  @region
end

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

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

Returns:



25
26
27
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_admin_client.rb', line 25

def retry_config
  @retry_config
end

Instance Method Details

#change_platform_configuration_compartment(platform_configuration_id, change_platform_configuration_compartment_details, opts = {}) ⇒ Response

Note:

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

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

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



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

def change_platform_configuration_compartment(platform_configuration_id, change_platform_configuration_compartment_details, opts = {})
  logger.debug 'Calling operation FleetAppsManagementAdminClient#change_platform_configuration_compartment.' if logger

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

  path = '/platformConfigurations/{platformConfigurationId}/actions/changeCompartment'.sub('{platformConfigurationId}', platform_configuration_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_platform_configuration_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'FleetAppsManagementAdminClient#change_platform_configuration_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_property_compartment(property_id, change_property_compartment_details, opts = {}) ⇒ Response

Note:

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

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

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



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/fleet_apps_management/fleet_apps_management_admin_client.rb', line 198

def change_property_compartment(property_id, change_property_compartment_details, opts = {})
  logger.debug 'Calling operation FleetAppsManagementAdminClient#change_property_compartment.' if logger

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

  path = '/properties/{propertyId}/actions/changeCompartment'.sub('{propertyId}', property_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_property_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'FleetAppsManagementAdminClient#change_property_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_compliance_policy_rule(create_compliance_policy_rule_details, opts = {}) ⇒ Response

Note:

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

Creates a compliance policy rule.

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:



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

def create_compliance_policy_rule(create_compliance_policy_rule_details, opts = {})
  logger.debug 'Calling operation FleetAppsManagementAdminClient#create_compliance_policy_rule.' if logger

  raise "Missing the required parameter 'create_compliance_policy_rule_details' when calling create_compliance_policy_rule." if create_compliance_policy_rule_details.nil?

  path = '/compliancePolicyRules'
  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_compliance_policy_rule_details)

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

#create_onboarding(create_onboarding_details, opts = {}) ⇒ Response

Note:

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

Onboard a tenant to Fleet Application Management. The onboarding process lets Fleet Application Management create a few required policies that you need to start using it and its features.

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:



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

def create_onboarding(create_onboarding_details, opts = {})
  logger.debug 'Calling operation FleetAppsManagementAdminClient#create_onboarding.' if logger

  raise "Missing the required parameter 'create_onboarding_details' when calling create_onboarding." if create_onboarding_details.nil?

  path = '/onboardings'
  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_onboarding_details)

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

#create_platform_configuration(create_platform_configuration_details, opts = {}) ⇒ Response

Note:

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

Creates a new PlatformConfiguration.

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:



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

def create_platform_configuration(create_platform_configuration_details, opts = {})
  logger.debug 'Calling operation FleetAppsManagementAdminClient#create_platform_configuration.' if logger

  raise "Missing the required parameter 'create_platform_configuration_details' when calling create_platform_configuration." if create_platform_configuration_details.nil?

  path = '/platformConfigurations'
  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_platform_configuration_details)

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

#create_property(create_property_details, opts = {}) ⇒ Response

Note:

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

Create a business-specific metadata property in Fleet Application Management.

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:



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

def create_property(create_property_details, opts = {})
  logger.debug 'Calling operation FleetAppsManagementAdminClient#create_property.' if logger

  raise "Missing the required parameter 'create_property_details' when calling create_property." if create_property_details.nil?

  path = '/properties'
  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_property_details)

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

#delete_compliance_policy_rule(compliance_policy_rule_id, opts = {}) ⇒ Response

Note:

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

Deletes a compliance policy rule specified by an identifier.

Parameters:

  • compliance_policy_rule_id (String) —

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



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

def delete_compliance_policy_rule(compliance_policy_rule_id, opts = {})
  logger.debug 'Calling operation FleetAppsManagementAdminClient#delete_compliance_policy_rule.' if logger

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

  path = '/compliancePolicyRules/{compliancePolicyRuleId}'.sub('{compliancePolicyRuleId}', compliance_policy_rule_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: 'FleetAppsManagementAdminClient#delete_compliance_policy_rule') 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_onboarding(onboarding_id, opts = {}) ⇒ Response

Note:

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

Deletes Fleet Application Management onboarding resource by identifier

Parameters:

  • onboarding_id (String) —

    A filter to return resources whose Onboarding identifier matches the given 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



570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_admin_client.rb', line 570

def delete_onboarding(onboarding_id, opts = {})
  logger.debug 'Calling operation FleetAppsManagementAdminClient#delete_onboarding.' if logger

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

  path = '/onboardings/{onboardingId}'.sub('{onboardingId}', onboarding_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: 'FleetAppsManagementAdminClient#delete_onboarding') 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_platform_configuration(platform_configuration_id, opts = {}) ⇒ Response

Note:

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

Deletes a PlatformConfiguration resource by identifier

Parameters:

  • platform_configuration_id (String) —

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



630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_admin_client.rb', line 630

def delete_platform_configuration(platform_configuration_id, opts = {})
  logger.debug 'Calling operation FleetAppsManagementAdminClient#delete_platform_configuration.' if logger

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

  path = '/platformConfigurations/{platformConfigurationId}'.sub('{platformConfigurationId}', platform_configuration_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: 'FleetAppsManagementAdminClient#delete_platform_configuration') 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_property(property_id, opts = {}) ⇒ Response

Note:

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

Delete a property in Fleet Application Management.

Parameters:

  • property_id (String) —

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



690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_admin_client.rb', line 690

def delete_property(property_id, opts = {})
  logger.debug 'Calling operation FleetAppsManagementAdminClient#delete_property.' if logger

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

  path = '/properties/{propertyId}'.sub('{propertyId}', property_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: 'FleetAppsManagementAdminClient#delete_property') 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

#enable_latest_policy(onboarding_id, enable_latest_policy_details, opts = {}) ⇒ Response

Note:

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

Enable Policies for a newer version of Fleet Application Management

Parameters:

  • onboarding_id (String) —

    A filter to return resources whose Onboarding identifier matches the given identifier.

  • enable_latest_policy_details (OCI::FleetAppsManagement::Models::EnableLatestPolicyDetails) —

    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.

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



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

def enable_latest_policy(onboarding_id, enable_latest_policy_details, opts = {})
  logger.debug 'Calling operation FleetAppsManagementAdminClient#enable_latest_policy.' if logger

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

  path = '/onboardings/{onboardingId}/actions/enableLatestPolicy'.sub('{onboardingId}', onboarding_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(enable_latest_policy_details)

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

#get_compliance_policy(compliance_policy_id, opts = {}) ⇒ Response

Note:

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

Gets information about a compliance policy.

Parameters:

  • compliance_policy_id (String) —

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



814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_admin_client.rb', line 814

def get_compliance_policy(compliance_policy_id, opts = {})
  logger.debug 'Calling operation FleetAppsManagementAdminClient#get_compliance_policy.' if logger

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

  path = '/compliancePolicies/{compliancePolicyId}'.sub('{compliancePolicyId}', compliance_policy_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: 'FleetAppsManagementAdminClient#get_compliance_policy') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::FleetAppsManagement::Models::CompliancePolicy'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_compliance_policy_rule(compliance_policy_rule_id, opts = {}) ⇒ Response

Note:

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

Gets information about a compliance policy rule.

Parameters:

  • compliance_policy_rule_id (String) —

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



868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_admin_client.rb', line 868

def get_compliance_policy_rule(compliance_policy_rule_id, opts = {})
  logger.debug 'Calling operation FleetAppsManagementAdminClient#get_compliance_policy_rule.' if logger

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

  path = '/compliancePolicyRules/{compliancePolicyRuleId}'.sub('{compliancePolicyRuleId}', compliance_policy_rule_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: 'FleetAppsManagementAdminClient#get_compliance_policy_rule') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::FleetAppsManagement::Models::CompliancePolicyRule'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_onboarding(onboarding_id, opts = {}) ⇒ Response

Note:

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

Gets a Fleet Application Management Onboarding by identifier.

Parameters:

  • onboarding_id (String) —

    A filter to return resources whose Onboarding identifier matches the given 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:



922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_admin_client.rb', line 922

def get_onboarding(onboarding_id, opts = {})
  logger.debug 'Calling operation FleetAppsManagementAdminClient#get_onboarding.' if logger

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

  path = '/onboardings/{onboardingId}'.sub('{onboardingId}', onboarding_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: 'FleetAppsManagementAdminClient#get_onboarding') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::FleetAppsManagement::Models::Onboarding'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_platform_configuration(platform_configuration_id, opts = {}) ⇒ Response

Note:

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

Gets a PlatformConfiguration by identifier

Parameters:

  • platform_configuration_id (String) —

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



976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_admin_client.rb', line 976

def get_platform_configuration(platform_configuration_id, opts = {})
  logger.debug 'Calling operation FleetAppsManagementAdminClient#get_platform_configuration.' if logger

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

  path = '/platformConfigurations/{platformConfigurationId}'.sub('{platformConfigurationId}', platform_configuration_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: 'FleetAppsManagementAdminClient#get_platform_configuration') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::FleetAppsManagement::Models::PlatformConfiguration'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_property(property_id, opts = {}) ⇒ Response

Note:

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

Gets a Property by identifier

Parameters:

  • property_id (String) —

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



1030
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
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_admin_client.rb', line 1030

def get_property(property_id, opts = {})
  logger.debug 'Calling operation FleetAppsManagementAdminClient#get_property.' if logger

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

  path = '/properties/{propertyId}'.sub('{propertyId}', property_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: 'FleetAppsManagementAdminClient#get_property') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::FleetAppsManagement::Models::Property'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_compliance_policies(opts = {}) ⇒ Response

Note:

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

Returns a list of all the Compliance Policies in the specified compartment. The query parameter compartmentId is required unless the query parameter id is specified.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

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

  • :compartment_id (String) —

    The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified.

  • :lifecycle_state (String) —

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

  • :display_name (String) —

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

  • :type (String) —

    A filter to return Platform Configurations whose type matches the given type.

  • :id (String) —

    Unique identifier or OCID for listing a single Compliance Policy by id. Either compartmentId or id must be provided.

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

    The sort order to use, either 'ASC' or '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.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



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
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_admin_client.rb', line 1101

def list_compliance_policies(opts = {})
  logger.debug 'Calling operation FleetAppsManagementAdminClient#list_compliance_policies.' if logger


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

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

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

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

  path = '/compliancePolicies'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:type] = opts[:type] if opts[:type]
  query_params[:id] = opts[:id] if opts[:id]
  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: 'FleetAppsManagementAdminClient#list_compliance_policies') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::FleetAppsManagement::Models::CompliancePolicyCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_compliance_policy_rules(opts = {}) ⇒ Response

Note:

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

Gets a list of Compliance policy rules in a compartment.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

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

  • :compartment_id (String) —

    The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified.

  • :display_name (String) —

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

  • :lifecycle_state (String) —

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

  • :patch_name (String) —

    A filter to return only resources that match the patch selection against the given patch name.

  • :compliance_policy_id (String) —

    unique CompliancePolicy identifier.

  • :id (String) —

    Unique identifier or OCID for listing a single Compliance Policy Rule by id. Either compartmentId or id must be provided.

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

    The sort order to use, either 'ASC' or '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.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_admin_client.rb', line 1195

def list_compliance_policy_rules(opts = {})
  logger.debug 'Calling operation FleetAppsManagementAdminClient#list_compliance_policy_rules.' if logger


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

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

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

  path = '/compliancePolicyRules'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:patchName] = opts[:patch_name] if opts[:patch_name]
  query_params[:compliancePolicyId] = opts[:compliance_policy_id] if opts[:compliance_policy_id]
  query_params[:id] = opts[:id] if opts[:id]
  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: 'FleetAppsManagementAdminClient#list_compliance_policy_rules') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::FleetAppsManagement::Models::CompliancePolicyRuleCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Returns a list of onboarding policy information for Fleet Application Management.

Allowed values are: timeCreated

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

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

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

  • :sort_by (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_admin_client.rb', line 1276

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

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

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

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

  path = '/onboardingPolicies'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  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: 'FleetAppsManagementAdminClient#list_onboarding_policies') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::FleetAppsManagement::Models::OnboardingPolicyCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_onboardings(opts = {}) ⇒ Response

Note:

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

Returns a list of all the onboardings in the specified root compartment (tenancy). The query parameter compartmentId is required unless the query parameter id is specified.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

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

  • :compartment_id (String) —

    The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified.

  • :lifecycle_state (String) —

    A filter to return only resources whose lifecycleState matches the given lifecycleState.

  • :id (String) —

    Unique identifier or OCID for listing a single onboarding by id. Either compartmentId or id must be provided.

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

    The sort order to use, either 'ASC' or '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.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_admin_client.rb', line 1355

def list_onboardings(opts = {})
  logger.debug 'Calling operation FleetAppsManagementAdminClient#list_onboardings.' if logger


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

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

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

  path = '/onboardings'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:id] = opts[:id] if opts[:id]
  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: 'FleetAppsManagementAdminClient#list_onboardings') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::FleetAppsManagement::Models::OnboardingCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_platform_configurations(opts = {}) ⇒ Response

Note:

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

Returns a list of all the Platform Configurations in the specified compartment. The query parameter compartmentId is required unless the query parameter id is specified.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

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

  • :compartment_id (String) —

    The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified.

  • :lifecycle_state (String) —

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

  • :display_name (String) —

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

  • :id (String) —

    Unique identifier or OCID for listing a single Platform Configuration by id. Either compartmentId or id must be provided.

  • :config_category (String) —

    Config Category

  • :compartment_id_in_subtree (BOOLEAN) —

    If set to true, resources will be returned for not only the provided compartment, but all compartments which descend from it. Which resources are returned and their field contents depends on the value of accessLevel. (default to false)

  • :type (String) —

    A filter to return Platform Configurations whose type matches the given type.

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

    The sort order to use, either 'ASC' or '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.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_admin_client.rb', line 1445

def list_platform_configurations(opts = {})
  logger.debug 'Calling operation FleetAppsManagementAdminClient#list_platform_configurations.' if logger


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

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

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

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

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

  path = '/platformConfigurations'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:configCategory] = opts[:config_category] if opts[:config_category]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:type] = opts[:type] if opts[: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: 'FleetAppsManagementAdminClient#list_platform_configurations') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::FleetAppsManagement::Models::PlatformConfigurationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_properties(opts = {}) ⇒ Response

Note:

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

Returns a list of all the Properties in the specified compartment. The query parameter compartmentId is required unless the query parameter id is specified.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

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

  • :compartment_id (String) —

    The ID of the compartment in which to list resources. Empty only if the resource OCID query param is not specified.

  • :lifecycle_state (String) —

    A filter to return only resources whose lifecycleState matches the given lifecycleState.

  • :display_name (String) —

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

  • :id (String) —

    Unique identifier or OCID for listing a single Property by id. Either compartmentId or id must be provided.

  • :type (String) —

    A filter to return properties whose type matches the given type.

  • :scope (String) —

    A filter to return only resources their scope matches the given scope.

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

    The sort order to use, either 'ASC' or '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.

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_admin_client.rb', line 1545

def list_properties(opts = {})
  logger.debug 'Calling operation FleetAppsManagementAdminClient#list_properties.' if logger


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

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

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

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

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

  path = '/properties'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:type] = opts[:type] if opts[:type]
  query_params[:scope] = opts[:scope] if opts[:scope]
  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: 'FleetAppsManagementAdminClient#list_properties') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::FleetAppsManagement::Models::PropertyCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#logger ⇒ Logger

Returns The logger for this client. May be nil.

Returns:

  • (Logger) —

    The logger for this client. May be nil.



94
95
96
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_admin_client.rb', line 94

def logger
  @api_client.config.logger
end

#manage_settings(onboarding_id, manage_settings_details, opts = {}) ⇒ Response

Note:

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

Updates the Onboarding setting

Parameters:

  • onboarding_id (String) —

    A filter to return resources whose Onboarding identifier matches the given identifier.

  • manage_settings_details (OCI::FleetAppsManagement::Models::ManageSettingsDetails) —

    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.

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



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

def manage_settings(onboarding_id, manage_settings_details, opts = {})
  logger.debug 'Calling operation FleetAppsManagementAdminClient#manage_settings.' if logger

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

  path = '/onboardings/{onboardingId}/actions/manageSettings'.sub('{onboardingId}', onboarding_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(manage_settings_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'FleetAppsManagementAdminClient#manage_settings') 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_compliance_policy_rule(compliance_policy_rule_id, update_compliance_policy_rule_details, opts = {}) ⇒ Response

Note:

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

Updates a compliance policy rule specified by an identifier.

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



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/fleet_apps_management/fleet_apps_management_admin_client.rb', line 1704

def update_compliance_policy_rule(compliance_policy_rule_id, update_compliance_policy_rule_details, opts = {})
  logger.debug 'Calling operation FleetAppsManagementAdminClient#update_compliance_policy_rule.' if logger

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

  path = '/compliancePolicyRules/{compliancePolicyRuleId}'.sub('{compliancePolicyRuleId}', compliance_policy_rule_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_compliance_policy_rule_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'FleetAppsManagementAdminClient#update_compliance_policy_rule') 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_onboarding(onboarding_id, update_onboarding_details, opts = {}) ⇒ Response

Note:

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

Updates the Onboarding

Parameters:

  • onboarding_id (String) —

    A filter to return resources whose Onboarding identifier matches the given identifier.

  • update_onboarding_details (OCI::FleetAppsManagement::Models::UpdateOnboardingDetails) —

    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:

  • (Response) —

    A Response object with data of type nil



1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_admin_client.rb', line 1766

def update_onboarding(onboarding_id, update_onboarding_details, opts = {})
  logger.debug 'Calling operation FleetAppsManagementAdminClient#update_onboarding.' if logger

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

  path = '/onboardings/{onboardingId}'.sub('{onboardingId}', onboarding_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_onboarding_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'FleetAppsManagementAdminClient#update_onboarding') 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_platform_configuration(platform_configuration_id, update_platform_configuration_details, opts = {}) ⇒ Response

Note:

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

Updates the PlatformConfiguration

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



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
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_admin_client.rb', line 1828

def update_platform_configuration(platform_configuration_id, update_platform_configuration_details, opts = {})
  logger.debug 'Calling operation FleetAppsManagementAdminClient#update_platform_configuration.' if logger

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

  path = '/platformConfigurations/{platformConfigurationId}'.sub('{platformConfigurationId}', platform_configuration_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_platform_configuration_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'FleetAppsManagementAdminClient#update_platform_configuration') 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_property(property_id, update_property_details, opts = {}) ⇒ Response

Note:

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

Update a property in Fleet Application Management.

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:



1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_admin_client.rb', line 1890

def update_property(property_id, update_property_details, opts = {})
  logger.debug 'Calling operation FleetAppsManagementAdminClient#update_property.' if logger

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

  path = '/properties/{propertyId}'.sub('{propertyId}', property_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_property_details)

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