Class: OCI::ComputeCloudAtCustomer::ComputeCloudAtCustomerClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/compute_cloud_at_customer/compute_cloud_at_customer_client.rb

Overview

Use the Compute Cloud@Customer API to manage Compute Cloud@Customer infrastructures and upgrade schedules. For more information see Compute Cloud@Customer documentation.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Creates a new ComputeCloudAtCustomerClient. 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/compute_cloud_at_customer/compute_cloud_at_customer_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 + '/20221208'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "ComputeCloudAtCustomerClient 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/compute_cloud_at_customer/compute_cloud_at_customer_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/compute_cloud_at_customer/compute_cloud_at_customer_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/compute_cloud_at_customer/compute_cloud_at_customer_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/compute_cloud_at_customer/compute_cloud_at_customer_client.rb', line 26

def retry_config
  @retry_config
end

Instance Method Details

#change_ccc_infrastructure_compartment(ccc_infrastructure_id, change_ccc_infrastructure_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves a Compute Cloud@Customer infrastructure resource from one compartment to another.

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_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 OCID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



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
166
167
168
169
170
 
# File 'lib/oci/compute_cloud_at_customer/compute_cloud_at_customer_client.rb', line 131

def change_ccc_infrastructure_compartment(ccc_infrastructure_id, change_ccc_infrastructure_compartment_details, opts = {})
  logger.debug 'Calling operation ComputeCloudAtCustomerClient#change_ccc_infrastructure_compartment.' if logger

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

  path = '/cccInfrastructures/{cccInfrastructureId}/actions/changeCompartment'.sub('{cccInfrastructureId}', ccc_infrastructure_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-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(change_ccc_infrastructure_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'ComputeCloudAtCustomerClient#change_ccc_infrastructure_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_ccc_upgrade_schedule_compartment(ccc_upgrade_schedule_id, change_ccc_upgrade_schedule_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves a Compute Cloud@Customer upgrade schedule from one compartment to another using the specified OCID.

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_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 OCID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



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
243
244
245
246
247
 
# File 'lib/oci/compute_cloud_at_customer/compute_cloud_at_customer_client.rb', line 208

def change_ccc_upgrade_schedule_compartment(ccc_upgrade_schedule_id, change_ccc_upgrade_schedule_compartment_details, opts = {})
  logger.debug 'Calling operation ComputeCloudAtCustomerClient#change_ccc_upgrade_schedule_compartment.' if logger

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

  path = '/cccUpgradeSchedules/{cccUpgradeScheduleId}/actions/changeCompartment'.sub('{cccUpgradeScheduleId}', ccc_upgrade_schedule_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-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(change_ccc_upgrade_schedule_compartment_details)

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

#create_ccc_infrastructure(create_ccc_infrastructure_details, opts = {}) ⇒ Response

Note:

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

Creates a Compute Cloud@Customer infrastructure. Once created, Oracle Services must connect the rack in the data center to this Oracle Cloud Infrastructure 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

  • :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 OCID for tracing.

Returns:



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

def create_ccc_infrastructure(create_ccc_infrastructure_details, opts = {})
  logger.debug 'Calling operation ComputeCloudAtCustomerClient#create_ccc_infrastructure.' if logger

  raise "Missing the required parameter 'create_ccc_infrastructure_details' when calling create_ccc_infrastructure." if create_ccc_infrastructure_details.nil?

  path = '/cccInfrastructures'
  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_ccc_infrastructure_details)

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

#create_ccc_upgrade_schedule(create_ccc_upgrade_schedule_details, opts = {}) ⇒ Response

Note:

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

Creates a new Compute Cloud@Customer upgrade schedule.

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 OCID for tracing.

Returns:



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/oci/compute_cloud_at_customer/compute_cloud_at_customer_client.rb', line 337

def create_ccc_upgrade_schedule(create_ccc_upgrade_schedule_details, opts = {})
  logger.debug 'Calling operation ComputeCloudAtCustomerClient#create_ccc_upgrade_schedule.' if logger

  raise "Missing the required parameter 'create_ccc_upgrade_schedule_details' when calling create_ccc_upgrade_schedule." if create_ccc_upgrade_schedule_details.nil?

  path = '/cccUpgradeSchedules'
  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_ccc_upgrade_schedule_details)

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

#delete_ccc_infrastructure(ccc_infrastructure_id, opts = {}) ⇒ Response

Note:

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

Deletes a Compute Cloud@Customer infrastructure resource specified by the resource OCID.

Parameters:

  • ccc_infrastructure_id (String) —

    An OCID for a Compute Cloud@Customer Infrastructure.

  • 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 OCID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'lib/oci/compute_cloud_at_customer/compute_cloud_at_customer_client.rb', line 403

def delete_ccc_infrastructure(ccc_infrastructure_id, opts = {})
  logger.debug 'Calling operation ComputeCloudAtCustomerClient#delete_ccc_infrastructure.' if logger

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

  path = '/cccInfrastructures/{cccInfrastructureId}'.sub('{cccInfrastructureId}', ccc_infrastructure_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: 'ComputeCloudAtCustomerClient#delete_ccc_infrastructure') 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_ccc_upgrade_schedule(ccc_upgrade_schedule_id, opts = {}) ⇒ Response

Note:

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

Deletes a Compute Cloud@Customer upgrade schedule by the specified OCID.

Parameters:

  • ccc_upgrade_schedule_id (String) —

    Compute Cloud@Customer upgrade schedule 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 OCID for tracing.

Returns:

  • (Response) —

    A Response object with data of type nil



468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
 
# File 'lib/oci/compute_cloud_at_customer/compute_cloud_at_customer_client.rb', line 468

def delete_ccc_upgrade_schedule(ccc_upgrade_schedule_id, opts = {})
  logger.debug 'Calling operation ComputeCloudAtCustomerClient#delete_ccc_upgrade_schedule.' if logger

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

  path = '/cccUpgradeSchedules/{cccUpgradeScheduleId}'.sub('{cccUpgradeScheduleId}', ccc_upgrade_schedule_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: 'ComputeCloudAtCustomerClient#delete_ccc_upgrade_schedule') 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_ccc_infrastructure(ccc_infrastructure_id, opts = {}) ⇒ Response

Note:

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

Gets a Compute Cloud@Customer infrastructure using the infrastructure OCID.

Parameters:

  • ccc_infrastructure_id (String) —

    An OCID for a Compute Cloud@Customer Infrastructure.

  • 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 OCID for tracing.

Returns:



527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
 
# File 'lib/oci/compute_cloud_at_customer/compute_cloud_at_customer_client.rb', line 527

def get_ccc_infrastructure(ccc_infrastructure_id, opts = {})
  logger.debug 'Calling operation ComputeCloudAtCustomerClient#get_ccc_infrastructure.' if logger

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

  path = '/cccInfrastructures/{cccInfrastructureId}'.sub('{cccInfrastructureId}', ccc_infrastructure_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: 'ComputeCloudAtCustomerClient#get_ccc_infrastructure') 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::ComputeCloudAtCustomer::Models::CccInfrastructure'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_ccc_upgrade_schedule(ccc_upgrade_schedule_id, opts = {}) ⇒ Response

Note:

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

Gets a Compute Cloud@Customer upgrade schedule by the specified OCID.

Parameters:

  • ccc_upgrade_schedule_id (String) —

    Compute Cloud@Customer upgrade schedule 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 OCID for tracing.

Returns:



586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
 
# File 'lib/oci/compute_cloud_at_customer/compute_cloud_at_customer_client.rb', line 586

def get_ccc_upgrade_schedule(ccc_upgrade_schedule_id, opts = {})
  logger.debug 'Calling operation ComputeCloudAtCustomerClient#get_ccc_upgrade_schedule.' if logger

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

  path = '/cccUpgradeSchedules/{cccUpgradeScheduleId}'.sub('{cccUpgradeScheduleId}', ccc_upgrade_schedule_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: 'ComputeCloudAtCustomerClient#get_ccc_upgrade_schedule') 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::ComputeCloudAtCustomer::Models::CccUpgradeSchedule'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_ccc_infrastructures(opts = {}) ⇒ Response

Note:

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

Returns a list of Compute Cloud@Customer infrastructures.

Allowed values are: timeCreated, displayName

Parameters:

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

    the optional parameters

Options Hash (opts):

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

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

  • :compartment_id (String) —

    The OCID of the compartment in which to list resources.

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and sub-compartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :lifecycle_state (String) —

    A filter used to return only resources that match the given lifecycleState.

  • :display_name (String) —

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

  • :display_name_contains (String) —

    A filter to return only resources whose display name contains the substring.

  • :ccc_infrastructure_id (String) —

    An OCID for a Compute Cloud@Customer Infrastructure.

  • :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 OCID for tracing.

Returns:



668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
 
# File 'lib/oci/compute_cloud_at_customer/compute_cloud_at_customer_client.rb', line 668

def list_ccc_infrastructures(opts = {})
  logger.debug 'Calling operation ComputeCloudAtCustomerClient#list_ccc_infrastructures.' if logger


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

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

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

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:displayNameContains] = opts[:display_name_contains] if opts[:display_name_contains]
  query_params[:cccInfrastructureId] = opts[:ccc_infrastructure_id] if opts[:ccc_infrastructure_id]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]

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

  post_body = nil

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

#list_ccc_upgrade_schedules(opts = {}) ⇒ Response

Note:

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

Returns a list of Compute Cloud@Customer upgrade schedules.

Allowed values are: timeCreated, displayName

Parameters:

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

    the optional parameters

Options Hash (opts):

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

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

  • :ccc_upgrade_schedule_id (String) —

    Compute Cloud@Customer upgrade schedule OCID.

  • :compartment_id (String) —

    The OCID of the compartment in which to list resources.

  • :compartment_id_in_subtree (BOOLEAN) —

    Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and sub-compartments in the tenancy are returned. Depends on the 'accessLevel' setting. (default to false)

  • :access_level (String) —

    Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. (default to RESTRICTED) Allowed values are: RESTRICTED, ACCESSIBLE

  • :lifecycle_state (String) —

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

  • :display_name (String) —

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

  • :display_name_contains (String) —

    A filter to return only resources whose display name contains the substring.

  • :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 OCID for tracing.

Returns:



776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
 
# File 'lib/oci/compute_cloud_at_customer/compute_cloud_at_customer_client.rb', line 776

def list_ccc_upgrade_schedules(opts = {})
  logger.debug 'Calling operation ComputeCloudAtCustomerClient#list_ccc_upgrade_schedules.' if logger


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

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

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

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:cccUpgradeScheduleId] = opts[:ccc_upgrade_schedule_id] if opts[:ccc_upgrade_schedule_id]
  query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id]
  query_params[:compartmentIdInSubtree] = opts[:compartment_id_in_subtree] if !opts[:compartment_id_in_subtree].nil?
  query_params[:accessLevel] = opts[:access_level] if opts[:access_level]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:displayNameContains] = opts[:display_name_contains] if opts[:display_name_contains]
  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: 'ComputeCloudAtCustomerClient#list_ccc_upgrade_schedules') 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::ComputeCloudAtCustomer::Models::CccUpgradeScheduleCollection'
    )
  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/compute_cloud_at_customer/compute_cloud_at_customer_client.rb', line 95

def logger
  @api_client.config.logger
end

#update_ccc_infrastructure(ccc_infrastructure_id, update_ccc_infrastructure_details, opts = {}) ⇒ Response

Note:

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

Updates Compute Cloud@Customer infrastructure 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 OCID for tracing.

Returns:



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

def update_ccc_infrastructure(ccc_infrastructure_id, update_ccc_infrastructure_details, opts = {})
  logger.debug 'Calling operation ComputeCloudAtCustomerClient#update_ccc_infrastructure.' if logger

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

  path = '/cccInfrastructures/{cccInfrastructureId}'.sub('{cccInfrastructureId}', ccc_infrastructure_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_ccc_infrastructure_details)

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

#update_ccc_upgrade_schedule(ccc_upgrade_schedule_id, update_ccc_upgrade_schedule_details, opts = {}) ⇒ Response

Note:

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

Updates the Compute Cloud@Customer upgrade schedule.

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 OCID for tracing.

Returns:



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

def update_ccc_upgrade_schedule(ccc_upgrade_schedule_id, update_ccc_upgrade_schedule_details, opts = {})
  logger.debug 'Calling operation ComputeCloudAtCustomerClient#update_ccc_upgrade_schedule.' if logger

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

  path = '/cccUpgradeSchedules/{cccUpgradeScheduleId}'.sub('{cccUpgradeScheduleId}', ccc_upgrade_schedule_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_ccc_upgrade_schedule_details)

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