Class: OCI::Iot::IotClient

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/iot/iot_client.rb

Overview

Use the Internet of Things (IoT) API to manage IoT domain groups, domains, and digital twin resources including models, adapters, instances, and relationships. For more information, see Internet of Things.

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

Creates a new IotClient. 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/iot/iot_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 + '/20250531'
  else
    region ||= config.region
    region ||= signer.region if signer.respond_to?(:region)
    self.region = region
  end
  logger.info "IotClient 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/iot/iot_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/iot/iot_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/iot/iot_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/iot/iot_client.rb', line 26

def retry_config
  @retry_config
end

Instance Method Details

#change_iot_domain_compartment(iot_domain_id, change_iot_domain_compartment_details, opts = {}) ⇒ Response

Note:

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

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

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.

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



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
166
167
168
 
# File 'lib/oci/iot/iot_client.rb', line 129

def change_iot_domain_compartment(iot_domain_id, change_iot_domain_compartment_details, opts = {})
  logger.debug 'Calling operation IotClient#change_iot_domain_compartment.' if logger

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

  path = '/iotDomains/{iotDomainId}/actions/changeCompartment'.sub('{iotDomainId}', iot_domain_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_iot_domain_compartment_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IotClient#change_iot_domain_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_iot_domain_data_retention_period(iot_domain_id, change_iot_domain_data_retention_period_details, opts = {}) ⇒ Response

Note:

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

Updates Data Retention Period of the IoT Domain.

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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.

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



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/oci/iot/iot_client.rb', line 202

def change_iot_domain_data_retention_period(iot_domain_id, change_iot_domain_data_retention_period_details, opts = {})
  logger.debug 'Calling operation IotClient#change_iot_domain_data_retention_period.' if logger

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

  path = '/iotDomains/{iotDomainId}/actions/changeDataRetentionPeriod'.sub('{iotDomainId}', iot_domain_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_iot_domain_data_retention_period_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IotClient#change_iot_domain_data_retention_period') 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_iot_domain_group_compartment(iot_domain_group_id, change_iot_domain_group_compartment_details, opts = {}) ⇒ Response

Note:

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

Moves an IoT domain group to a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Parameters:

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.

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



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
314
315
 
# File 'lib/oci/iot/iot_client.rb', line 276

def change_iot_domain_group_compartment(iot_domain_group_id, change_iot_domain_group_compartment_details, opts = {})
  logger.debug 'Calling operation IotClient#change_iot_domain_group_compartment.' if logger

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

  path = '/iotDomainGroups/{iotDomainGroupId}/actions/changeCompartment'.sub('{iotDomainGroupId}', iot_domain_group_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_iot_domain_group_compartment_details)

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

#configure_iot_domain_data_access(iot_domain_id, configure_iot_domain_data_access_details, opts = {}) ⇒ Response

Note:

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

Updates an IoT domain Data Access.

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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.

  • :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/iot/iot_client.rb', line 349

def configure_iot_domain_data_access(iot_domain_id, configure_iot_domain_data_access_details, opts = {})
  logger.debug 'Calling operation IotClient#configure_iot_domain_data_access.' if logger

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

  path = '/iotDomains/{iotDomainId}/actions/configureDataAccess'.sub('{iotDomainId}', iot_domain_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(configure_iot_domain_data_access_details)

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

#configure_iot_domain_group_data_access(iot_domain_group_id, configure_iot_domain_group_data_access_details, opts = {}) ⇒ Response

Note:

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

Updates an IoT domain Group Data Access.

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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.

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



422
423
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
 
# File 'lib/oci/iot/iot_client.rb', line 422

def configure_iot_domain_group_data_access(iot_domain_group_id, configure_iot_domain_group_data_access_details, opts = {})
  logger.debug 'Calling operation IotClient#configure_iot_domain_group_data_access.' if logger

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

  path = '/iotDomainGroups/{iotDomainGroupId}/actions/configureDataAccess'.sub('{iotDomainGroupId}', iot_domain_group_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(configure_iot_domain_group_data_access_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IotClient#configure_iot_domain_group_data_access') 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_digital_twin_adapter(create_digital_twin_adapter_details, opts = {}) ⇒ Response

Note:

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

Creates a new digital twin adapter.

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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.

Returns:



487
488
489
490
491
492
493
494
495
496
497
498
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
 
# File 'lib/oci/iot/iot_client.rb', line 487

def create_digital_twin_adapter(create_digital_twin_adapter_details, opts = {})
  logger.debug 'Calling operation IotClient#create_digital_twin_adapter.' if logger

  raise "Missing the required parameter 'create_digital_twin_adapter_details' when calling create_digital_twin_adapter." if create_digital_twin_adapter_details.nil?

  path = '/digitalTwinAdapters'
  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_digital_twin_adapter_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IotClient#create_digital_twin_adapter') 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::Iot::Models::DigitalTwinAdapter'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_digital_twin_instance(create_digital_twin_instance_details, opts = {}) ⇒ Response

Note:

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

Creates a new digital twin instance.

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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.

Returns:



551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
 
# File 'lib/oci/iot/iot_client.rb', line 551

def create_digital_twin_instance(create_digital_twin_instance_details, opts = {})
  logger.debug 'Calling operation IotClient#create_digital_twin_instance.' if logger

  raise "Missing the required parameter 'create_digital_twin_instance_details' when calling create_digital_twin_instance." if create_digital_twin_instance_details.nil?

  path = '/digitalTwinInstances'
  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_digital_twin_instance_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IotClient#create_digital_twin_instance') 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::Iot::Models::DigitalTwinInstance'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_digital_twin_model(create_digital_twin_model_details, opts = {}) ⇒ Response

Note:

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

Creates a new digital twin model.

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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.

Returns:



615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
 
# File 'lib/oci/iot/iot_client.rb', line 615

def create_digital_twin_model(create_digital_twin_model_details, opts = {})
  logger.debug 'Calling operation IotClient#create_digital_twin_model.' if logger

  raise "Missing the required parameter 'create_digital_twin_model_details' when calling create_digital_twin_model." if create_digital_twin_model_details.nil?

  path = '/digitalTwinModels'
  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_digital_twin_model_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IotClient#create_digital_twin_model') 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::Iot::Models::DigitalTwinModel'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_digital_twin_relationship(create_digital_twin_relationship_details, opts = {}) ⇒ Response

Note:

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

Creates a new digital twin relationship.

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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.

Returns:



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
 
# File 'lib/oci/iot/iot_client.rb', line 679

def create_digital_twin_relationship(create_digital_twin_relationship_details, opts = {})
  logger.debug 'Calling operation IotClient#create_digital_twin_relationship.' if logger

  raise "Missing the required parameter 'create_digital_twin_relationship_details' when calling create_digital_twin_relationship." if create_digital_twin_relationship_details.nil?

  path = '/digitalTwinRelationships'
  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_digital_twin_relationship_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IotClient#create_digital_twin_relationship') 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::Iot::Models::DigitalTwinRelationship'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_iot_domain(create_iot_domain_details, opts = {}) ⇒ Response

Note:

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

Creates a new IoT domain.

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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.

Returns:



743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
 
# File 'lib/oci/iot/iot_client.rb', line 743

def create_iot_domain(create_iot_domain_details, opts = {})
  logger.debug 'Calling operation IotClient#create_iot_domain.' if logger

  raise "Missing the required parameter 'create_iot_domain_details' when calling create_iot_domain." if create_iot_domain_details.nil?

  path = '/iotDomains'
  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_iot_domain_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IotClient#create_iot_domain') 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::Iot::Models::IotDomain'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#create_iot_domain_group(create_iot_domain_group_details, opts = {}) ⇒ Response

Note:

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

Creates a new IoT domain group.

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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.

Returns:



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
838
839
840
841
842
843
844
 
# File 'lib/oci/iot/iot_client.rb', line 807

def create_iot_domain_group(create_iot_domain_group_details, opts = {})
  logger.debug 'Calling operation IotClient#create_iot_domain_group.' if logger

  raise "Missing the required parameter 'create_iot_domain_group_details' when calling create_iot_domain_group." if create_iot_domain_group_details.nil?

  path = '/iotDomainGroups'
  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_iot_domain_group_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IotClient#create_iot_domain_group') 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::Iot::Models::IotDomainGroup'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#delete_digital_twin_adapter(digital_twin_adapter_id, opts = {}) ⇒ Response

Note:

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

Deletes the digital twin adapter identified by the specified OCID.

Parameters:

  • digital_twin_adapter_id (String) —

    The OCID of the digital twin adapter.

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

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



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

def delete_digital_twin_adapter(digital_twin_adapter_id, opts = {})
  logger.debug 'Calling operation IotClient#delete_digital_twin_adapter.' if logger

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

  path = '/digitalTwinAdapters/{digitalTwinAdapterId}'.sub('{digitalTwinAdapterId}', digital_twin_adapter_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: 'IotClient#delete_digital_twin_adapter') 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_digital_twin_instance(digital_twin_instance_id, opts = {}) ⇒ Response

Note:

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

Deletes the digital twin instance identified by the specified OCID.

Parameters:

  • digital_twin_instance_id (String) —

    The OCID of digital twin instance.

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

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



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

def delete_digital_twin_instance(digital_twin_instance_id, opts = {})
  logger.debug 'Calling operation IotClient#delete_digital_twin_instance.' if logger

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

  path = '/digitalTwinInstances/{digitalTwinInstanceId}'.sub('{digitalTwinInstanceId}', digital_twin_instance_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: 'IotClient#delete_digital_twin_instance') 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_digital_twin_model(digital_twin_model_id, opts = {}) ⇒ Response

Note:

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

Deletes the digital twin model identified by the specified OCID.

Parameters:

  • digital_twin_model_id (String) —

    The OCID of digital twin model.

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

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
 
# File 'lib/oci/iot/iot_client.rb', line 996

def delete_digital_twin_model(digital_twin_model_id, opts = {})
  logger.debug 'Calling operation IotClient#delete_digital_twin_model.' if logger

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

  path = '/digitalTwinModels/{digitalTwinModelId}'.sub('{digitalTwinModelId}', digital_twin_model_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: 'IotClient#delete_digital_twin_model') 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_digital_twin_relationship(digital_twin_relationship_id, opts = {}) ⇒ Response

Note:

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

Deletes the digital twin relationship identified by the specified OCID.

Parameters:

  • digital_twin_relationship_id (String) —

    The OCID of digital twin relationship.

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

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
 
# File 'lib/oci/iot/iot_client.rb', line 1058

def delete_digital_twin_relationship(digital_twin_relationship_id, opts = {})
  logger.debug 'Calling operation IotClient#delete_digital_twin_relationship.' if logger

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

  path = '/digitalTwinRelationships/{digitalTwinRelationshipId}'.sub('{digitalTwinRelationshipId}', digital_twin_relationship_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: 'IotClient#delete_digital_twin_relationship') 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_iot_domain(iot_domain_id, opts = {}) ⇒ Response

Note:

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

Deletes the IoT domain identified by the specified OCID.

Parameters:

  • iot_domain_id (String) —

    The OCID of the IoT domain.

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

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
 
# File 'lib/oci/iot/iot_client.rb', line 1120

def delete_iot_domain(iot_domain_id, opts = {})
  logger.debug 'Calling operation IotClient#delete_iot_domain.' if logger

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

  path = '/iotDomains/{iotDomainId}'.sub('{iotDomainId}', iot_domain_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: 'IotClient#delete_iot_domain') 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_iot_domain_group(iot_domain_group_id, opts = {}) ⇒ Response

Note:

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

Deletes the IoT domain group identified by the specified OCID.

Parameters:

  • iot_domain_group_id (String) —

    The OCID of an IoT Domain Group.

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

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
 
# File 'lib/oci/iot/iot_client.rb', line 1182

def delete_iot_domain_group(iot_domain_group_id, opts = {})
  logger.debug 'Calling operation IotClient#delete_iot_domain_group.' if logger

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

  path = '/iotDomainGroups/{iotDomainGroupId}'.sub('{iotDomainGroupId}', iot_domain_group_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: 'IotClient#delete_iot_domain_group') 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_digital_twin_adapter(digital_twin_adapter_id, opts = {}) ⇒ Response

Note:

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

Retrieves the digital twin adapter identified by the specified OCID.

Parameters:

  • digital_twin_adapter_id (String) —

    The OCID of the digital twin adapter.

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

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.

Returns:



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

def get_digital_twin_adapter(digital_twin_adapter_id, opts = {})
  logger.debug 'Calling operation IotClient#get_digital_twin_adapter.' if logger

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

  path = '/digitalTwinAdapters/{digitalTwinAdapterId}'.sub('{digitalTwinAdapterId}', digital_twin_adapter_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: 'IotClient#get_digital_twin_adapter') 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::Iot::Models::DigitalTwinAdapter'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_digital_twin_instance(digital_twin_instance_id, opts = {}) ⇒ Response

Note:

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

Retrieves the digital twin instance identified by the specified OCID.

Parameters:

  • digital_twin_instance_id (String) —

    The OCID of digital twin instance.

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

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.

Returns:



1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
 
# File 'lib/oci/iot/iot_client.rb', line 1296

def get_digital_twin_instance(digital_twin_instance_id, opts = {})
  logger.debug 'Calling operation IotClient#get_digital_twin_instance.' if logger

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

  path = '/digitalTwinInstances/{digitalTwinInstanceId}'.sub('{digitalTwinInstanceId}', digital_twin_instance_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: 'IotClient#get_digital_twin_instance') 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::Iot::Models::DigitalTwinInstance'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_digital_twin_instance_content(digital_twin_instance_id, opts = {}) ⇒ Response

Note:

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

Retrieves the content associated with a digital twin instance identified by the specified OCID. The content can be retrieved only when a model is associated with the digital twin instance.

Parameters:

  • digital_twin_instance_id (String) —

    The OCID of digital twin instance.

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

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.

  • :should_include_metadata (BOOLEAN) —

    If set to true , digital twin instance metadata is included in the response. (default to false)

Returns:

  • (Response) —

    A Response object with data of type Hash<String, Object>



1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
 
# File 'lib/oci/iot/iot_client.rb', line 1356

def get_digital_twin_instance_content(digital_twin_instance_id, opts = {})
  logger.debug 'Calling operation IotClient#get_digital_twin_instance_content.' if logger

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

  path = '/digitalTwinInstances/{digitalTwinInstanceId}/content'.sub('{digitalTwinInstanceId}', digital_twin_instance_id.to_s)
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:shouldIncludeMetadata] = opts[:should_include_metadata] if !opts[:should_include_metadata].nil?

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/ld+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: 'IotClient#get_digital_twin_instance_content') 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: 'Hash<String, Object>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_digital_twin_model(digital_twin_model_id, opts = {}) ⇒ Response

Note:

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

Retrieves the digital twin model identified by the specified OCID.

Parameters:

  • digital_twin_model_id (String) —

    The OCID of digital twin model.

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

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.

Returns:



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
 
# File 'lib/oci/iot/iot_client.rb', line 1413

def get_digital_twin_model(digital_twin_model_id, opts = {})
  logger.debug 'Calling operation IotClient#get_digital_twin_model.' if logger

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

  path = '/digitalTwinModels/{digitalTwinModelId}'.sub('{digitalTwinModelId}', digital_twin_model_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: 'IotClient#get_digital_twin_model') 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::Iot::Models::DigitalTwinModel'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_digital_twin_model_spec(digital_twin_model_id, opts = {}) ⇒ Response

Note:

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

Retrieves the spec of digital twin model identified by the specified OCID.

Parameters:

  • digital_twin_model_id (String) —

    The OCID of digital twin model.

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

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type Hash<String, Object>



1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
 
# File 'lib/oci/iot/iot_client.rb', line 1469

def get_digital_twin_model_spec(digital_twin_model_id, opts = {})
  logger.debug 'Calling operation IotClient#get_digital_twin_model_spec.' if logger

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

  path = '/digitalTwinModels/{digitalTwinModelId}/spec'.sub('{digitalTwinModelId}', digital_twin_model_id.to_s)
  operation_signing_strategy = :standard

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

  # Header Params
  header_params = {}
  header_params[:accept] = 'application/json, application/ld+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: 'IotClient#get_digital_twin_model_spec') 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: 'Hash<String, Object>'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_digital_twin_relationship(digital_twin_relationship_id, opts = {}) ⇒ Response

Note:

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

Retrieves the digital twin relationship identified by the specified OCID.

Parameters:

  • digital_twin_relationship_id (String) —

    The OCID of digital twin relationship.

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

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.

Returns:



1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
 
# File 'lib/oci/iot/iot_client.rb', line 1525

def get_digital_twin_relationship(digital_twin_relationship_id, opts = {})
  logger.debug 'Calling operation IotClient#get_digital_twin_relationship.' if logger

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

  path = '/digitalTwinRelationships/{digitalTwinRelationshipId}'.sub('{digitalTwinRelationshipId}', digital_twin_relationship_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: 'IotClient#get_digital_twin_relationship') 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::Iot::Models::DigitalTwinRelationship'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_iot_domain(iot_domain_id, opts = {}) ⇒ Response

Note:

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

Retrieves the IoT domain identified by the specified OCID.

Parameters:

  • iot_domain_id (String) —

    The OCID of the IoT domain.

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

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.

Returns:



1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
 
# File 'lib/oci/iot/iot_client.rb', line 1581

def get_iot_domain(iot_domain_id, opts = {})
  logger.debug 'Calling operation IotClient#get_iot_domain.' if logger

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

  path = '/iotDomains/{iotDomainId}'.sub('{iotDomainId}', iot_domain_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: 'IotClient#get_iot_domain') 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::Iot::Models::IotDomain'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#get_iot_domain_group(iot_domain_group_id, opts = {}) ⇒ Response

Note:

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

Retrieves the IoT domain group identified by the specified OCID.

Parameters:

  • iot_domain_group_id (String) —

    The OCID of an IoT Domain Group.

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

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.

Returns:



1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
 
# File 'lib/oci/iot/iot_client.rb', line 1637

def get_iot_domain_group(iot_domain_group_id, opts = {})
  logger.debug 'Calling operation IotClient#get_iot_domain_group.' if logger

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

  path = '/iotDomainGroups/{iotDomainGroupId}'.sub('{iotDomainGroupId}', iot_domain_group_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: 'IotClient#get_iot_domain_group') 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::Iot::Models::IotDomainGroup'
    )
  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.

Retrieves the status of the work request with the given ID.

Parameters:

  • work_request_id (String) —

    The OCID of the asynchronous work 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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.

Returns:



1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
 
# File 'lib/oci/iot/iot_client.rb', line 1693

def get_work_request(work_request_id, opts = {})
  logger.debug 'Calling operation IotClient#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: 'IotClient#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::Iot::Models::WorkRequest'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#invoke_raw_command(digital_twin_instance_id, invoke_raw_command_details, opts = {}) ⇒ Response

Note:

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

Invokes the raw command on the specified digital twin instance.

Parameters:

  • digital_twin_instance_id (String) —

    The OCID of digital twin instance.

  • invoke_raw_command_details (OCI::Iot::Models::InvokeRawCommandDetails) —

    Details for the raw command invocation.

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

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
 
# File 'lib/oci/iot/iot_client.rb', line 1758

def invoke_raw_command(digital_twin_instance_id, invoke_raw_command_details, opts = {})
  logger.debug 'Calling operation IotClient#invoke_raw_command.' if logger

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

  path = '/digitalTwinInstances/{digitalTwinInstanceId}/actions/invokeRawCommand'.sub('{digitalTwinInstanceId}', digital_twin_instance_id.to_s)
  operation_signing_strategy = :standard

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

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

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

#list_digital_twin_adapters(iot_domain_id, opts = {}) ⇒ Response

Note:

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

Retrieves a list of digital twin adapters within the specified IoT domain.

Parameters:

  • iot_domain_id (String) —

    The OCID of the IoT domain in which to list digital twin resources.

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

    the optional parameters

Options Hash (opts):

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

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

  • :id (String) —

    Filter resources by OCID. Must be a valid OCID of the resource type.

  • :digital_twin_model_spec_uri (String) —

    Filter resources that match the specified URI (DTMI) of the digital twin model.

  • :digital_twin_model_id (String) —

    Filter resources that match the specified OCID of the digital twin model.

  • :display_name (String) —

    Filter resources whose display name matches the specified value.

  • :lifecycle_state (String) —

    Filter resources whose lifecycleState matches the specified value.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. (default to 10)

  • :page (String) —

    Page representing the requested page of items.

  • :sort_order (String) —

    Specifies sort order to use, either ASC (ascending) or DESC (descending). Allowed values are: ASC, 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) Allowed values are: timeCreated, displayName

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.

Returns:



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
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
 
# File 'lib/oci/iot/iot_client.rb', line 1839

def list_digital_twin_adapters(iot_domain_id, opts = {})
  logger.debug 'Calling operation IotClient#list_digital_twin_adapters.' if logger

  raise "Missing the required parameter 'iot_domain_id' when calling list_digital_twin_adapters." if iot_domain_id.nil?

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

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  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 = '/digitalTwinAdapters'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:iotDomainId] = iot_domain_id
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:digitalTwinModelSpecUri] = opts[:digital_twin_model_spec_uri] if opts[:digital_twin_model_spec_uri]
  query_params[:digitalTwinModelId] = opts[:digital_twin_model_id] if opts[:digital_twin_model_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  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: 'IotClient#list_digital_twin_adapters') 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::Iot::Models::DigitalTwinAdapterCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_digital_twin_instances(iot_domain_id, opts = {}) ⇒ Response

Note:

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

Retrieves a list of digital twin instances within the specified IoT domain.

Parameters:

  • iot_domain_id (String) —

    The OCID of the IoT domain in which to list digital twin 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

  • :display_name (String) —

    Filter resources whose display name matches the specified value.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. (default to 10)

  • :page (String) —

    Page representing the requested page of items.

  • :lifecycle_state (String) —

    Filter resources whose lifecycleState matches the specified value.

  • :sort_order (String) —

    Specifies sort order to use, either ASC (ascending) or DESC (descending). Allowed values are: ASC, 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) Allowed values are: timeCreated, displayName

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.

  • :digital_twin_model_id (String) —

    Filter resources that match the specified OCID of the digital twin model.

  • :digital_twin_model_spec_uri (String) —

    Filter resources that match the specified URI (DTMI) of the digital twin model.

  • :connectivity_type (String) —

    Filter resources whose connectivityType matches the specified value.

  • :id (String) —

    Filter resources by OCID. Must be a valid OCID of the resource type.

Returns:



1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
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
 
# File 'lib/oci/iot/iot_client.rb', line 1941

def list_digital_twin_instances(iot_domain_id, opts = {})
  logger.debug 'Calling operation IotClient#list_digital_twin_instances.' if logger

  raise "Missing the required parameter 'iot_domain_id' when calling list_digital_twin_instances." if iot_domain_id.nil?

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

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  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[:connectivity_type] && !OCI::Iot::Models::DIGITAL_TWIN_INSTANCE_CONNECTIVITY_TYPE_ENUM.include?(opts[:connectivity_type])
    raise 'Invalid value for "connectivity_type", must be one of the values in OCI::Iot::Models::DIGITAL_TWIN_INSTANCE_CONNECTIVITY_TYPE_ENUM.'
  end

  path = '/digitalTwinInstances'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:iotDomainId] = iot_domain_id
  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[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:digitalTwinModelId] = opts[:digital_twin_model_id] if opts[:digital_twin_model_id]
  query_params[:digitalTwinModelSpecUri] = opts[:digital_twin_model_spec_uri] if opts[:digital_twin_model_spec_uri]
  query_params[:connectivityType] = opts[:connectivity_type] if opts[:connectivity_type]
  query_params[:id] = opts[:id] if opts[:id]

  # 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: 'IotClient#list_digital_twin_instances') 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::Iot::Models::DigitalTwinInstanceCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_digital_twin_models(iot_domain_id, opts = {}) ⇒ Response

Note:

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

Retrieves a list of digital twin models within the specified IoT domain.

Parameters:

  • iot_domain_id (String) —

    The OCID of the IoT domain in which to list digital twin resources.

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

    the optional parameters

Options Hash (opts):

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

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

  • :id (String) —

    Filter resources by OCID. Must be a valid OCID of the resource type.

  • :display_name (String) —

    Filter resources whose display name matches the specified value.

  • :spec_uri_starts_with (String) —

    Filters resources by spec URI prefix. For example, to search all versions of the dtmi:example:device;1 model, pass the prefix without the version: dtmi:example:device.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. (default to 10)

  • :page (String) —

    Page representing the requested page of items.

  • :lifecycle_state (String) —

    Filter resources whose lifecycleState matches the specified value.

  • :sort_order (String) —

    Specifies sort order to use, either ASC (ascending) or DESC (descending). Allowed values are: ASC, 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) Allowed values are: timeCreated, displayName

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.

Returns:



2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
 
# File 'lib/oci/iot/iot_client.rb', line 2044

def list_digital_twin_models(iot_domain_id, opts = {})
  logger.debug 'Calling operation IotClient#list_digital_twin_models.' if logger

  raise "Missing the required parameter 'iot_domain_id' when calling list_digital_twin_models." if iot_domain_id.nil?

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

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  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 = '/digitalTwinModels'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:iotDomainId] = iot_domain_id
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:specUriStartsWith] = opts[:spec_uri_starts_with] if opts[:spec_uri_starts_with]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[: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: 'IotClient#list_digital_twin_models') 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::Iot::Models::DigitalTwinModelCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#list_digital_twin_relationships(iot_domain_id, opts = {}) ⇒ Response

Note:

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

Retrieves a list of digital twin relationships within the specified IoT domain.

Parameters:

  • iot_domain_id (String) —

    The OCID of the IoT domain in which to list digital twin 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

  • :display_name (String) —

    Filter resources whose display name matches the specified value.

  • :content_path (String) —

    Filters resources that match the content path of the digital twin relationship.

  • :source_digital_twin_instance_id (String) —

    Filter resources that match the specified OCID of source digital twin instance.

  • :target_digital_twin_instance_id (String) —

    Filter resources that match the specified OCID of target digital twin instance.

  • :lifecycle_state (String) —

    Filter resources whose lifecycleState matches the specified value.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. (default to 10)

  • :page (String) —

    Page representing the requested page of items.

  • :sort_order (String) —

    Specifies sort order to use, either ASC (ascending) or DESC (descending). Allowed values are: ASC, 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) Allowed values are: timeCreated, displayName

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.

  • :id (String) —

    Filter resources by OCID. Must be a valid OCID of the resource type.

Returns:



2145
2146
2147
2148
2149
2150
2151
2152
2153
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
 
# File 'lib/oci/iot/iot_client.rb', line 2145

def list_digital_twin_relationships(iot_domain_id, opts = {})
  logger.debug 'Calling operation IotClient#list_digital_twin_relationships.' if logger

  raise "Missing the required parameter 'iot_domain_id' when calling list_digital_twin_relationships." if iot_domain_id.nil?

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

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  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 = '/digitalTwinRelationships'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:iotDomainId] = iot_domain_id
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:contentPath] = opts[:content_path] if opts[:content_path]
  query_params[:sourceDigitalTwinInstanceId] = opts[:source_digital_twin_instance_id] if opts[:source_digital_twin_instance_id]
  query_params[:targetDigitalTwinInstanceId] = opts[:target_digital_twin_instance_id] if opts[:target_digital_twin_instance_id]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  query_params[:limit] = opts[:limit] if opts[:limit]
  query_params[:page] = opts[:page] if opts[:page]
  query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order]
  query_params[:sortBy] = opts[:sort_by] if opts[:sort_by]
  query_params[:id] = opts[:id] if opts[:id]

  # 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: 'IotClient#list_digital_twin_relationships') 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::Iot::Models::DigitalTwinRelationshipCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Retrieves a list of IoT domain groups within the specified compartment.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment in which to list resources.

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

    the optional parameters

Options Hash (opts):

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

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

  • :id (String) —

    Filter resources by OCID. Must be a valid OCID of the resource type.

  • :display_name (String) —

    Filter resources whose display name matches the specified value.

  • :lifecycle_state (String) —

    Filter resources whose lifecycleState matches the specified value.

  • :type (String) —

    Filter resources by type. Valid values are LIGHTWEIGHT or STANDARD.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. (default to 10)

  • :page (String) —

    For list pagination: The value of the opc-next-page response header from the previous "List" call. For important details on how pagination works, see List Pagination.

  • :sort_order (String) —

    Specifies sort order to use, either ASC (ascending) or DESC (descending). Allowed values are: ASC, 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) Allowed values are: timeCreated, displayName

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.

Returns:



2244
2245
2246
2247
2248
2249
2250
2251
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
 
# File 'lib/oci/iot/iot_client.rb', line 2244

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

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

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

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

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  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 = '/iotDomainGroups'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  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: 'IotClient#list_iot_domain_groups') 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::Iot::Models::IotDomainGroupCollection'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

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

Note:

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

Retrieves a list of IoT domains within the specified compartment.

Parameters:

  • compartment_id (String) —

    The OCID of the compartment in which to list resources.

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

    the optional parameters

Options Hash (opts):

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

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

  • :id (String) —

    Filter resources by OCID. Must be a valid OCID of the resource type.

  • :iot_domain_group_id (String) —

    Filter resources that match the specified OCID of the IoT domain group.

  • :display_name (String) —

    Filter resources whose display name matches the specified value.

  • :lifecycle_state (String) —

    Filter resources whose lifecycleState matches the specified value.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. (default to 10)

  • :page (String) —

    For list pagination: The value of the opc-next-page response header from the previous "List" call. For important details on how pagination works, see List Pagination.

  • :sort_order (String) —

    Specifies sort order to use, either ASC (ascending) or DESC (descending). Allowed values are: ASC, 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) Allowed values are: timeCreated, displayName

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.

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
2401
2402
 
# File 'lib/oci/iot/iot_client.rb', line 2346

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

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

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

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  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 = '/iotDomains'
  operation_signing_strategy = :standard

  # rubocop:disable Style/NegatedIf
  # Query Params
  query_params = {}
  query_params[:compartmentId] = compartment_id
  query_params[:id] = opts[:id] if opts[:id]
  query_params[:iotDomainGroupId] = opts[:iot_domain_group_id] if opts[:iot_domain_group_id]
  query_params[:displayName] = opts[:display_name] if opts[:display_name]
  query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state]
  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: 'IotClient#list_iot_domains') 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::Iot::Models::IotDomainCollection'
    )
  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.

Lists errors associated with the specified work request.

Allowed values are: timeCreated

Parameters:

  • work_request_id (String) —

    The OCID of the asynchronous work 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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.

  • :page (String) —

    For list pagination: The value of the opc-next-page response header from the previous "List" call. For important details on how pagination works, see List Pagination.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. (default to 10)

  • :sort_by (String) —

    The field to sort by. Only one sort order can be specified. The default order for timeCreated is descending. (default to timeCreated)

  • :sort_order (String) —

    Specifies sort order to use, either ASC (ascending) or DESC (descending). Allowed values are: ASC, DESC

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
 
# File 'lib/oci/iot/iot_client.rb', line 2436

def list_work_request_errors(work_request_id, opts = {})
  logger.debug 'Calling operation IotClient#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[timeCreated].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  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: 'IotClient#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::Iot::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.

Lists the logs associated with the specified work request.

Allowed values are: timeCreated

Parameters:

  • work_request_id (String) —

    The OCID of the asynchronous work 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) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.

  • :page (String) —

    For list pagination: The value of the opc-next-page response header from the previous "List" call. For important details on how pagination works, see List Pagination.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. (default to 10)

  • :sort_by (String) —

    The field to sort by. Only one sort order can be specified. The default order for timeCreated is descending. (default to timeCreated)

  • :sort_order (String) —

    Specifies sort order to use, either ASC (ascending) or DESC (descending). Allowed values are: ASC, DESC

Returns:



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
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
 
# File 'lib/oci/iot/iot_client.rb', line 2518

def list_work_request_logs(work_request_id, opts = {})
  logger.debug 'Calling operation IotClient#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[timeCreated].include?(opts[:sort_by])
    raise 'Invalid value for "sort_by", must be one of timeCreated.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  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: 'IotClient#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::Iot::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 work requests in the specified compartment.

Allowed values are: timeAccepted

Parameters:

  • compartment_id (String) —

    The OCID of the compartment in which to list resources.

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

    the optional parameters

Options Hash (opts):

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

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

  • :id (String) —

    The OCID of the asynchronous work request.

  • :status (String) —

    A filter to return only the resources that match the given lifecycle state.

  • :resource_id (String) —

    The OCID of the resource affected by the work request.

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.

  • :page (String) —

    For list pagination: The value of the opc-next-page response header from the previous "List" call. For important details on how pagination works, see List Pagination.

  • :limit (Integer) —

    For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. (default to 10)

  • :sort_order (String) —

    Specifies sort order to use, either ASC (ascending) or DESC (descending). Allowed values are: ASC, DESC

  • :sort_by (String) —

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

Returns:



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
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
 
# File 'lib/oci/iot/iot_client.rb', line 2603

def list_work_requests(compartment_id, opts = {})
  logger.debug 'Calling operation IotClient#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::Iot::Models::OPERATION_STATUS_ENUM.include?(opts[:status])
    raise 'Invalid value for "status", must be one of the values in OCI::Iot::Models::OPERATION_STATUS_ENUM.'
  end

  if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order])
    raise 'Invalid value for "sort_order", must be one of ASC, DESC.'
  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[:id] = opts[:id] if opts[: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: 'IotClient#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::Iot::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/iot/iot_client.rb', line 95

def logger
  @api_client.config.logger
end

#update_digital_twin_adapter(digital_twin_adapter_id, update_digital_twin_adapter_details, opts = {}) ⇒ Response

Note:

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

Updates the details of digital twin adapter identified by the specified OCID.

Parameters:

  • digital_twin_adapter_id (String) —

    The OCID of the digital twin adapter.

  • update_digital_twin_adapter_details (OCI::Iot::Models::UpdateDigitalTwinAdapterDetails) —

    The digital twin adapter details to be updated.

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.

Returns:



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
2718
2719
2720
2721
2722
2723
2724
 
# File 'lib/oci/iot/iot_client.rb', line 2686

def update_digital_twin_adapter(digital_twin_adapter_id, update_digital_twin_adapter_details, opts = {})
  logger.debug 'Calling operation IotClient#update_digital_twin_adapter.' if logger

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

  path = '/digitalTwinAdapters/{digitalTwinAdapterId}'.sub('{digitalTwinAdapterId}', digital_twin_adapter_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_digital_twin_adapter_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IotClient#update_digital_twin_adapter') 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::Iot::Models::DigitalTwinAdapter'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_digital_twin_instance(digital_twin_instance_id, update_digital_twin_instance_details, opts = {}) ⇒ Response

Note:

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

Updates the details of digital twin instance identified by the specified OCID.

Parameters:

  • digital_twin_instance_id (String) —

    The OCID of digital twin instance.

  • update_digital_twin_instance_details (OCI::Iot::Models::UpdateDigitalTwinInstanceDetails) —

    The digital twin instance details to be updated.

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.

Returns:



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
 
# File 'lib/oci/iot/iot_client.rb', line 2752

def update_digital_twin_instance(digital_twin_instance_id, update_digital_twin_instance_details, opts = {})
  logger.debug 'Calling operation IotClient#update_digital_twin_instance.' if logger

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

  path = '/digitalTwinInstances/{digitalTwinInstanceId}'.sub('{digitalTwinInstanceId}', digital_twin_instance_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_digital_twin_instance_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IotClient#update_digital_twin_instance') 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::Iot::Models::DigitalTwinInstance'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_digital_twin_model(digital_twin_model_id, update_digital_twin_model_details, opts = {}) ⇒ Response

Note:

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

Updates the details of the digital twin model identified by the specified OCID.

Parameters:

  • digital_twin_model_id (String) —

    The OCID of digital twin model.

  • update_digital_twin_model_details (OCI::Iot::Models::UpdateDigitalTwinModelDetails) —

    The digital twin model details to be updated.

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.

Returns:



2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
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
 
# File 'lib/oci/iot/iot_client.rb', line 2817

def update_digital_twin_model(digital_twin_model_id, update_digital_twin_model_details, opts = {})
  logger.debug 'Calling operation IotClient#update_digital_twin_model.' if logger

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

  path = '/digitalTwinModels/{digitalTwinModelId}'.sub('{digitalTwinModelId}', digital_twin_model_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_digital_twin_model_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IotClient#update_digital_twin_model') 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::Iot::Models::DigitalTwinModel'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_digital_twin_relationship(digital_twin_relationship_id, update_digital_twin_relationship_details, opts = {}) ⇒ Response

Note:

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

Updates the details of digital twin relationship identified by the specified OCID.

Parameters:

  • digital_twin_relationship_id (String) —

    The OCID of digital twin relationship.

  • update_digital_twin_relationship_details (OCI::Iot::Models::UpdateDigitalTwinRelationshipDetails) —

    The digital twin relationship details to be updated.

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.

Returns:



2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
 
# File 'lib/oci/iot/iot_client.rb', line 2882

def update_digital_twin_relationship(digital_twin_relationship_id, update_digital_twin_relationship_details, opts = {})
  logger.debug 'Calling operation IotClient#update_digital_twin_relationship.' if logger

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

  path = '/digitalTwinRelationships/{digitalTwinRelationshipId}'.sub('{digitalTwinRelationshipId}', digital_twin_relationship_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_digital_twin_relationship_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IotClient#update_digital_twin_relationship') 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::Iot::Models::DigitalTwinRelationship'
    )
  end
  # rubocop:enable Metrics/BlockLength
end

#update_iot_domain(iot_domain_id, update_iot_domain_details, opts = {}) ⇒ Response

Note:

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

Updates the details of IoT domain identified by the specified OCID.

Parameters:

  • iot_domain_id (String) —

    The OCID of the IoT domain.

  • update_iot_domain_details (OCI::Iot::Models::UpdateIotDomainDetails) —

    The IoT domain details to be updated.

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
 
# File 'lib/oci/iot/iot_client.rb', line 2947

def update_iot_domain(iot_domain_id, update_iot_domain_details, opts = {})
  logger.debug 'Calling operation IotClient#update_iot_domain.' if logger

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

  path = '/iotDomains/{iotDomainId}'.sub('{iotDomainId}', iot_domain_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_iot_domain_details)

  # rubocop:disable Metrics/BlockLength
  OCI::Retry.make_retrying_call(applicable_retry_config(opts), call_name: 'IotClient#update_iot_domain') 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_iot_domain_group(iot_domain_group_id, update_iot_domain_group_details, opts = {}) ⇒ Response

Note:

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

Updates the details of IoT domain group identified by the specified OCID.

Parameters:

  • iot_domain_group_id (String) —

    The OCID of an IoT Domain Group.

  • update_iot_domain_group_details (OCI::Iot::Models::UpdateIotDomainGroupDetails) —

    The IoT domain group details to be updated.

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

    the optional parameters

Options Hash (opts):

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

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

  • :if_match (String) —

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

  • :opc_request_id (String) —

    Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID.

Returns:

  • (Response) —

    A Response object with data of type nil



3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
 
# File 'lib/oci/iot/iot_client.rb', line 3011

def update_iot_domain_group(iot_domain_group_id, update_iot_domain_group_details, opts = {})
  logger.debug 'Calling operation IotClient#update_iot_domain_group.' if logger

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

  path = '/iotDomainGroups/{iotDomainGroupId}'.sub('{iotDomainGroupId}', iot_domain_group_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_iot_domain_group_details)

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