Class: OCI::FleetAppsManagement::FleetAppsManagementRunbooksClient

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

Creates a new FleetAppsManagementRunbooksClient. 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_runbooks_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 "FleetAppsManagementRunbooksClient 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_runbooks_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_runbooks_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_runbooks_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_runbooks_client.rb', line 25

def retry_config
  @retry_config
end

Instance Method Details

#change_runbook_compartment(runbook_id, change_runbook_compartment_details, opts = {}) ⇒ Response

Note:

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

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

def change_runbook_compartment(runbook_id, change_runbook_compartment_details, opts = {})
  logger.debug 'Calling operation FleetAppsManagementRunbooksClient#change_runbook_compartment.' if logger

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

  path = '/runbooks/{runbookId}/actions/changeCompartment'.sub('{runbookId}', runbook_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_runbook_compartment_details)

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

#change_task_record_compartment(task_record_id, change_task_record_compartment_details, opts = {}) ⇒ Response

Note:

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

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

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



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

def change_task_record_compartment(task_record_id, change_task_record_compartment_details, opts = {})
  logger.debug 'Calling operation FleetAppsManagementRunbooksClient#change_task_record_compartment.' if logger

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

  path = '/taskRecords/{taskRecordId}/actions/changeCompartment'.sub('{taskRecordId}', task_record_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_task_record_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'FleetAppsManagementRunbooksClient#change_task_record_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_runbook(create_runbook_details, opts = {}) ⇒ Response

Note:

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

Creates a runbook.

Parameters:

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



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

def create_runbook(create_runbook_details, opts = {})
  logger.debug 'Calling operation FleetAppsManagementRunbooksClient#create_runbook.' if logger

  raise "Missing the required parameter 'create_runbook_details' when calling create_runbook." if create_runbook_details.nil?

  path = '/runbooks'
  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_runbook_details)

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

#create_runbook_version(create_runbook_version_details, opts = {}) ⇒ Response

Note:

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

Add RunbookVersion in Fleet Application Management.

Parameters:

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



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
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_runbooks_client.rb', line 324

def create_runbook_version(create_runbook_version_details, opts = {})
  logger.debug 'Calling operation FleetAppsManagementRunbooksClient#create_runbook_version.' if logger

  raise "Missing the required parameter 'create_runbook_version_details' when calling create_runbook_version." if create_runbook_version_details.nil?

  path = '/runbookVersions'
  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_runbook_version_details)

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

#create_task_record(create_task_record_details, opts = {}) ⇒ Response

Note:

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

Creates a new task record.

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:



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

def create_task_record(create_task_record_details, opts = {})
  logger.debug 'Calling operation FleetAppsManagementRunbooksClient#create_task_record.' if logger

  raise "Missing the required parameter 'create_task_record_details' when calling create_task_record." if create_task_record_details.nil?

  path = '/taskRecords'
  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_task_record_details)

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

#delete_runbook(runbook_id, opts = {}) ⇒ Response

Note:

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

Deletes a runbook specified by the identifier.

Parameters:

  • runbook_id (String) —

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



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

def delete_runbook(runbook_id, opts = {})
  logger.debug 'Calling operation FleetAppsManagementRunbooksClient#delete_runbook.' if logger

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

  path = '/runbooks/{runbookId}'.sub('{runbookId}', runbook_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: 'FleetAppsManagementRunbooksClient#delete_runbook') 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_runbook_version(runbook_version_id, opts = {}) ⇒ Response

Note:

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

Removes a Runbook Version from the runbook in Fleet Application Management.

Parameters:

  • runbook_version_id (String) —

    Unique Runbook Version 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



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

def delete_runbook_version(runbook_version_id, opts = {})
  logger.debug 'Calling operation FleetAppsManagementRunbooksClient#delete_runbook_version.' if logger

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

  path = '/runbookVersions/{runbookVersionId}'.sub('{runbookVersionId}', runbook_version_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: 'FleetAppsManagementRunbooksClient#delete_runbook_version') 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_task_record(task_record_id, opts = {}) ⇒ Response

Note:

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

Deletes the task record specified by an identifier.

Parameters:

  • task_record_id (String) —

    The OCID of the task record.

  • 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



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

def delete_task_record(task_record_id, opts = {})
  logger.debug 'Calling operation FleetAppsManagementRunbooksClient#delete_task_record.' if logger

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

  path = '/taskRecords/{taskRecordId}'.sub('{taskRecordId}', task_record_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: 'FleetAppsManagementRunbooksClient#delete_task_record') 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_runbook(export_runbook_details, runbook_id, opts = {}) ⇒ Response

Note:

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

Export the specified version of the runbook.

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



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

def export_runbook(export_runbook_details, runbook_id, opts = {})
  logger.debug 'Calling operation FleetAppsManagementRunbooksClient#export_runbook.' if logger

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

  path = '/runbooks/{runbookId}/actions/export'.sub('{runbookId}', runbook_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(export_runbook_details)

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

#export_runbook_version(export_runbook_version_details, runbook_version_id, opts = {}) ⇒ Response

Note:

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

Export the specified version of the runbook.

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



706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_runbooks_client.rb', line 706

def export_runbook_version(export_runbook_version_details, runbook_version_id, opts = {})
  logger.debug 'Calling operation FleetAppsManagementRunbooksClient#export_runbook_version.' if logger

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

  path = '/runbookVersions/{runbookVersionId}/actions/export'.sub('{runbookVersionId}', runbook_version_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(export_runbook_version_details)

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

#find_runbook_export_dependency(find_runbook_export_dependency_details, opts = {}) ⇒ Response

Note:

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

Find runbook export Dependencies

Parameters:

Options Hash (opts):

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

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

  • :limit (Integer) —

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

  • :page (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_runbooks_client.rb', line 766

def find_runbook_export_dependency(find_runbook_export_dependency_details, opts = {})
  logger.debug 'Calling operation FleetAppsManagementRunbooksClient#find_runbook_export_dependency.' if logger

  raise "Missing the required parameter 'find_runbook_export_dependency_details' when calling find_runbook_export_dependency." if find_runbook_export_dependency_details.nil?

  path = '/runbooks/actions/findExportDependencies'
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(find_runbook_export_dependency_details)

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

#find_runbook_import_dependency(find_runbook_import_dependency_details, opts = {}) ⇒ Response

Note:

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

Find runbook import Dependencies

Parameters:

Options Hash (opts):

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

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

  • :limit (Integer) —

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

  • :page (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_runbooks_client.rb', line 824

def find_runbook_import_dependency(find_runbook_import_dependency_details, opts = {})
  logger.debug 'Calling operation FleetAppsManagementRunbooksClient#find_runbook_import_dependency.' if logger

  raise "Missing the required parameter 'find_runbook_import_dependency_details' when calling find_runbook_import_dependency." if find_runbook_import_dependency_details.nil?

  path = '/runbooks/actions/findImportDependencies'
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(find_runbook_import_dependency_details)

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

#get_runbook(runbook_id, opts = {}) ⇒ Response

Note:

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

Get the details of a runbook in Fleet Application Management.

Parameters:

  • runbook_id (String) —

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



879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_runbooks_client.rb', line 879

def get_runbook(runbook_id, opts = {})
  logger.debug 'Calling operation FleetAppsManagementRunbooksClient#get_runbook.' if logger

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

  path = '/runbooks/{runbookId}'.sub('{runbookId}', runbook_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: 'FleetAppsManagementRunbooksClient#get_runbook') 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::Runbook'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_runbook_export(runbook_id, export_id, opts = {}) ⇒ Response

Note:

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

Get the runbook export status for provided runbook and exportId.

Parameters:

  • runbook_id (String) —

    Unique Runbook identifier

  • export_id (String) —

    Unique tracking identifier to fetch runbook export status

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



934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_runbooks_client.rb', line 934

def get_runbook_export(runbook_id, export_id, opts = {})
  logger.debug 'Calling operation FleetAppsManagementRunbooksClient#get_runbook_export.' if logger

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

  path = '/runbooks/{runbookId}/exports/{exportId}'.sub('{runbookId}', runbook_id.to_s).sub('{exportId}', export_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: 'FleetAppsManagementRunbooksClient#get_runbook_export') 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::RunbookExport'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_runbook_import(runbook_id, import_id, opts = {}) ⇒ Response

Note:

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

Get the runbook import status for provided runbook and importId.

Parameters:

  • runbook_id (String) —

    Unique Runbook identifier

  • import_id (String) —

    Unique tracking identifier to fetch runbook import status

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



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

def get_runbook_import(runbook_id, import_id, opts = {})
  logger.debug 'Calling operation FleetAppsManagementRunbooksClient#get_runbook_import.' if logger

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

  path = '/runbooks/{runbookId}/imports/{importId}'.sub('{runbookId}', runbook_id.to_s).sub('{importId}', import_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: 'FleetAppsManagementRunbooksClient#get_runbook_import') 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::RunbookImport'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_runbook_version(runbook_version_id, opts = {}) ⇒ Response

Note:

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

Gets a Runbook Version by identifier.

Parameters:

  • runbook_version_id (String) —

    Unique Runbook Version 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:



1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_runbooks_client.rb', line 1047

def get_runbook_version(runbook_version_id, opts = {})
  logger.debug 'Calling operation FleetAppsManagementRunbooksClient#get_runbook_version.' if logger

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

  path = '/runbookVersions/{runbookVersionId}'.sub('{runbookVersionId}', runbook_version_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: 'FleetAppsManagementRunbooksClient#get_runbook_version') 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::RunbookVersion'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_task_record(task_record_id, opts = {}) ⇒ Response

Note:

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

Gets information for the specified task record.

Parameters:

  • task_record_id (String) —

    The OCID of the task record.

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



1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_runbooks_client.rb', line 1101

def get_task_record(task_record_id, opts = {})
  logger.debug 'Calling operation FleetAppsManagementRunbooksClient#get_task_record.' if logger

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

  path = '/taskRecords/{taskRecordId}'.sub('{taskRecordId}', task_record_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: 'FleetAppsManagementRunbooksClient#get_task_record') 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::TaskRecord'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#import_runbook(import_runbook_details, opts = {}) ⇒ Response

Note:

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

Import the specified version of the runbook.

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



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

def import_runbook(import_runbook_details, opts = {})
  logger.debug 'Calling operation FleetAppsManagementRunbooksClient#import_runbook.' if logger

  raise "Missing the required parameter 'import_runbook_details' when calling import_runbook." if import_runbook_details.nil?

  path = '/runbooks/actions/import'
  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(import_runbook_details)

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

#import_runbook_precheck(import_runbook_precheck_details, opts = {}) ⇒ Response

Note:

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

Precheck for import runbook.

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



1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_runbooks_client.rb', line 1236

def import_runbook_precheck(import_runbook_precheck_details, opts = {})
  logger.debug 'Calling operation FleetAppsManagementRunbooksClient#import_runbook_precheck.' if logger

  raise "Missing the required parameter 'import_runbook_precheck_details' when calling import_runbook_precheck." if import_runbook_precheck_details.nil?

  path = '/runbooks/actions/importPrecheck'
  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(import_runbook_precheck_details)

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

#import_runbook_version(import_runbook_version_details, opts = {}) ⇒ Response

Note:

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

Export the specified version of the runbook.

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



1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_runbooks_client.rb', line 1304

def import_runbook_version(import_runbook_version_details, opts = {})
  logger.debug 'Calling operation FleetAppsManagementRunbooksClient#import_runbook_version.' if logger

  raise "Missing the required parameter 'import_runbook_version_details' when calling import_runbook_version." if import_runbook_version_details.nil?

  path = '/runbookVersions/actions/import'
  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(import_runbook_version_details)

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

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

Note:

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

Returns a list of all the Runbook export status in the specified compartment. The query parameter compartmentId is required.

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

  • :id (String) —

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

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

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

  • :sort_by (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_runbooks_client.rb', line 1369

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

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

  path = '/runbooks/exportStatus'
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

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

Note:

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

Returns a list of all the Runbook import status in the specified compartment. The query parameter compartmentId is required.

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

  • :id (String) —

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

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

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

  • :sort_by (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_runbooks_client.rb', line 1446

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

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

  path = '/runbooks/importStatus'
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

#list_runbook_versions(opts = {}) ⇒ Response

Note:

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

List versions for a runbook in Fleet Application Management.

Parameters:

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

    the optional parameters

Options Hash (opts):

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

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

  • :compartment_id (String) —

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

  • :lifecycle_state (String) —

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

  • :runbook_id (String) —

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

  • :id (String) —

    A filter to return runbook versions whose identifier matches the given 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 is descending. Default order for displayName is ascending.

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :name (String) —

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

Returns:



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
1577
1578
1579
1580
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_runbooks_client.rb', line 1525

def list_runbook_versions(opts = {})
  logger.debug 'Calling operation FleetAppsManagementRunbooksClient#list_runbook_versions.' if logger


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

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

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

  path = '/runbookVersions'
  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[:runbookId] = opts[:runbook_id] if opts[:runbook_id]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:name] = opts[:name] if opts[:name]

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

  post_body = nil

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

#list_runbooks(opts = {}) ⇒ Response

Note:

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

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

Parameters:

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

    the optional parameters

Options Hash (opts):

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

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

  • :compartment_id (String) —

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

  • :lifecycle_state (String) —

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

  • :display_name (String) —

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

  • :id (String) —

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

  • :type (String) —

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

  • :platform (String) —

    A filter to return runbooks whose platform matches the given platform.

  • :operation (String) —

    A filter to return runbooks whose operation matches the given lifecycle operation.

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



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

def list_runbooks(opts = {})
  logger.debug 'Calling operation FleetAppsManagementRunbooksClient#list_runbooks.' if logger


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

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

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

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

  path = '/runbooks'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:type] = opts[:type] if opts[:type]
  query_params[:platform] = opts[:platform] if opts[:platform]
  query_params[:operation] = opts[:operation] if opts[:operation]
  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: 'FleetAppsManagementRunbooksClient#list_runbooks') 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::RunbookCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_task_records(opts = {}) ⇒ Response

Note:

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

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

  • :platform (String) —

    The platform for the task record.

  • :type (String) —

    The type of the Task.

  • :display_name (String) —

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

  • :operation (String) —

    A filter to return task records whose operation matches the given lifecycle operation.

  • :id (String) —

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

  • :limit (Integer) —

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

  • :page (String) —

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

  • :lifecycle_state (String) —

    The current state of the task record.

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

  • :sort_order (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



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
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_runbooks_client.rb', line 1712

def list_task_records(opts = {})
  logger.debug 'Calling operation FleetAppsManagementRunbooksClient#list_task_records.' if logger


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

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

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

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:platform] = opts[:platform] if opts[:platform]
  query_params[:type] = opts[:type] if opts[:type]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:operation] = opts[:operation] if opts[:operation]
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[: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: 'FleetAppsManagementRunbooksClient#list_task_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::TaskRecordCollection'
    )
  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_runbooks_client.rb', line 94

def logger
  @api_client.config.logger
end

#publish_runbook(publish_runbook_details, opts = {}) ⇒ Response

Note:

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

Publish the specified version of the runbook. The specified version of the runbook becomes acitve when it is published.Only active versions of runbook can be used in execution.

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



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
1834
1835
1836
1837
1838
1839
1840
1841
1842
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_runbooks_client.rb', line 1805

def publish_runbook(publish_runbook_details, opts = {})
  logger.debug 'Calling operation FleetAppsManagementRunbooksClient#publish_runbook.' if logger

  raise "Missing the required parameter 'publish_runbook_details' when calling publish_runbook." if publish_runbook_details.nil?

  path = '/runbooks/actions/publishRunbook'
  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(publish_runbook_details)

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

#set_default_runbook(set_default_runbook_details, opts = {}) ⇒ Response

Note:

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

Set a runbook as default.

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:



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

def set_default_runbook(set_default_runbook_details, opts = {})
  logger.debug 'Calling operation FleetAppsManagementRunbooksClient#set_default_runbook.' if logger

  raise "Missing the required parameter 'set_default_runbook_details' when calling set_default_runbook." if set_default_runbook_details.nil?

  path = '/runbooks/actions/setDefaultRunbook'
  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(set_default_runbook_details)

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

#update_runbook(runbook_id, update_runbook_details, opts = {}) ⇒ Response

Note:

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

Updates the runbook 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



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_runbooks_client.rb', line 1936

def update_runbook(runbook_id, update_runbook_details, opts = {})
  logger.debug 'Calling operation FleetAppsManagementRunbooksClient#update_runbook.' if logger

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

  path = '/runbooks/{runbookId}'.sub('{runbookId}', runbook_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_runbook_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'FleetAppsManagementRunbooksClient#update_runbook') 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_runbook_version(runbook_version_id, update_runbook_version_details, opts = {}) ⇒ Response

Note:

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

Updates the RunbookVersion.

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



1998
1999
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
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_runbooks_client.rb', line 1998

def update_runbook_version(runbook_version_id, update_runbook_version_details, opts = {})
  logger.debug 'Calling operation FleetAppsManagementRunbooksClient#update_runbook_version.' if logger

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

  path = '/runbookVersions/{runbookVersionId}'.sub('{runbookVersionId}', runbook_version_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_runbook_version_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'FleetAppsManagementRunbooksClient#update_runbook_version') 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_task_record(task_record_id, update_task_record_details, opts = {}) ⇒ Response

Note:

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

Updates certain attributes for the specified task record.

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



2060
2061
2062
2063
2064
2065
2066
2067
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
 
# File 'lib/oci/fleet_apps_management/fleet_apps_management_runbooks_client.rb', line 2060

def update_task_record(task_record_id, update_task_record_details, opts = {})
  logger.debug 'Calling operation FleetAppsManagementRunbooksClient#update_task_record.' if logger

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

  path = '/taskRecords/{taskRecordId}'.sub('{taskRecordId}', task_record_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_task_record_details)

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