Class: OCI::FleetSoftwareUpdate::FleetSoftwareUpdateClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/fleet_software_update/fleet_software_update_client.rb

Overview

Use the Exadata Fleet Update service to patch large collections of components directly, as a single entity, orchestrating the maintenance actions to update all chosen components in the stack in a single cycle.

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

Creates a new FleetSoftwareUpdateClient. 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



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

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 + '/20220528'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "FleetSoftwareUpdateClient endpoint set to '#{@endpoint}'." if logger
end

Instance Attribute Details

#api_client ⇒ OCI::ApiClient (readonly)

Client used to make HTTP requests.

Returns:



16
17
18
 
# File 'lib/oci/fleet_software_update/fleet_software_update_client.rb', line 16

def api_client
  @api_client
end

#endpoint ⇒ String (readonly)

Fully qualified endpoint URL

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/fleet_software_update/fleet_software_update_client.rb', line 20

def endpoint
  @endpoint
end

#region ⇒ String

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

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/fleet_software_update/fleet_software_update_client.rb', line 30

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:



26
27
28
 
# File 'lib/oci/fleet_software_update/fleet_software_update_client.rb', line 26

def retry_config
  @retry_config
end

Instance Method Details

#abort_fsu_discovery(fsu_discovery_id, opts = {}) ⇒ Response

Note:

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

Aborts Exadata Fleet Update Discovery in progress.

Parameters:

  • fsu_discovery_id (String) —

    Unique Exadata Fleet Update Discovery 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.

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



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_software_update/fleet_software_update_client.rb', line 127

def abort_fsu_discovery(fsu_discovery_id, opts = {})
  logger.debug 'Calling operation FleetSoftwareUpdateClient#abort_fsu_discovery.' if logger

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

  path = '/fsuDiscoveries/{fsuDiscoveryId}/actions/abort'.sub('{fsuDiscoveryId}', fsu_discovery_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 = nil

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

#add_fsu_collection_targets(fsu_collection_id, add_fsu_collection_targets_details, opts = {}) ⇒ Response

Note:

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

Adds targets to an existing Exadata Fleet Update Collection. Targets that are already part of a different Collection with an active Fleet Software Update Cycle cannot be added. This operation can only be performed on Collections that do not have an Action executing under an active Fleet Software Update Cycle. Additionally, during an active Fleet Software Update Cycle, targets can be added only prior to executing an Apply Action. This will require running a new Stage Action for the active Cycle.

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



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
238
239
240
241
242
 
# File 'lib/oci/fleet_software_update/fleet_software_update_client.rb', line 203

def add_fsu_collection_targets(fsu_collection_id, add_fsu_collection_targets_details, opts = {})
  logger.debug 'Calling operation FleetSoftwareUpdateClient#add_fsu_collection_targets.' if logger

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

  path = '/fsuCollections/{fsuCollectionId}/targets'.sub('{fsuCollectionId}', fsu_collection_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(add_fsu_collection_targets_details)

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

#cancel_fsu_action(fsu_action_id, opts = {}) ⇒ Response

Note:

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

Cancels a scheduled Action. Only applicable for Actions that have not started executing.

Parameters:

  • fsu_action_id (String) —

    Unique Exadata Fleet Update Action 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.

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



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/oci/fleet_software_update/fleet_software_update_client.rb', line 275

def cancel_fsu_action(fsu_action_id, opts = {})
  logger.debug 'Calling operation FleetSoftwareUpdateClient#cancel_fsu_action.' if logger

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

  path = '/fsuActions/{fsuActionId}/actions/cancel'.sub('{fsuActionId}', fsu_action_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 = nil

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'FleetSoftwareUpdateClient#cancel_fsu_action') 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_fsu_action_compartment(fsu_action_id, change_fsu_action_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves a Exadata Fleet Update Action resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/oci/fleet_software_update/fleet_software_update_client.rb', line 349

def change_fsu_action_compartment(fsu_action_id, change_fsu_action_compartment_details, opts = {})
  logger.debug 'Calling operation FleetSoftwareUpdateClient#change_fsu_action_compartment.' if logger

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

  path = '/fsuActions/{fsuActionId}/actions/changeCompartment'.sub('{fsuActionId}', fsu_action_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_fsu_action_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'FleetSoftwareUpdateClient#change_fsu_action_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_fsu_collection_compartment(fsu_collection_id, change_fsu_collection_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves a Exadata Fleet Update Collection resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
 
# File 'lib/oci/fleet_software_update/fleet_software_update_client.rb', line 424

def change_fsu_collection_compartment(fsu_collection_id, change_fsu_collection_compartment_details, opts = {})
  logger.debug 'Calling operation FleetSoftwareUpdateClient#change_fsu_collection_compartment.' if logger

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

  path = '/fsuCollections/{fsuCollectionId}/actions/changeCompartment'.sub('{fsuCollectionId}', fsu_collection_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_fsu_collection_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'FleetSoftwareUpdateClient#change_fsu_collection_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_fsu_cycle_compartment(fsu_cycle_id, change_fsu_cycle_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves a Exadata Fleet Update Cycle resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
 
# File 'lib/oci/fleet_software_update/fleet_software_update_client.rb', line 499

def change_fsu_cycle_compartment(fsu_cycle_id, change_fsu_cycle_compartment_details, opts = {})
  logger.debug 'Calling operation FleetSoftwareUpdateClient#change_fsu_cycle_compartment.' if logger

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

  path = '/fsuCycles/{fsuCycleId}/actions/changeCompartment'.sub('{fsuCycleId}', fsu_cycle_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_fsu_cycle_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'FleetSoftwareUpdateClient#change_fsu_cycle_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_fsu_discovery_compartment(fsu_discovery_id, change_fsu_discovery_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves a Exadata Fleet Update Discovery resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource.

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



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

def change_fsu_discovery_compartment(fsu_discovery_id, change_fsu_discovery_compartment_details, opts = {})
  logger.debug 'Calling operation FleetSoftwareUpdateClient#change_fsu_discovery_compartment.' if logger

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

  path = '/fsuDiscoveries/{fsuDiscoveryId}/actions/changeCompartment'.sub('{fsuDiscoveryId}', fsu_discovery_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_fsu_discovery_compartment_details)

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

#clone_fsu_cycle(fsu_cycle_id, clone_fsu_cycle_details, opts = {}) ⇒ Response

Note:

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

Clones existing Exadata Fleet Update Cycle details into a new Exadata Fleet Update Cycle resource.

Parameters:

  • fsu_cycle_id (String) —

    Unique Exadata Fleet Update Cycle identifier.

  • clone_fsu_cycle_details (OCI::FleetSoftwareUpdate::Models::CloneFsuCycleDetails) —

    The Exadata Fleet Update Cycle properties to be updated in the cloned Cycle instead of using the existing values.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

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

Returns:



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
675
676
677
678
679
680
 
# File 'lib/oci/fleet_software_update/fleet_software_update_client.rb', line 641

def clone_fsu_cycle(fsu_cycle_id, clone_fsu_cycle_details, opts = {})
  logger.debug 'Calling operation FleetSoftwareUpdateClient#clone_fsu_cycle.' if logger

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

  path = '/fsuCycles/{fsuCycleId}/actions/clone'.sub('{fsuCycleId}', fsu_cycle_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(clone_fsu_cycle_details)

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

#create_fsu_action(create_fsu_action_details, opts = {}) ⇒ Response

Note:

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

Creates a new Exadata Fleet Update Action.

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:



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
 
# File 'lib/oci/fleet_software_update/fleet_software_update_client.rb', line 707

def create_fsu_action(create_fsu_action_details, opts = {})
  logger.debug 'Calling operation FleetSoftwareUpdateClient#create_fsu_action.' if logger

  raise "Missing the required parameter 'create_fsu_action_details' when calling create_fsu_action." if create_fsu_action_details.nil?

  path = '/fsuActions'
  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_fsu_action_details)

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

#create_fsu_collection(create_fsu_collection_details, opts = {}) ⇒ Response

Note:

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

Creates a new Exadata Fleet Update Collection.

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:



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
804
805
806
807
808
 
# File 'lib/oci/fleet_software_update/fleet_software_update_client.rb', line 771

def create_fsu_collection(create_fsu_collection_details, opts = {})
  logger.debug 'Calling operation FleetSoftwareUpdateClient#create_fsu_collection.' if logger

  raise "Missing the required parameter 'create_fsu_collection_details' when calling create_fsu_collection." if create_fsu_collection_details.nil?

  path = '/fsuCollections'
  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_fsu_collection_details)

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

#create_fsu_cycle(create_fsu_cycle_details, opts = {}) ⇒ Response

Note:

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

Creates a new Exadata Fleet Update Cycle.

Parameters:

  • create_fsu_cycle_details (OCI::FleetSoftwareUpdate::Models::CreateFsuCycleDetails) —

    Details for the new Exadata Fleet Update Maintenance Cycle. Targets can only exist in one active Fleet Software Update Maintenance Cycle.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_retry_token (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



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

def create_fsu_cycle(create_fsu_cycle_details, opts = {})
  logger.debug 'Calling operation FleetSoftwareUpdateClient#create_fsu_cycle.' if logger

  raise "Missing the required parameter 'create_fsu_cycle_details' when calling create_fsu_cycle." if create_fsu_cycle_details.nil?

  path = '/fsuCycles'
  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_fsu_cycle_details)

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

#create_fsu_discovery(create_fsu_discovery_details, opts = {}) ⇒ Response

Note:

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

Creates a new Exadata Fleet Update Discovery.

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:



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

def create_fsu_discovery(create_fsu_discovery_details, opts = {})
  logger.debug 'Calling operation FleetSoftwareUpdateClient#create_fsu_discovery.' if logger

  raise "Missing the required parameter 'create_fsu_discovery_details' when calling create_fsu_discovery." if create_fsu_discovery_details.nil?

  path = '/fsuDiscoveries'
  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_fsu_discovery_details)

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

#delete_fsu_action(fsu_action_id, opts = {}) ⇒ Response

Note:

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

Deletes a Exadata Fleet Update Action resource by identifier.

Parameters:

  • fsu_action_id (String) —

    Unique Exadata Fleet Update Action 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



964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
 
# File 'lib/oci/fleet_software_update/fleet_software_update_client.rb', line 964

def delete_fsu_action(fsu_action_id, opts = {})
  logger.debug 'Calling operation FleetSoftwareUpdateClient#delete_fsu_action.' if logger

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

  path = '/fsuActions/{fsuActionId}'.sub('{fsuActionId}', fsu_action_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: 'FleetSoftwareUpdateClient#delete_fsu_action') 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_fsu_collection(fsu_collection_id, opts = {}) ⇒ Response

Note:

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

Deletes a Exadata Fleet Update Collection resource by identifier.

Parameters:

  • fsu_collection_id (String) —

    Unique Exadata Fleet Update Collection 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



1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
 
# File 'lib/oci/fleet_software_update/fleet_software_update_client.rb', line 1027

def delete_fsu_collection(fsu_collection_id, opts = {})
  logger.debug 'Calling operation FleetSoftwareUpdateClient#delete_fsu_collection.' if logger

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

  path = '/fsuCollections/{fsuCollectionId}'.sub('{fsuCollectionId}', fsu_collection_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: 'FleetSoftwareUpdateClient#delete_fsu_collection') 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_fsu_collection_target(fsu_collection_id, target_id, opts = {}) ⇒ Response

Note:

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

Removes a target from an existing Exadata Fleet Update Collection. This operation can only be performed on Collections that do not have an Action executing under an active Fleet Software Update Cycle. Additionally, during an active Fleet Software Update Cycle, a target can be removed only prior to executing an Apply Action.

Parameters:

  • fsu_collection_id (String) —

    Unique Exadata Fleet Update Collection identifier.

  • target_id (String) —

    Target resource OCID.

  • 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



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

def delete_fsu_collection_target(fsu_collection_id, target_id, opts = {})
  logger.debug 'Calling operation FleetSoftwareUpdateClient#delete_fsu_collection_target.' if logger

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

  path = '/fsuCollections/{fsuCollectionId}/targets/{targetId}'.sub('{fsuCollectionId}', fsu_collection_id.to_s).sub('{targetId}', target_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: 'FleetSoftwareUpdateClient#delete_fsu_collection_target') 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_fsu_cycle(fsu_cycle_id, opts = {}) ⇒ Response

Note:

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

Deletes a Exadata Fleet Update Cycle resource by identifier.

Parameters:

  • fsu_cycle_id (String) —

    Unique Exadata Fleet Update Cycle 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



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

def delete_fsu_cycle(fsu_cycle_id, opts = {})
  logger.debug 'Calling operation FleetSoftwareUpdateClient#delete_fsu_cycle.' if logger

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

  path = '/fsuCycles/{fsuCycleId}'.sub('{fsuCycleId}', fsu_cycle_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: 'FleetSoftwareUpdateClient#delete_fsu_cycle') 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_fsu_discovery(fsu_discovery_id, opts = {}) ⇒ Response

Note:

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

Deletes a Exadata Fleet Update Discovery resource by identifier.

Parameters:

  • fsu_discovery_id (String) —

    Unique Exadata Fleet Update Discovery 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



1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
 
# File 'lib/oci/fleet_software_update/fleet_software_update_client.rb', line 1222

def delete_fsu_discovery(fsu_discovery_id, opts = {})
  logger.debug 'Calling operation FleetSoftwareUpdateClient#delete_fsu_discovery.' if logger

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

  path = '/fsuDiscoveries/{fsuDiscoveryId}'.sub('{fsuDiscoveryId}', fsu_discovery_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: 'FleetSoftwareUpdateClient#delete_fsu_discovery') 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_fsu_job(fsu_job_id, opts = {}) ⇒ Response

Note:

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

Deletes the Exadata Fleet Update Job resource by identifier.

Parameters:

  • fsu_job_id (String) —

    The OCID of the Exadata Fleet Update Job.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
 
# File 'lib/oci/fleet_software_update/fleet_software_update_client.rb', line 1285

def delete_fsu_job(fsu_job_id, opts = {})
  logger.debug 'Calling operation FleetSoftwareUpdateClient#delete_fsu_job.' if logger

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

  path = '/fsuJobs/{fsuJobId}'.sub('{fsuJobId}', fsu_job_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

#get_fsu_action(fsu_action_id, opts = {}) ⇒ Response

Note:

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

Gets a Exadata Fleet Update Action by identifier.

Parameters:

  • fsu_action_id (String) —

    Unique Exadata Fleet Update Action 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:



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

def get_fsu_action(fsu_action_id, opts = {})
  logger.debug 'Calling operation FleetSoftwareUpdateClient#get_fsu_action.' if logger

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

  path = '/fsuActions/{fsuActionId}'.sub('{fsuActionId}', fsu_action_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: 'FleetSoftwareUpdateClient#get_fsu_action') 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::FleetSoftwareUpdate::Models::FsuAction'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_fsu_action_output_content(fsu_action_id, opts = {}, &block) ⇒ Response

Note:

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

Gets the Exadata Fleet Update Action Output content as a binary file (string). This will only include the output from FAILED Exadata Fleet Update Jobs. No content in case there are no FAILED jobs.

Parameters:

  • fsu_action_id (String) —

    Unique Exadata Fleet Update Action identifier.

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

    the optional parameters

  • [Block] (Hash) —

    a customizable set of options

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.

  • :response_target (String, IO) —

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

Returns:

  • (Response) —

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



1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
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
 
# File 'lib/oci/fleet_software_update/fleet_software_update_client.rb', line 1402

def get_fsu_action_output_content(fsu_action_id, opts = {}, &block)
  logger.debug 'Calling operation FleetSoftwareUpdateClient#get_fsu_action_output_content.' if logger

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

  path = '/fsuActions/{fsuActionId}/output/content'.sub('{fsuActionId}', fsu_action_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'application/x-yaml'
  header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding]
  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: 'FleetSoftwareUpdateClient#get_fsu_action_output_content') do
    if !block.nil?
      @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: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @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: 'Stream',
          &proc { |chunk, _response| opts[:response_target].write(chunk) }
        )
      elsif opts[:response_target].is_a?(String)
        File.open(opts[:response_target], 'wb') do |output|
          return @api_client.call_api(
            :GET,
            path,
            endpoint,
            header_params: header_params,
            query_params: query_params,
            operation_signing_strategy: operation_signing_strategy,
            body: post_body,
            return_type: 'Stream',
            &proc { |chunk, _response| output.write(chunk) }
          )
        end
      end
    else
      @api_client.call_api(
        :GET,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'String'
      )
    end
  end
  # rubocop:enable Metrics/BlockLength
end

#get_fsu_collection(fsu_collection_id, opts = {}) ⇒ Response

Note:

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

Gets a Exadata Fleet Update Collection by identifier.

Parameters:

  • fsu_collection_id (String) —

    Unique Exadata Fleet Update Collection 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:



1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
 
# File 'lib/oci/fleet_software_update/fleet_software_update_client.rb', line 1503

def get_fsu_collection(fsu_collection_id, opts = {})
  logger.debug 'Calling operation FleetSoftwareUpdateClient#get_fsu_collection.' if logger

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

  path = '/fsuCollections/{fsuCollectionId}'.sub('{fsuCollectionId}', fsu_collection_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: 'FleetSoftwareUpdateClient#get_fsu_collection') 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::FleetSoftwareUpdate::Models::FsuCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_fsu_collection_target(fsu_collection_id, target_id, opts = {}) ⇒ Response

Note:

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

Gets a Exadata Fleet Update Collection Target by identifier.

Parameters:

  • fsu_collection_id (String) —

    Unique Exadata Fleet Update Collection identifier.

  • target_id (String) —

    Target resource OCID.

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



1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
 
# File 'lib/oci/fleet_software_update/fleet_software_update_client.rb', line 1562

def get_fsu_collection_target(fsu_collection_id, target_id, opts = {})
  logger.debug 'Calling operation FleetSoftwareUpdateClient#get_fsu_collection_target.' if logger

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

  path = '/fsuCollections/{fsuCollectionId}/targets/{targetId}'.sub('{fsuCollectionId}', fsu_collection_id.to_s).sub('{targetId}', target_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: 'FleetSoftwareUpdateClient#get_fsu_collection_target') 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::FleetSoftwareUpdate::Models::FsuCollectionTarget'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_fsu_cycle(fsu_cycle_id, opts = {}) ⇒ Response

Note:

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

Gets a Exadata Fleet Update Cycle by identifier.

Parameters:

  • fsu_cycle_id (String) —

    Unique Exadata Fleet Update Cycle 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:



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
 
# File 'lib/oci/fleet_software_update/fleet_software_update_client.rb', line 1621

def get_fsu_cycle(fsu_cycle_id, opts = {})
  logger.debug 'Calling operation FleetSoftwareUpdateClient#get_fsu_cycle.' if logger

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

  path = '/fsuCycles/{fsuCycleId}'.sub('{fsuCycleId}', fsu_cycle_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: 'FleetSoftwareUpdateClient#get_fsu_cycle') 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::FleetSoftwareUpdate::Models::FsuCycle'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_fsu_discovery(fsu_discovery_id, opts = {}) ⇒ Response

Note:

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

Gets a Exadata Fleet Update Discovery by identifier.

Parameters:

  • fsu_discovery_id (String) —

    Unique Exadata Fleet Update Discovery 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:



1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
 
# File 'lib/oci/fleet_software_update/fleet_software_update_client.rb', line 1678

def get_fsu_discovery(fsu_discovery_id, opts = {})
  logger.debug 'Calling operation FleetSoftwareUpdateClient#get_fsu_discovery.' if logger

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

  path = '/fsuDiscoveries/{fsuDiscoveryId}'.sub('{fsuDiscoveryId}', fsu_discovery_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: 'FleetSoftwareUpdateClient#get_fsu_discovery') 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::FleetSoftwareUpdate::Models::FsuDiscovery'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_fsu_job(fsu_job_id, opts = {}) ⇒ Response

Note:

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

Gets a Exadata Fleet Update Job by identifier.

Parameters:

  • fsu_job_id (String) —

    The OCID of the Exadata Fleet Update Job.

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



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
 
# File 'lib/oci/fleet_software_update/fleet_software_update_client.rb', line 1735

def get_fsu_job(fsu_job_id, opts = {})
  logger.debug 'Calling operation FleetSoftwareUpdateClient#get_fsu_job.' if logger

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

  path = '/fsuJobs/{fsuJobId}'.sub('{fsuJobId}', fsu_job_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

#get_fsu_job_output_content(fsu_job_id, opts = {}, &block) ⇒ Response

Note:

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

Get the Exadata Fleet Update Job Output content as a binary file (string).

Parameters:

  • fsu_job_id (String) —

    The OCID of the Exadata Fleet Update Job.

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

    the optional parameters

  • [Block] (Hash) —

    a customizable set of options

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.

  • :response_target (String, IO) —

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

Returns:

  • (Response) —

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



1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
 
# File 'lib/oci/fleet_software_update/fleet_software_update_client.rb', line 1794

def get_fsu_job_output_content(fsu_job_id, opts = {}, &block)
  logger.debug 'Calling operation FleetSoftwareUpdateClient#get_fsu_job_output_content.' if logger

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

  path = '/fsuJobs/{fsuJobId}/output/content'.sub('{fsuJobId}', fsu_job_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = opts[:accept] if opts[:accept]
  header_params[:accept] ||= 'application/x-yaml'
  header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding]
  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: 'FleetSoftwareUpdateClient#get_fsu_job_output_content') do
    if !block.nil?
      @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: 'Stream',
        &block
      )
    elsif opts[:response_target]
      if opts[:response_target].respond_to? :write
        @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: 'Stream',
          &proc { |chunk, _response| opts[:response_target].write(chunk) }
        )
      elsif opts[:response_target].is_a?(String)
        File.open(opts[:response_target], 'wb') do |output|
          return @api_client.call_api(
            :GET,
            path,
            endpoint,
            header_params: header_params,
            query_params: query_params,
            operation_signing_strategy: operation_signing_strategy,
            body: post_body,
            return_type: 'Stream',
            &proc { |chunk, _response| output.write(chunk) }
          )
        end
      end
    else
      @api_client.call_api(
        :GET,
        path,
        endpoint,
        header_params: header_params,
        query_params: query_params,
        operation_signing_strategy: operation_signing_strategy,
        body: post_body,
        return_type: 'String'
      )
    end
  end
  # rubocop:enable Metrics/BlockLength
end

#get_work_request(work_request_id, opts = {}) ⇒ Response

Note:

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

Gets the status of the work request with the specified ID.

Parameters:

  • work_request_id (String) —

    The ID of the asynchronous request.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
 
# File 'lib/oci/fleet_software_update/fleet_software_update_client.rb', line 1895

def get_work_request(work_request_id, opts = {})
  logger.debug 'Calling operation FleetSoftwareUpdateClient#get_work_request.' if logger

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

  path = '/workRequests/{workRequestId}'.sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

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

Note:

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

Gets a list of all Exadata Fleet Update Actions in a compartment.

Allowed values are: timeCreated, displayName

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

  • :fsu_cycle_id (String) —

    A filter to return only resources whose fsuCycleId matches the given fleetSoftwareUpdateCycleId.

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

  • :type (String) —

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

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

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

  • :sort_by (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
 
# File 'lib/oci/fleet_software_update/fleet_software_update_client.rb', line 1968

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

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

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

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

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

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

  path = '/fsuActions'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:fsuCycleId] = opts[:fsu_cycle_id] if opts[:fsu_cycle_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:type] = opts[:type] if opts[:type]
  query_params[: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: 'FleetSoftwareUpdateClient#list_fsu_actions') 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::FleetSoftwareUpdate::Models::FsuActionSummaryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_fsu_collection_targets(fsu_collection_id, opts = {}) ⇒ Response

Note:

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

Gets a list of all Targets that are members of a specific Exadata Fleet Update Collection.

Allowed values are: currentVersion, status

Parameters:

  • fsu_collection_id (String) —

    Unique Exadata Fleet Update Collection 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

  • :compartment_id (String) —

    The ID of the compartment in which to list resources.

  • :target_id (String) —

    A filter to return a resource whose target OCID matches the given OCID.

  • :status (String) —

    A filter to return only entries whose status matches the given status.

    Allowed values are: IDLE, EXECUTING_JOB, JOB_FAILED

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



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
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
 
# File 'lib/oci/fleet_software_update/fleet_software_update_client.rb', line 2064

def list_fsu_collection_targets(fsu_collection_id, opts = {})
  logger.debug 'Calling operation FleetSoftwareUpdateClient#list_fsu_collection_targets.' if logger

  raise "Missing the required parameter 'fsu_collection_id' when calling list_fsu_collection_targets." if fsu_collection_id.nil?

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

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

  if opts[:sort_by] && !%w[currentVersion status].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of currentVersion, status.'
  end
  raise "Parameter value for 'fsu_collection_id' must not be blank" if OCI::Internal::Util.blank_string?(fsu_collection_id)

  path = '/fsuCollections/{fsuCollectionId}/targets'.sub('{fsuCollectionId}', fsu_collection_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:status] = opts[:status] if opts[:status]
  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: 'FleetSoftwareUpdateClient#list_fsu_collection_targets') 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::FleetSoftwareUpdate::Models::TargetSummaryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Gets a list of all Exadata Fleet Update Collections in a compartment.

Allowed values are: timeCreated, displayName

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

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

  • :type (String) —

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

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

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

  • :sort_by (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
 
# File 'lib/oci/fleet_software_update/fleet_software_update_client.rb', line 2154

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

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

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

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

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

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

  path = '/fsuCollections'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:type] = opts[:type] if opts[:type]
  query_params[: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: 'FleetSoftwareUpdateClient#list_fsu_collections') 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::FleetSoftwareUpdate::Models::FsuCollectionSummaryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Gets a list of all Exadata Fleet Update Cycles in a compartment.

Allowed values are: timeCreated, displayName

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

  • :fsu_collection_id (String) —

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

  • :lifecycle_state (String) —

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

  • :collection_type (String) —

    A filter to return only resources whose Collection type matches the given type.

  • :display_name (String) —

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

  • :target_version (String) —

    A filter to return only entries whose targetVersion matches the given targetVersion.

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
 
# File 'lib/oci/fleet_software_update/fleet_software_update_client.rb', line 2252

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

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

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

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

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

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

  path = '/fsuCycles'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:fsuCollectionId] = opts[:fsu_collection_id] if opts[:fsu_collection_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:collectionType] = opts[:collection_type] if opts[:collection_type]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:targetVersion] = opts[:target_version] if opts[:target_version]
  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: 'FleetSoftwareUpdateClient#list_fsu_cycles') 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::FleetSoftwareUpdate::Models::FsuCycleSummaryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Returns a list of Exadata Fleet Update Discoveries resources in the specified compartment.

Allowed values are: timeCreated, displayName

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

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

  • :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. (default to timeCreated)

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
 
# File 'lib/oci/fleet_software_update/fleet_software_update_client.rb', line 2346

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

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

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

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

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

  path = '/fsuDiscoveries'
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

#list_fsu_discovery_targets(fsu_discovery_id, opts = {}) ⇒ Response

Note:

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

Gets a list of all Targets in the results of a Exadata Fleet Update Discovery.

Allowed values are: currentVersion, status

Parameters:

  • fsu_discovery_id (String) —

    Unique Exadata Fleet Update Discovery 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

  • :compartment_id (String) —

    The ID of the compartment in which to list resources.

  • :target_id (String) —

    A filter to return a resource whose target OCID matches the given OCID.

  • :status (String) —

    A filter to return only entries whose status matches the given status.

    Allowed values are: IDLE, EXECUTING_JOB, JOB_FAILED

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
 
# File 'lib/oci/fleet_software_update/fleet_software_update_client.rb', line 2436

def list_fsu_discovery_targets(fsu_discovery_id, opts = {})
  logger.debug 'Calling operation FleetSoftwareUpdateClient#list_fsu_discovery_targets.' if logger

  raise "Missing the required parameter 'fsu_discovery_id' when calling list_fsu_discovery_targets." if fsu_discovery_id.nil?

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

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

  if opts[:sort_by] && !%w[currentVersion status].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of currentVersion, status.'
  end
  raise "Parameter value for 'fsu_discovery_id' must not be blank" if OCI::Internal::Util.blank_string?(fsu_discovery_id)

  path = '/fsuDiscoveries/{fsuDiscoveryId}/targets'.sub('{fsuDiscoveryId}', fsu_discovery_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:targetId] = opts[:target_id] if opts[:target_id]
  query_params[:status] = opts[:status] if opts[:status]
  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: 'FleetSoftwareUpdateClient#list_fsu_discovery_targets') 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::FleetSoftwareUpdate::Models::TargetSummaryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_fsu_job_outputs(fsu_job_id, opts = {}) ⇒ Response

Note:

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

Lists the Exadata Fleet Update Job Output messages, if any.

Parameters:

  • fsu_job_id (String) —

    The OCID of the Exadata Fleet Update Job.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :limit (Integer) —

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

Returns:



2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
 
# File 'lib/oci/fleet_software_update/fleet_software_update_client.rb', line 2516

def list_fsu_job_outputs(fsu_job_id, opts = {})
  logger.debug 'Calling operation FleetSoftwareUpdateClient#list_fsu_job_outputs.' if logger

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

  path = '/fsuJobs/{fsuJobId}/output'.sub('{fsuJobId}', fsu_job_id.to_s)
  operation_signing_strategy = :standard

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

  # 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: 'FleetSoftwareUpdateClient#list_fsu_job_outputs') 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::FleetSoftwareUpdate::Models::FsuJobOutputSummaryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_fsu_jobs(fsu_action_id, opts = {}) ⇒ Response

Note:

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

Lists all the Exadata Fleet Update Jobs associated to the specified Exadata Fleet Update Action.

Allowed values are: timeCreated, displayName

Parameters:

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

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

  • :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. (default to timeCreated)

  • :limit (Integer) —

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

  • :page (String) —

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

  • :sort_order (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

Returns:



2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
 
# File 'lib/oci/fleet_software_update/fleet_software_update_client.rb', line 2586

def list_fsu_jobs(fsu_action_id, opts = {})
  logger.debug 'Calling operation FleetSoftwareUpdateClient#list_fsu_jobs.' if logger

  raise "Missing the required parameter 'fsu_action_id' when calling list_fsu_jobs." if fsu_action_id.nil?

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

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

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

  path = '/fsuJobs'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:fsuActionId] = fsu_action_id
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  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: 'FleetSoftwareUpdateClient#list_fsu_jobs') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::FleetSoftwareUpdate::Models::FsuJobCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_work_request_errors(work_request_id, opts = {}) ⇒ Response

Note:

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

Returns a paginated list of errors for a specified Work Request..

Allowed values are: timeAccepted

Parameters:

  • work_request_id (String) —

    The ID of the asynchronous request.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :page (String) —

    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.

  • :limit (Integer) —

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

  • :sort_by (String) —

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

  • :sort_order (String) —

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

Returns:



2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
 
# File 'lib/oci/fleet_software_update/fleet_software_update_client.rb', line 2669

def list_work_request_errors(work_request_id, opts = {})
  logger.debug 'Calling operation FleetSoftwareUpdateClient#list_work_request_errors.' if logger

  raise "Missing the required parameter 'work_request_id' when calling list_work_request_errors." if work_request_id.nil?

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

  if opts[:sort_order] && !OCI::FleetSoftwareUpdate::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::FleetSoftwareUpdate::Models::SORT_ORDER_ENUM.'
  end
  raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id)

  path = '/workRequests/{workRequestId}/errors'.sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

#list_work_request_logs(work_request_id, opts = {}) ⇒ Response

Note:

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

Returns a paginated list of logs for a specified Work Request.

Allowed values are: timeAccepted

Parameters:

  • work_request_id (String) —

    The ID of the asynchronous request.

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

    the optional parameters

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :page (String) —

    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.

  • :limit (Integer) —

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

  • :sort_by (String) —

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

  • :sort_order (String) —

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

Returns:



2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
 
# File 'lib/oci/fleet_software_update/fleet_software_update_client.rb', line 2746

def list_work_request_logs(work_request_id, opts = {})
  logger.debug 'Calling operation FleetSoftwareUpdateClient#list_work_request_logs.' if logger

  raise "Missing the required parameter 'work_request_id' when calling list_work_request_logs." if work_request_id.nil?

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

  if opts[:sort_order] && !OCI::FleetSoftwareUpdate::Models::SORT_ORDER_ENUM.include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of the values in OCI::FleetSoftwareUpdate::Models::SORT_ORDER_ENUM.'
  end
  raise "Parameter value for 'work_request_id' must not be blank" if OCI::Internal::Util.blank_string?(work_request_id)

  path = '/workRequests/{workRequestId}/logs'.sub('{workRequestId}', work_request_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = nil

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

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

Note:

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

Lists the work requests in a compartment.

Allowed values are: timeAccepted

Parameters:

  • compartment_id (String) —

    The ID of the compartment in which to list resources.

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

    the optional parameters

Options Hash (opts):

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

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

  • :work_request_id (String) —

    The ID of the asynchronous work request.

  • :status (String) —

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

  • :resource_id (String) —

    The ID of the resource affected by the work request.

  • :opc_request_id (String) —

    The client request ID for tracing.

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

  • :limit (Integer) —

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

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

Returns:



2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
 
# File 'lib/oci/fleet_software_update/fleet_software_update_client.rb', line 2829

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

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

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

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

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

  path = '/workRequests'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:workRequestId] = opts[:work_request_id] if opts[:work_request_id]
  query_params[:status] = opts[:status] if opts[:status]
  query_params[:resourceId] = opts[:resource_id] if opts[:resource_id]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:limit] = opts[:limit] if opts[:limit]
  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: 'FleetSoftwareUpdateClient#list_work_requests') do
    @api_client.call_api(
      :GET,
      path,
      endpoint,
      header_params: header_params,
      query_params: query_params,
      operation_signing_strategy: operation_signing_strategy,
      body: post_body,
      return_type: 'OCI::FleetSoftwareUpdate::Models::WorkRequestSummaryCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#logger ⇒ Logger

Returns The logger for this client. May be nil.

Returns:

  • (Logger) —

    The logger for this client. May be nil.



95
96
97
 
# File 'lib/oci/fleet_software_update/fleet_software_update_client.rb', line 95

def logger
  @api_client.config.logger
end

#remove_fsu_collection_targets(fsu_collection_id, remove_fsu_collection_targets_details, opts = {}) ⇒ Response

Note:

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

Removes targets from an existing Exadata Fleet Update Collection. This operation can only be performed on Collections that do not have an Action executing under an active Fleet Software Update Cycle. Additionally, during an active Fleet Software Update Cycle, targets can be removed only prior to executing an Apply Action.

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



2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
 
# File 'lib/oci/fleet_software_update/fleet_software_update_client.rb', line 2921

def remove_fsu_collection_targets(fsu_collection_id, remove_fsu_collection_targets_details, opts = {})
  logger.debug 'Calling operation FleetSoftwareUpdateClient#remove_fsu_collection_targets.' if logger

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

  path = '/fsuCollections/{fsuCollectionId}/targets'.sub('{fsuCollectionId}', fsu_collection_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(remove_fsu_collection_targets_details)

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

#resume_fsu_action(fsu_action_id, opts = {}) ⇒ Response

Note:

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

Resumes an Action that has batches of targets waiting to execute.

Parameters:

  • fsu_action_id (String) —

    Unique Exadata Fleet Update Action 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.

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



2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
 
# File 'lib/oci/fleet_software_update/fleet_software_update_client.rb', line 2993

def resume_fsu_action(fsu_action_id, opts = {})
  logger.debug 'Calling operation FleetSoftwareUpdateClient#resume_fsu_action.' if logger

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

  path = '/fsuActions/{fsuActionId}/actions/resume'.sub('{fsuActionId}', fsu_action_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 = nil

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

#retry_fsu_job(fsu_job_id, opts = {}) ⇒ Response

Note:

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

Retry a failed Job, only while the current Action is being executed. After the Action reaches a terminal state, a new Action of the same kind is required to retry on failed targets.

Parameters:

  • fsu_job_id (String) —

    The OCID of the Exadata Fleet Update Job.

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :opc_retry_token (String) —

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

Returns:

  • (Response) —

    A Response object with data of type nil



3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
 
# File 'lib/oci/fleet_software_update/fleet_software_update_client.rb', line 3065

def retry_fsu_job(fsu_job_id, opts = {})
  logger.debug 'Calling operation FleetSoftwareUpdateClient#retry_fsu_job.' if logger

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

  path = '/fsuJobs/{fsuJobId}/actions/retry'.sub('{fsuJobId}', fsu_job_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json'
  header_params[:'content-type'] = 'application/json'
  header_params[:'if-match'] = opts[:if_match] if opts[:if_match]
  header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id]
  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 = nil

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

#update_fsu_action(fsu_action_id, update_fsu_action_details, opts = {}) ⇒ Response

Note:

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

Updates the Exadata Fleet Update Action identified by the ID.

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



3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
 
# File 'lib/oci/fleet_software_update/fleet_software_update_client.rb', line 3132

def update_fsu_action(fsu_action_id, update_fsu_action_details, opts = {})
  logger.debug 'Calling operation FleetSoftwareUpdateClient#update_fsu_action.' if logger

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

  path = '/fsuActions/{fsuActionId}'.sub('{fsuActionId}', fsu_action_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_fsu_action_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'FleetSoftwareUpdateClient#update_fsu_action') 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_fsu_collection(fsu_collection_id, update_fsu_collection_details, opts = {}) ⇒ Response

Note:

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

Updates the Exadata Fleet Update Collection identified by the ID.

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



3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
 
# File 'lib/oci/fleet_software_update/fleet_software_update_client.rb', line 3198

def update_fsu_collection(fsu_collection_id, update_fsu_collection_details, opts = {})
  logger.debug 'Calling operation FleetSoftwareUpdateClient#update_fsu_collection.' if logger

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

  path = '/fsuCollections/{fsuCollectionId}'.sub('{fsuCollectionId}', fsu_collection_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_fsu_collection_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'FleetSoftwareUpdateClient#update_fsu_collection') 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_fsu_cycle(fsu_cycle_id, update_fsu_cycle_details, opts = {}) ⇒ Response

Note:

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

Updates the Exadata Fleet Update Cycle identified by the ID.

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



3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
 
# File 'lib/oci/fleet_software_update/fleet_software_update_client.rb', line 3264

def update_fsu_cycle(fsu_cycle_id, update_fsu_cycle_details, opts = {})
  logger.debug 'Calling operation FleetSoftwareUpdateClient#update_fsu_cycle.' if logger

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

  path = '/fsuCycles/{fsuCycleId}'.sub('{fsuCycleId}', fsu_cycle_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_fsu_cycle_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'FleetSoftwareUpdateClient#update_fsu_cycle') 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_fsu_discovery(fsu_discovery_id, update_fsu_discovery_details, opts = {}) ⇒ Response

Note:

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

Updates the Exadata Fleet Update Discovery identified by the ID.

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



3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
 
# File 'lib/oci/fleet_software_update/fleet_software_update_client.rb', line 3330

def update_fsu_discovery(fsu_discovery_id, update_fsu_discovery_details, opts = {})
  logger.debug 'Calling operation FleetSoftwareUpdateClient#update_fsu_discovery.' if logger

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

  path = '/fsuDiscoveries/{fsuDiscoveryId}'.sub('{fsuDiscoveryId}', fsu_discovery_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_fsu_discovery_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'FleetSoftwareUpdateClient#update_fsu_discovery') 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_fsu_job(fsu_job_id, update_fsu_job_details, opts = {}) ⇒ Response

Note:

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

Updates Exadata Fleet Update Job resource details.

Parameters:

Options Hash (opts):

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

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

  • :opc_request_id (String) —

    The client request ID for tracing.

  • :if_match (String) —

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

Returns:



3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
 
# File 'lib/oci/fleet_software_update/fleet_software_update_client.rb', line 3396

def update_fsu_job(fsu_job_id, update_fsu_job_details, opts = {})
  logger.debug 'Calling operation FleetSoftwareUpdateClient#update_fsu_job.' if logger

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

  path = '/fsuJobs/{fsuJobId}'.sub('{fsuJobId}', fsu_job_id.to_s)
  operation_signing_strategy = :standard

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

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

  post_body = @api_client.object_to_http_body(update_fsu_job_details)

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