Class: OCI::FleetAppsManagement::FleetAppsManagementOperationsClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/fleet_apps_management/fleet_apps_management_operations_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) ⇒ FleetAppsManagementOperationsClient

Creates a new FleetAppsManagementOperationsClient. 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_operations_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 "FleetAppsManagementOperationsClient 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_operations_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_operations_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_operations_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_operations_client.rb', line 25

def retry_config
  @retry_config
end

Instance Method Details

#change_patch_compartment(patch_id, change_patch_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves a Patch 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_operations_client.rb', line 126

def change_patch_compartment(patch_id, change_patch_compartment_details, opts = {})
  logger.debug 'Calling operation FleetAppsManagementOperationsClient#change_patch_compartment.' if logger

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

  path = '/patches/{patchId}/actions/changeCompartment'.sub('{patchId}', patch_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_patch_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'FleetAppsManagementOperationsClient#change_patch_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_patch(create_patch_details, opts = {}) ⇒ Response

Note:

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

Creates a new Patch.

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:



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_operations_client.rb', line 190

def create_patch(create_patch_details, opts = {})
  logger.debug 'Calling operation FleetAppsManagementOperationsClient#create_patch.' if logger

  raise "Missing the required parameter 'create_patch_details' when calling create_patch." if create_patch_details.nil?

  path = '/patches'
  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_patch_details)

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

#create_scheduler_definition(create_scheduler_definition_details, opts = {}) ⇒ Response

Note:

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

Create a SchedulerDefinition to perform lifecycle operations.

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:



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_operations_client.rb', line 252

def create_scheduler_definition(create_scheduler_definition_details, opts = {})
  logger.debug 'Calling operation FleetAppsManagementOperationsClient#create_scheduler_definition.' if logger

  raise "Missing the required parameter 'create_scheduler_definition_details' when calling create_scheduler_definition." if create_scheduler_definition_details.nil?

  path = '/schedulerDefinitions'
  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_scheduler_definition_details)

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

#delete_patch(patch_id, opts = {}) ⇒ Response

Note:

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

Deletes the patch specified by identifier.

Parameters:

  • patch_id (String) —

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



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_operations_client.rb', line 313

def delete_patch(patch_id, opts = {})
  logger.debug 'Calling operation FleetAppsManagementOperationsClient#delete_patch.' if logger

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

  path = '/patches/{patchId}'.sub('{patchId}', patch_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: 'FleetAppsManagementOperationsClient#delete_patch') 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_scheduler_definition(scheduler_definition_id, opts = {}) ⇒ Response

Note:

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

Deletes a SchedulerDefinition resource by identifier

Parameters:

  • scheduler_definition_id (String) —

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



373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_operations_client.rb', line 373

def delete_scheduler_definition(scheduler_definition_id, opts = {})
  logger.debug 'Calling operation FleetAppsManagementOperationsClient#delete_scheduler_definition.' if logger

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

  path = '/schedulerDefinitions/{schedulerDefinitionId}'.sub('{schedulerDefinitionId}', scheduler_definition_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: 'FleetAppsManagementOperationsClient#delete_scheduler_definition') 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_scheduler_job(scheduler_job_id, opts = {}) ⇒ Response

Note:

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

Deletes the schedule job specified by an identifier.

Parameters:

  • scheduler_job_id (String) —

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



433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_operations_client.rb', line 433

def delete_scheduler_job(scheduler_job_id, opts = {})
  logger.debug 'Calling operation FleetAppsManagementOperationsClient#delete_scheduler_job.' if logger

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

  path = '/schedulerJobs/{schedulerJobId}'.sub('{schedulerJobId}', scheduler_job_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: 'FleetAppsManagementOperationsClient#delete_scheduler_job') 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

#export_compliance_report(export_compliance_report_details, opts = {}, &block) ⇒ Response

Note:

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

Generate Compliance Report

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.

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

  • :response_target (String, IO) —

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

Returns:

  • (Response) —

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



502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_operations_client.rb', line 502

def export_compliance_report(export_compliance_report_details, opts = {}, &block)
  logger.debug 'Calling operation FleetAppsManagementOperationsClient#export_compliance_report.' if logger

  raise "Missing the required parameter 'export_compliance_report_details' when calling export_compliance_report." if export_compliance_report_details.nil?

  path = '/complianceRecords/actions/exportComplianceReport'
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'application/json'
  header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding]
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  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
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(export_compliance_report_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'FleetAppsManagementOperationsClient#export_compliance_report') do
    if !block.nil?
      @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: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @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: 'Stream',
          &proc { |chunk, _response| opts[:response_target].write(chunk) }
        )
      elsif opts[:response_target].is_a?(String)
        File.open(opts[:response_target], 'wb') do |output|
          return @api_client.call_api(
            :POST,
            path,
            endpoint,
            header_params: header_params,
            query_params: query_params,
            operation_signing_strategy: operation_signing_strategy,
            body: post_body,
            return_type: 'Stream',
            &proc { |chunk, _response| output.write(chunk) }
          )
        end
      end
    else
      @api_client.call_api(
        :POST,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'String'
      )
    end
  end
  # rubocop:enable Metrics/BlockLength
end

#get_execution(scheduler_job_id, job_activity_id, resource_id, execution_id, opts = {}) ⇒ Response

Note:

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

Get Task Execution by Identifier for a Resource within an action group.

Parameters:

  • scheduler_job_id (String) —

    unique SchedulerJob identifier

  • job_activity_id (String) —

    unique jobActivity identifier

  • resource_id (String) —

    unique Resource identifier

  • execution_id (String) —

    Execution Id

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



605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_operations_client.rb', line 605

def get_execution(scheduler_job_id, job_activity_id, resource_id, execution_id, opts = {})
  logger.debug 'Calling operation FleetAppsManagementOperationsClient#get_execution.' if logger

  raise "Missing the required parameter 'scheduler_job_id' when calling get_execution." if scheduler_job_id.nil?
  raise "Missing the required parameter 'job_activity_id' when calling get_execution." if job_activity_id.nil?
  raise "Missing the required parameter 'resource_id' when calling get_execution." if resource_id.nil?
  raise "Missing the required parameter 'execution_id' when calling get_execution." if execution_id.nil?
  raise "Parameter value for 'scheduler_job_id' must not be blank" if OCI::Internal::Util.blank_string?(scheduler_job_id)
  raise "Parameter value for 'job_activity_id' must not be blank" if OCI::Internal::Util.blank_string?(job_activity_id)
  raise "Parameter value for 'resource_id' must not be blank" if OCI::Internal::Util.blank_string?(resource_id)
  raise "Parameter value for 'execution_id' must not be blank" if OCI::Internal::Util.blank_string?(execution_id)

  path = '/schedulerJobs/{schedulerJobId}/jobActivities/{jobActivityId}/resources/{resourceId}/executions/{executionId}'.sub('{schedulerJobId}', scheduler_job_id.to_s).sub('{jobActivityId}', job_activity_id.to_s).sub('{resourceId}', resource_id.to_s).sub('{executionId}', execution_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: 'FleetAppsManagementOperationsClient#get_execution') 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::Execution'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_job_activity(scheduler_job_id, job_activity_id, opts = {}) ⇒ Response

Note:

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

Gets activity details by identifier for a job.

Parameters:

  • scheduler_job_id (String) —

    unique SchedulerJob identifier

  • job_activity_id (String) —

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



666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_operations_client.rb', line 666

def get_job_activity(scheduler_job_id, job_activity_id, opts = {})
  logger.debug 'Calling operation FleetAppsManagementOperationsClient#get_job_activity.' if logger

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

  path = '/schedulerJobs/{schedulerJobId}/jobActivities/{jobActivityId}'.sub('{schedulerJobId}', scheduler_job_id.to_s).sub('{jobActivityId}', job_activity_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

#get_patch(patch_id, opts = {}) ⇒ Response

Note:

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

Gets a Patch by identifier.

Parameters:

  • patch_id (String) —

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



722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_operations_client.rb', line 722

def get_patch(patch_id, opts = {})
  logger.debug 'Calling operation FleetAppsManagementOperationsClient#get_patch.' if logger

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

  path = '/patches/{patchId}'.sub('{patchId}', patch_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: 'FleetAppsManagementOperationsClient#get_patch') 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::Patch'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_scheduler_definition(scheduler_definition_id, opts = {}) ⇒ Response

Note:

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

Get the details of a SchedulerDefinition that performs lifecycle management operations.

Parameters:

  • scheduler_definition_id (String) —

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



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

def get_scheduler_definition(scheduler_definition_id, opts = {})
  logger.debug 'Calling operation FleetAppsManagementOperationsClient#get_scheduler_definition.' if logger

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

  path = '/schedulerDefinitions/{schedulerDefinitionId}'.sub('{schedulerDefinitionId}', scheduler_definition_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: 'FleetAppsManagementOperationsClient#get_scheduler_definition') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::FleetAppsManagement::Models::SchedulerDefinition'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_scheduler_job(scheduler_job_id, opts = {}) ⇒ Response

Note:

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

Get the details of a lifecycle management operations job in Fleet Application Management.

Parameters:

  • scheduler_job_id (String) —

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



830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_operations_client.rb', line 830

def get_scheduler_job(scheduler_job_id, opts = {})
  logger.debug 'Calling operation FleetAppsManagementOperationsClient#get_scheduler_job.' if logger

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

  path = '/schedulerJobs/{schedulerJobId}'.sub('{schedulerJobId}', scheduler_job_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: 'FleetAppsManagementOperationsClient#get_scheduler_job') 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::SchedulerJob'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Gets a list of complianceDetails.

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

  • :resource_id (String) —

    Resource identifier.

  • :entity_id (String) —

    Entity identifier.Ex:FleetId

  • :product_name (String) —

    Product Name.

  • :product_stack (String) —

    ProductStack name.

  • :target_name (String) —

    Unique target name

  • :compliance_state (String) —

    Target Compliance State.

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

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



899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
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
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_operations_client.rb', line 899

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

  raise "Missing the required parameter 'compartment_id' when calling list_compliance_records." 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] && !OCI::FleetAppsManagement::Models::COMPLIANCE_RECORD_SORT_BY_ENUM.include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of the values in OCI::FleetAppsManagement::Models::COMPLIANCE_RECORD_SORT_BY_ENUM.'
  end

  path = '/complianceRecords'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:resourceId] = opts[:resource_id] if opts[:resource_id]
  query_params[:entityId] = opts[:entity_id] if opts[:entity_id]
  query_params[:productName] = opts[:product_name] if opts[:product_name]
  query_params[:productStack] = opts[:product_stack] if opts[:product_stack]
  query_params[:targetName] = opts[:target_name] if opts[:target_name]
  query_params[:complianceState] = opts[:compliance_state] if opts[:compliance_state]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  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: 'FleetAppsManagementOperationsClient#list_compliance_records') 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::ComplianceRecordCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_executions(scheduler_job_id, job_activity_id, resource_id, opts = {}) ⇒ Response

Note:

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

Returns a list of Task Executions for a Resource. Allowed values are: timeStarted

Parameters:

  • scheduler_job_id (String) —

    unique SchedulerJob identifier

  • job_activity_id (String) —

    unique jobActivity identifier

  • resource_id (String) —

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

  • :resource_task_id (String) —

    Task Id

  • :step_name (String) —

    Unique step name

  • :target_name (String) —

    Unique target name

  • :sequence (String) —

    Task Order Sequence

  • :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 timeStarted is descending. (default to timeStarted)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_operations_client.rb', line 984

def list_executions(scheduler_job_id, job_activity_id, resource_id, opts = {})
  logger.debug 'Calling operation FleetAppsManagementOperationsClient#list_executions.' if logger

  raise "Missing the required parameter 'scheduler_job_id' when calling list_executions." if scheduler_job_id.nil?
  raise "Missing the required parameter 'job_activity_id' when calling list_executions." if job_activity_id.nil?
  raise "Missing the required parameter 'resource_id' when calling list_executions." if resource_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[timeStarted].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeStarted.'
  end
  raise "Parameter value for 'scheduler_job_id' must not be blank" if OCI::Internal::Util.blank_string?(scheduler_job_id)
  raise "Parameter value for 'job_activity_id' must not be blank" if OCI::Internal::Util.blank_string?(job_activity_id)
  raise "Parameter value for 'resource_id' must not be blank" if OCI::Internal::Util.blank_string?(resource_id)

  path = '/schedulerJobs/{schedulerJobId}/jobActivities/{jobActivityId}/resources/{resourceId}/executions'.sub('{schedulerJobId}', scheduler_job_id.to_s).sub('{jobActivityId}', job_activity_id.to_s).sub('{resourceId}', resource_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:resourceTaskId] = opts[:resource_task_id] if opts[:resource_task_id]
  query_params[:stepName] = opts[:step_name] if opts[:step_name]
  query_params[:targetName] = opts[:target_name] if opts[:target_name]
  query_params[:sequence] = opts[:sequence] if opts[:sequence]
  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: 'FleetAppsManagementOperationsClient#list_executions') 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::ExecutionCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Gets a list of inventoryDetails.

Allowed values are: targetName, targetProductName, targetResourceId, osType, architecture

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

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

  • :fleet_id (String) —

    unique Fleet identifier

  • :resource_id (String) —

    Resource Identifier

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. (default to targetName)

Returns:



1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_operations_client.rb', line 1070

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

  raise "Missing the required parameter 'compartment_id' when calling list_inventory_records." 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[targetName targetProductName targetResourceId osType architecture].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of targetName, targetProductName, targetResourceId, osType, architecture.'
  end

  path = '/inventoryRecords'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:fleetId] = opts[:fleet_id] if opts[:fleet_id]
  query_params[:resourceId] = opts[:resource_id] if opts[:resource_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: 'FleetAppsManagementOperationsClient#list_inventory_records') 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::InventoryRecordCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_patches(opts = {}) ⇒ Response

Note:

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

Returns a list of all the Patches 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.

  • :product_id (String) —

    Product platformConfigurationId associated with the Patch.

  • :version (String) —

    Product version.

  • :type (String) —

    DefinedBy type.

  • :patch_type_id (String) —

    Patch Type platformConfigurationId associated with the Patch.

  • :name (String) —

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

  • :id (String) —

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

  • :time_released_greater_than_or_equal_to (DateTime) —

    A filter to return patches whose release date is greater than or equal to the given date.

  • :time_released_less_than (DateTime) —

    A filter to return patches whose release date is less than the given date.

  • :should_compliance_policy_rules_be_applied (BOOLEAN) —

    Filter patch based on compliance policy rules for the Product.

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

  • :lifecycle_state (String) —

    The current state of the Patch.

  • :sort_by (String) —

    The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for name is ascending.

  • :sort_order (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
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
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_operations_client.rb', line 1160

def list_patches(opts = {})
  logger.debug 'Calling operation FleetAppsManagementOperationsClient#list_patches.' if logger


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

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

  if opts[:sort_by] && !OCI::FleetAppsManagement::Models::PATCH_SORT_BY_ENUM.include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of the values in OCI::FleetAppsManagement::Models::PATCH_SORT_BY_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

  path = '/patches'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:productId] = opts[:product_id] if opts[:product_id]
  query_params[:version] = opts[:version] if opts[:version]
  query_params[:type] = opts[:type] if opts[:type]
  query_params[:patchTypeId] = opts[:patch_type_id] if opts[:patch_type_id]
  query_params[:name] = opts[:name] if opts[:name]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:timeReleasedGreaterThanOrEqualTo] = opts[:time_released_greater_than_or_equal_to] if opts[:time_released_greater_than_or_equal_to]
  query_params[:timeReleasedLessThan] = opts[:time_released_less_than] if opts[:time_released_less_than]
  query_params[:shouldCompliancePolicyRulesBeApplied] = opts[:should_compliance_policy_rules_be_applied] if !opts[:should_compliance_policy_rules_be_applied].nil?
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]

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

  post_body = nil

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

#list_resources(scheduler_job_id, job_activity_id, opts = {}) ⇒ Response

Note:

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

Returns a list of resources for an Activity Execution. Allowed values are: timeStarted

Parameters:

  • scheduler_job_id (String) —

    unique SchedulerJob identifier

  • job_activity_id (String) —

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

  • :resource_task_id (String) —

    Task Id

  • :step_name (String) —

    Unique step name

  • :target_name (String) —

    Unique target name

  • :sequence (String) —

    Task Order Sequence

  • :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 timeStarted is descending. (default to timeStarted)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_operations_client.rb', line 1254

def list_resources(scheduler_job_id, job_activity_id, opts = {})
  logger.debug 'Calling operation FleetAppsManagementOperationsClient#list_resources.' if logger

  raise "Missing the required parameter 'scheduler_job_id' when calling list_resources." if scheduler_job_id.nil?
  raise "Missing the required parameter 'job_activity_id' when calling list_resources." if job_activity_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[timeStarted].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeStarted.'
  end
  raise "Parameter value for 'scheduler_job_id' must not be blank" if OCI::Internal::Util.blank_string?(scheduler_job_id)
  raise "Parameter value for 'job_activity_id' must not be blank" if OCI::Internal::Util.blank_string?(job_activity_id)

  path = '/schedulerJobs/{schedulerJobId}/jobActivities/{jobActivityId}/resources'.sub('{schedulerJobId}', scheduler_job_id.to_s).sub('{jobActivityId}', job_activity_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:resourceTaskId] = opts[:resource_task_id] if opts[:resource_task_id]
  query_params[:stepName] = opts[:step_name] if opts[:step_name]
  query_params[:targetName] = opts[:target_name] if opts[:target_name]
  query_params[:sequence] = opts[:sequence] if opts[:sequence]
  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: 'FleetAppsManagementOperationsClient#list_resources') 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::ResourceCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_scheduled_fleets(scheduler_definition_id, opts = {}) ⇒ Response

Note:

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

Returns a list of ScheduledFleets.

Allowed values are: displayName

Parameters:

  • scheduler_definition_id (String) —

    unique SchedulerDefinition identifier

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

    the optional parameters

Options Hash (opts):

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

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

  • :display_name (String) —

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

  • :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 displayName is ascending. (default to displayName)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_operations_client.rb', line 1334

def list_scheduled_fleets(scheduler_definition_id, opts = {})
  logger.debug 'Calling operation FleetAppsManagementOperationsClient#list_scheduled_fleets.' if logger

  raise "Missing the required parameter 'scheduler_definition_id' when calling list_scheduled_fleets." if scheduler_definition_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[displayName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of displayName.'
  end
  raise "Parameter value for 'scheduler_definition_id' must not be blank" if OCI::Internal::Util.blank_string?(scheduler_definition_id)

  path = '/schedulerDefinitions/{schedulerDefinitionId}/scheduledFleets'.sub('{schedulerDefinitionId}', scheduler_definition_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[: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: 'FleetAppsManagementOperationsClient#list_scheduled_fleets') 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::ScheduledFleetCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_scheduler_definitions(opts = {}) ⇒ Response

Note:

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

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

Allowed values are: timeCreated, displayName, timeOfNextRun

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 scheduleDefinitions whose lifecycleState matches the given lifecycleState.

  • :display_name (String) —

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

  • :product (String) —

    A filter to return only dchedule definitions whose assocaited product matches the given product

  • :id (String) —

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

  • :maintenance_window_id (String) —

    A filter to return only schedule definitions whose associated maintenanceWindowId matches the given maintenanceWindowId.

  • :runbook_id (String) —

    A filter to return only schedule definitions whose associated runbookId matches the given runbookId.

  • :runbook_version_name (String) —

    RunbookVersion Name filter

  • :time_scheduled_greater_than_or_equal_to (DateTime) —

    Scheduled Time

  • :time_scheduled_less_than (DateTime) —

    Scheduled Time

  • :fleet_id (String) —

    unique Fleet identifier

  • :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 and timeOfNextRun is descending. Default order for displayName is ascending. (default to displayName)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_operations_client.rb', line 1423

def list_scheduler_definitions(opts = {})
  logger.debug 'Calling operation FleetAppsManagementOperationsClient#list_scheduler_definitions.' if logger


  if opts[:lifecycle_state] && !OCI::FleetAppsManagement::Models::SchedulerDefinition::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::FleetAppsManagement::Models::SchedulerDefinition::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] && !%w[timeCreated displayName timeOfNextRun].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, displayName, timeOfNextRun.'
  end

  path = '/schedulerDefinitions'
  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[:product] = opts[:product] if opts[:product]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:maintenanceWindowId] = opts[:maintenance_window_id] if opts[:maintenance_window_id]
  query_params[:runbookId] = opts[:runbook_id] if opts[:runbook_id]
  query_params[:runbookVersionName] = opts[:runbook_version_name] if opts[:runbook_version_name]
  query_params[:timeScheduledGreaterThanOrEqualTo] = opts[:time_scheduled_greater_than_or_equal_to] if opts[:time_scheduled_greater_than_or_equal_to]
  query_params[:timeScheduledLessThan] = opts[:time_scheduled_less_than] if opts[:time_scheduled_less_than]
  query_params[:fleetId] = opts[:fleet_id] if opts[:fleet_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: 'FleetAppsManagementOperationsClient#list_scheduler_definitions') 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::SchedulerDefinitionCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_scheduler_executions(opts = {}) ⇒ Response

Note:

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

Returns a list of all Fleets that are scheduled.

Allowed values are: timeCreated, timeScheduled

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.

  • :time_scheduled_greater_than_or_equal_to (DateTime) —

    Scheduled Time

  • :time_scheduled_less_than (DateTime) —

    Scheduled Time

  • :scheduler_defintion_id (String) —

    SchedulerDefinition identifier

  • :scheduler_job_id (String) —

    SchedulerJob identifier filter

  • :resource_id (String) —

    ResourceId filter (Example FleetId)

  • :runbook_id (String) —

    A filter to return only schedule definitions whose associated runbookId matches the given runbookId.

  • :runbook_version_name (String) —

    RunbookVersion Name filter

  • :substate (String) —

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

  • :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 and timeScheduled is descending. (default to timeScheduled)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_operations_client.rb', line 1520

def list_scheduler_executions(opts = {})
  logger.debug 'Calling operation FleetAppsManagementOperationsClient#list_scheduler_executions.' if logger


  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 timeScheduled].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, timeScheduled.'
  end

  path = '/schedulerExecutions'
  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[:timeScheduledGreaterThanOrEqualTo] = opts[:time_scheduled_greater_than_or_equal_to] if opts[:time_scheduled_greater_than_or_equal_to]
  query_params[:timeScheduledLessThan] = opts[:time_scheduled_less_than] if opts[:time_scheduled_less_than]
  query_params[:schedulerDefintionId] = opts[:scheduler_defintion_id] if opts[:scheduler_defintion_id]
  query_params[:schedulerJobId] = opts[:scheduler_job_id] if opts[:scheduler_job_id]
  query_params[:resourceId] = opts[:resource_id] if opts[:resource_id]
  query_params[:runbookId] = opts[:runbook_id] if opts[:runbook_id]
  query_params[:runbookVersionName] = opts[:runbook_version_name] if opts[:runbook_version_name]
  query_params[:substate] = opts[:substate] if opts[:substate]
  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: 'FleetAppsManagementOperationsClient#list_scheduler_executions') 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::SchedulerExecutionCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_scheduler_jobs(opts = {}) ⇒ Response

Note:

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

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

Allowed values are: timeCreated, timeScheduled, displayName

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.

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

  • :lifecycle_state (String) —

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

  • :fleet_id (String) —

    unique Fleet identifier

  • :time_scheduled_greater_than_or_equal_to (DateTime) —

    Scheduled Time

  • :time_scheduled_less_than (DateTime) —

    Scheduled Time

  • :is_remediation_job_needed (BOOLEAN) —

    Fetch next remediation Job

  • :substate (String) —

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

  • :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 Schedule Job by id. Either compartmentId or id must be provided.

  • :scheduler_defintion_id (String) —

    SchedulerDefinition identifier

  • :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 and timeScheduled is descending. Default order for displayName is ascending. (default to timeCreated)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_operations_client.rb', line 1618

def list_scheduler_jobs(opts = {})
  logger.debug 'Calling operation FleetAppsManagementOperationsClient#list_scheduler_jobs.' if logger


  if opts[:lifecycle_state] && !OCI::FleetAppsManagement::Models::SchedulerJob::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state])
    raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::FleetAppsManagement::Models::SchedulerJob::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] && !%w[timeCreated timeScheduled displayName].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated, timeScheduled, displayName.'
  end

  path = '/schedulerJobs'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:fleetId] = opts[:fleet_id] if opts[:fleet_id]
  query_params[:timeScheduledGreaterThanOrEqualTo] = opts[:time_scheduled_greater_than_or_equal_to] if opts[:time_scheduled_greater_than_or_equal_to]
  query_params[:timeScheduledLessThan] = opts[:time_scheduled_less_than] if opts[:time_scheduled_less_than]
  query_params[:isRemediationJobNeeded] = opts[:is_remediation_job_needed] if !opts[:is_remediation_job_needed].nil?
  query_params[:substate] = opts[:substate] if opts[:substate]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:schedulerDefintionId] = opts[:scheduler_defintion_id] if opts[:scheduler_defintion_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: 'FleetAppsManagementOperationsClient#list_scheduler_jobs') 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::SchedulerJobCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_steps(scheduler_job_id, job_activity_id, opts = {}) ⇒ Response

Note:

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

Returns a list of Steps for an Activity Execution. Allowed values are: timeStarted

Parameters:

  • scheduler_job_id (String) —

    unique SchedulerJob identifier

  • job_activity_id (String) —

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

  • :resource_task_id (String) —

    Task Id

  • :step_name (String) —

    Unique step name

  • :target_name (String) —

    Unique target name

  • :sequence (String) —

    Task Order Sequence

  • :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 timeStarted is descending. (default to timeStarted)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_operations_client.rb', line 1708

def list_steps(scheduler_job_id, job_activity_id, opts = {})
  logger.debug 'Calling operation FleetAppsManagementOperationsClient#list_steps.' if logger

  raise "Missing the required parameter 'scheduler_job_id' when calling list_steps." if scheduler_job_id.nil?
  raise "Missing the required parameter 'job_activity_id' when calling list_steps." if job_activity_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[timeStarted].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeStarted.'
  end
  raise "Parameter value for 'scheduler_job_id' must not be blank" if OCI::Internal::Util.blank_string?(scheduler_job_id)
  raise "Parameter value for 'job_activity_id' must not be blank" if OCI::Internal::Util.blank_string?(job_activity_id)

  path = '/schedulerJobs/{schedulerJobId}/jobActivities/{jobActivityId}/steps'.sub('{schedulerJobId}', scheduler_job_id.to_s).sub('{jobActivityId}', job_activity_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:resourceTaskId] = opts[:resource_task_id] if opts[:resource_task_id]
  query_params[:stepName] = opts[:step_name] if opts[:step_name]
  query_params[:targetName] = opts[:target_name] if opts[:target_name]
  query_params[:sequence] = opts[:sequence] if opts[:sequence]
  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: 'FleetAppsManagementOperationsClient#list_steps') 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::StepCollection'
    )
  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_operations_client.rb', line 94

def logger
  @api_client.config.logger
end

#manage_job_execution(manage_job_execution_details, scheduler_job_id, opts = {}) ⇒ Response

Note:

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

Manage execution actions for a Job like retrying or pausing a task.

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.

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



1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_operations_client.rb', line 1794

def manage_job_execution(manage_job_execution_details, scheduler_job_id, opts = {})
  logger.debug 'Calling operation FleetAppsManagementOperationsClient#manage_job_execution.' if logger

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

  path = '/schedulerJobs/{schedulerJobId}/actions/manageJobExecution'.sub('{schedulerJobId}', scheduler_job_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token]
  header_params[:'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
  header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token

  post_body = @api_client.object_to_http_body(manage_job_execution_details)

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

#summarize_compliance_record_counts(opts = {}) ⇒ Response

Note:

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

Retrieve aggregated summary information of ComplianceRecords within 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.

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

  • :opc_request_id (String) —

    The client request ID for tracing.

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

Returns:



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

def summarize_compliance_record_counts(opts = {})
  logger.debug 'Calling operation FleetAppsManagementOperationsClient#summarize_compliance_record_counts.' if logger


  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

  path = '/complianceRecordCounts'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  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]

  # 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: 'FleetAppsManagementOperationsClient#summarize_compliance_record_counts') 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::ComplianceRecordAggregationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_managed_entity_counts(opts = {}) ⇒ Response

Note:

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

Retrieve aggregated summary information of Managed entities within 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.

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

  • :opc_request_id (String) —

    The client request ID for tracing.

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

Returns:



1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_operations_client.rb', line 1930

def summarize_managed_entity_counts(opts = {})
  logger.debug 'Calling operation FleetAppsManagementOperationsClient#summarize_managed_entity_counts.' if logger


  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

  path = '/managedEntityCounts'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  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]

  # 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: 'FleetAppsManagementOperationsClient#summarize_managed_entity_counts') 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::ManagedEntityAggregationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#summarize_scheduler_job_counts(opts = {}) ⇒ Response

Note:

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

Retrieve aggregated summary information of Scheduler Jobs within 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.

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

  • :opc_request_id (String) —

    The client request ID for tracing.

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

Returns:



2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_operations_client.rb', line 2000

def summarize_scheduler_job_counts(opts = {})
  logger.debug 'Calling operation FleetAppsManagementOperationsClient#summarize_scheduler_job_counts.' if logger


  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

  path = '/schedulerJobCounts'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  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]

  # 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: 'FleetAppsManagementOperationsClient#summarize_scheduler_job_counts') 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::SchedulerJobAggregationCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_patch(patch_id, update_patch_details, opts = {}) ⇒ Response

Note:

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

Updates the patch specified by the 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



2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_operations_client.rb', line 2068

def update_patch(patch_id, update_patch_details, opts = {})
  logger.debug 'Calling operation FleetAppsManagementOperationsClient#update_patch.' if logger

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

  path = '/patches/{patchId}'.sub('{patchId}', patch_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_patch_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'FleetAppsManagementOperationsClient#update_patch') 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_scheduler_definition(scheduler_definition_id, update_scheduler_definition_details, opts = {}) ⇒ Response

Note:

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

Update the details of a SchedulerDefinition that performs lifecycle management operations.

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



2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_operations_client.rb', line 2130

def update_scheduler_definition(scheduler_definition_id, update_scheduler_definition_details, opts = {})
  logger.debug 'Calling operation FleetAppsManagementOperationsClient#update_scheduler_definition.' if logger

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

  path = '/schedulerDefinitions/{schedulerDefinitionId}'.sub('{schedulerDefinitionId}', scheduler_definition_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_scheduler_definition_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'FleetAppsManagementOperationsClient#update_scheduler_definition') 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_scheduler_job(scheduler_job_id, update_scheduler_job_details, opts = {}) ⇒ Response

Note:

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

Updates certain attributes for the specified schedule job.

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:



2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_operations_client.rb', line 2192

def update_scheduler_job(scheduler_job_id, update_scheduler_job_details, opts = {})
  logger.debug 'Calling operation FleetAppsManagementOperationsClient#update_scheduler_job.' if logger

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

  path = '/schedulerJobs/{schedulerJobId}'.sub('{schedulerJobId}', scheduler_job_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_scheduler_job_details)

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