Class IotClient

Service client instance for Iot.

Inheritance

object

ClientBase

RegionalClientBase

IotClient

Implements

IDisposable

Inherited Members

RegionalClientBase.logger

RegionalClientBase.SetRegion(Region)

RegionalClientBase.SetRegion(string)

RegionalClientBase.UseRealmSpecificEndpointTemplate(bool)

RegionalClientBase.PopulateServiceParametersInEndpointTemplate(RestClient, Dictionary<string, object>)

RegionalClientBase.parseEndpointForParameters(string)

ClientBase.restClient

ClientBase.service

ClientBase.userAgent

ClientBase.Dispose()

ClientBase.Dispose(bool)

ClientBase.SetEndpoint(string)

ClientBase.GetEndpoint()

ClientBase.GetUserAgent()

ClientBase.SetRealmSpecificEndpointTemplate(string)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.IotService

Assembly: OCI.DotNetSDK.Iot.dll

Syntax

public class IotClient : RegionalClientBase, IDisposable

Constructors

IotClient(IBasicAuthenticationDetailsProvider, ClientConfiguration, string)

Creates a new service instance using the given authentication provider and/or client configuration and/or endpoint. A client configuration can also be provided optionally to adjust REST client behaviors.

Declaration

public IotClient(IBasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration clientConfiguration = null, string endpoint = null)

Parameters

Type	Name	Description
IBasicAuthenticationDetailsProvider	authenticationDetailsProvider	The authentication details provider. Required.
ClientConfiguration	clientConfiguration	The client configuration that contains settings to adjust REST client behaviors. Optional.
string	endpoint	The endpoint of the service. If not provided and the client is a regional client, the endpoint will be constructed based on region information. Optional.

Properties

Paginators

Declaration

public IotPaginators Paginators { get; }

Property Value

Type	Description
IotPaginators

Waiters

Declaration

public IotWaiters Waiters { get; }

Property Value

Type	Description
IotWaiters

Methods

ChangeIotDomainCompartment(ChangeIotDomainCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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.

Declaration

public Task<ChangeIotDomainCompartmentResponse> ChangeIotDomainCompartment(ChangeIotDomainCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeIotDomainCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeIotDomainCompartmentResponse>	A response object containing details about the completed operation

Examples

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

ChangeIotDomainDataRetentionPeriod(ChangeIotDomainDataRetentionPeriodRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates Data Retention Period of the IoT Domain.

Declaration

public Task<ChangeIotDomainDataRetentionPeriodResponse> ChangeIotDomainDataRetentionPeriod(ChangeIotDomainDataRetentionPeriodRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeIotDomainDataRetentionPeriodRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeIotDomainDataRetentionPeriodResponse>	A response object containing details about the completed operation

Examples

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

ChangeIotDomainGroupCompartment(ChangeIotDomainGroupCompartmentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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.

Declaration

public Task<ChangeIotDomainGroupCompartmentResponse> ChangeIotDomainGroupCompartment(ChangeIotDomainGroupCompartmentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ChangeIotDomainGroupCompartmentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ChangeIotDomainGroupCompartmentResponse>	A response object containing details about the completed operation

Examples

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

ConfigureIotDomainDataAccess(ConfigureIotDomainDataAccessRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates an IoT domain Data Access.

Declaration

public Task<ConfigureIotDomainDataAccessResponse> ConfigureIotDomainDataAccess(ConfigureIotDomainDataAccessRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ConfigureIotDomainDataAccessRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ConfigureIotDomainDataAccessResponse>	A response object containing details about the completed operation

Examples

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

ConfigureIotDomainGroupDataAccess(ConfigureIotDomainGroupDataAccessRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Updates an IoT domain Group Data Access.

Declaration

public Task<ConfigureIotDomainGroupDataAccessResponse> ConfigureIotDomainGroupDataAccess(ConfigureIotDomainGroupDataAccessRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ConfigureIotDomainGroupDataAccessRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ConfigureIotDomainGroupDataAccessResponse>	A response object containing details about the completed operation

Examples

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

CreateDigitalTwinAdapter(CreateDigitalTwinAdapterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new digital twin adapter.

Declaration

public Task<CreateDigitalTwinAdapterResponse> CreateDigitalTwinAdapter(CreateDigitalTwinAdapterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateDigitalTwinAdapterRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateDigitalTwinAdapterResponse>	A response object containing details about the completed operation

Examples

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

CreateDigitalTwinInstance(CreateDigitalTwinInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new digital twin instance.

Declaration

public Task<CreateDigitalTwinInstanceResponse> CreateDigitalTwinInstance(CreateDigitalTwinInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateDigitalTwinInstanceRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateDigitalTwinInstanceResponse>	A response object containing details about the completed operation

Examples

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

CreateDigitalTwinModel(CreateDigitalTwinModelRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new digital twin model.

Declaration

public Task<CreateDigitalTwinModelResponse> CreateDigitalTwinModel(CreateDigitalTwinModelRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateDigitalTwinModelRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateDigitalTwinModelResponse>	A response object containing details about the completed operation

Examples

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

CreateDigitalTwinRelationship(CreateDigitalTwinRelationshipRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new digital twin relationship.

Declaration

public Task<CreateDigitalTwinRelationshipResponse> CreateDigitalTwinRelationship(CreateDigitalTwinRelationshipRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateDigitalTwinRelationshipRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateDigitalTwinRelationshipResponse>	A response object containing details about the completed operation

Examples

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

CreateIotDomain(CreateIotDomainRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new IoT domain.

Declaration

public Task<CreateIotDomainResponse> CreateIotDomain(CreateIotDomainRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateIotDomainRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateIotDomainResponse>	A response object containing details about the completed operation

Examples

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

CreateIotDomainGroup(CreateIotDomainGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Creates a new IoT domain group.

Declaration

public Task<CreateIotDomainGroupResponse> CreateIotDomainGroup(CreateIotDomainGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
CreateIotDomainGroupRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<CreateIotDomainGroupResponse>	A response object containing details about the completed operation

Examples

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

DeleteDigitalTwinAdapter(DeleteDigitalTwinAdapterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the digital twin adapter identified by the specified OCID.

Declaration

public Task<DeleteDigitalTwinAdapterResponse> DeleteDigitalTwinAdapter(DeleteDigitalTwinAdapterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteDigitalTwinAdapterRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteDigitalTwinAdapterResponse>	A response object containing details about the completed operation

Examples

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

DeleteDigitalTwinInstance(DeleteDigitalTwinInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the digital twin instance identified by the specified OCID.

Declaration

public Task<DeleteDigitalTwinInstanceResponse> DeleteDigitalTwinInstance(DeleteDigitalTwinInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteDigitalTwinInstanceRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteDigitalTwinInstanceResponse>	A response object containing details about the completed operation

Examples

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

DeleteDigitalTwinModel(DeleteDigitalTwinModelRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the digital twin model identified by the specified OCID.

Declaration

public Task<DeleteDigitalTwinModelResponse> DeleteDigitalTwinModel(DeleteDigitalTwinModelRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteDigitalTwinModelRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteDigitalTwinModelResponse>	A response object containing details about the completed operation

Examples

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

DeleteDigitalTwinRelationship(DeleteDigitalTwinRelationshipRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the digital twin relationship identified by the specified OCID.

Declaration

public Task<DeleteDigitalTwinRelationshipResponse> DeleteDigitalTwinRelationship(DeleteDigitalTwinRelationshipRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteDigitalTwinRelationshipRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteDigitalTwinRelationshipResponse>	A response object containing details about the completed operation

Examples

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

DeleteIotDomain(DeleteIotDomainRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the IoT domain identified by the specified OCID.

Declaration

public Task<DeleteIotDomainResponse> DeleteIotDomain(DeleteIotDomainRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteIotDomainRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteIotDomainResponse>	A response object containing details about the completed operation

Examples

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

DeleteIotDomainGroup(DeleteIotDomainGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Deletes the IoT domain group identified by the specified OCID.

Declaration

public Task<DeleteIotDomainGroupResponse> DeleteIotDomainGroup(DeleteIotDomainGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
DeleteIotDomainGroupRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<DeleteIotDomainGroupResponse>	A response object containing details about the completed operation

Examples

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

GetDigitalTwinAdapter(GetDigitalTwinAdapterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves the digital twin adapter identified by the specified OCID.

Declaration

public Task<GetDigitalTwinAdapterResponse> GetDigitalTwinAdapter(GetDigitalTwinAdapterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetDigitalTwinAdapterRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetDigitalTwinAdapterResponse>	A response object containing details about the completed operation

Examples

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

GetDigitalTwinInstance(GetDigitalTwinInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves the digital twin instance identified by the specified OCID.

Declaration

public Task<GetDigitalTwinInstanceResponse> GetDigitalTwinInstance(GetDigitalTwinInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetDigitalTwinInstanceRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetDigitalTwinInstanceResponse>	A response object containing details about the completed operation

Examples

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

GetDigitalTwinInstanceContent(GetDigitalTwinInstanceContentRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves the latest snapshot data of digital twin instance identified by the specified OCID.

Declaration

public Task<GetDigitalTwinInstanceContentResponse> GetDigitalTwinInstanceContent(GetDigitalTwinInstanceContentRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetDigitalTwinInstanceContentRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetDigitalTwinInstanceContentResponse>	A response object containing details about the completed operation

Examples

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

GetDigitalTwinModel(GetDigitalTwinModelRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves the digital twin model identified by the specified OCID.

Declaration

public Task<GetDigitalTwinModelResponse> GetDigitalTwinModel(GetDigitalTwinModelRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetDigitalTwinModelRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetDigitalTwinModelResponse>	A response object containing details about the completed operation

Examples

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

GetDigitalTwinModelSpec(GetDigitalTwinModelSpecRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<GetDigitalTwinModelSpecResponse> GetDigitalTwinModelSpec(GetDigitalTwinModelSpecRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetDigitalTwinModelSpecRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetDigitalTwinModelSpecResponse>	A response object containing details about the completed operation

Examples

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

GetDigitalTwinRelationship(GetDigitalTwinRelationshipRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves the digital twin relationship identified by the specified OCID.

Declaration

public Task<GetDigitalTwinRelationshipResponse> GetDigitalTwinRelationship(GetDigitalTwinRelationshipRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetDigitalTwinRelationshipRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetDigitalTwinRelationshipResponse>	A response object containing details about the completed operation

Examples

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

GetIotDomain(GetIotDomainRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves the IoT domain identified by the specified OCID.

Declaration

public Task<GetIotDomainResponse> GetIotDomain(GetIotDomainRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetIotDomainRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetIotDomainResponse>	A response object containing details about the completed operation

Examples

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

GetIotDomainGroup(GetIotDomainGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves the IoT domain group identified by the specified OCID.

Declaration

public Task<GetIotDomainGroupResponse> GetIotDomainGroup(GetIotDomainGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetIotDomainGroupRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetIotDomainGroupResponse>	A response object containing details about the completed operation

Examples

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

GetWorkRequest(GetWorkRequestRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<GetWorkRequestResponse> GetWorkRequest(GetWorkRequestRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
GetWorkRequestRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<GetWorkRequestResponse>	A response object containing details about the completed operation

Examples

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

InvokeRawCommand(InvokeRawCommandRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Invokes the raw command on the specified digital twin instance.

Declaration

public Task<InvokeRawCommandResponse> InvokeRawCommand(InvokeRawCommandRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
InvokeRawCommandRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<InvokeRawCommandResponse>	A response object containing details about the completed operation

Examples

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

ListDigitalTwinAdapters(ListDigitalTwinAdaptersRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<ListDigitalTwinAdaptersResponse> ListDigitalTwinAdapters(ListDigitalTwinAdaptersRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListDigitalTwinAdaptersRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListDigitalTwinAdaptersResponse>	A response object containing details about the completed operation

Examples

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

ListDigitalTwinInstances(ListDigitalTwinInstancesRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<ListDigitalTwinInstancesResponse> ListDigitalTwinInstances(ListDigitalTwinInstancesRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListDigitalTwinInstancesRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListDigitalTwinInstancesResponse>	A response object containing details about the completed operation

Examples

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

ListDigitalTwinModels(ListDigitalTwinModelsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<ListDigitalTwinModelsResponse> ListDigitalTwinModels(ListDigitalTwinModelsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListDigitalTwinModelsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListDigitalTwinModelsResponse>	A response object containing details about the completed operation

Examples

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

ListDigitalTwinRelationships(ListDigitalTwinRelationshipsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<ListDigitalTwinRelationshipsResponse> ListDigitalTwinRelationships(ListDigitalTwinRelationshipsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListDigitalTwinRelationshipsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListDigitalTwinRelationshipsResponse>	A response object containing details about the completed operation

Examples

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

ListIotDomainGroups(ListIotDomainGroupsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<ListIotDomainGroupsResponse> ListIotDomainGroups(ListIotDomainGroupsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListIotDomainGroupsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListIotDomainGroupsResponse>	A response object containing details about the completed operation

Examples

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

ListIotDomains(ListIotDomainsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Retrieves a list of IoT domains within the specified compartment.

Declaration

public Task<ListIotDomainsResponse> ListIotDomains(ListIotDomainsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListIotDomainsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListIotDomainsResponse>	A response object containing details about the completed operation

Examples

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

ListWorkRequestErrors(ListWorkRequestErrorsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists errors associated with the specified work request.

Declaration

public Task<ListWorkRequestErrorsResponse> ListWorkRequestErrors(ListWorkRequestErrorsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListWorkRequestErrorsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListWorkRequestErrorsResponse>	A response object containing details about the completed operation

Examples

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

ListWorkRequestLogs(ListWorkRequestLogsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists the logs associated with the specified work request.

Declaration

public Task<ListWorkRequestLogsResponse> ListWorkRequestLogs(ListWorkRequestLogsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListWorkRequestLogsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListWorkRequestLogsResponse>	A response object containing details about the completed operation

Examples

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

ListWorkRequests(ListWorkRequestsRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

Lists work requests in the specified compartment.

Declaration

public Task<ListWorkRequestsResponse> ListWorkRequests(ListWorkRequestsRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
ListWorkRequestsRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<ListWorkRequestsResponse>	A response object containing details about the completed operation

Examples

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

UpdateDigitalTwinAdapter(UpdateDigitalTwinAdapterRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<UpdateDigitalTwinAdapterResponse> UpdateDigitalTwinAdapter(UpdateDigitalTwinAdapterRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateDigitalTwinAdapterRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateDigitalTwinAdapterResponse>	A response object containing details about the completed operation

Examples

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

UpdateDigitalTwinInstance(UpdateDigitalTwinInstanceRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<UpdateDigitalTwinInstanceResponse> UpdateDigitalTwinInstance(UpdateDigitalTwinInstanceRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateDigitalTwinInstanceRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateDigitalTwinInstanceResponse>	A response object containing details about the completed operation

Examples

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

UpdateDigitalTwinModel(UpdateDigitalTwinModelRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<UpdateDigitalTwinModelResponse> UpdateDigitalTwinModel(UpdateDigitalTwinModelRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateDigitalTwinModelRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateDigitalTwinModelResponse>	A response object containing details about the completed operation

Examples

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

UpdateDigitalTwinRelationship(UpdateDigitalTwinRelationshipRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<UpdateDigitalTwinRelationshipResponse> UpdateDigitalTwinRelationship(UpdateDigitalTwinRelationshipRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateDigitalTwinRelationshipRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateDigitalTwinRelationshipResponse>	A response object containing details about the completed operation

Examples

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

UpdateIotDomain(UpdateIotDomainRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<UpdateIotDomainResponse> UpdateIotDomain(UpdateIotDomainRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateIotDomainRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateIotDomainResponse>	A response object containing details about the completed operation

Examples

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

UpdateIotDomainGroup(UpdateIotDomainGroupRequest, RetryConfiguration, CancellationToken, HttpCompletionOption)

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

Declaration

public Task<UpdateIotDomainGroupResponse> UpdateIotDomainGroup(UpdateIotDomainGroupRequest request, RetryConfiguration retryConfiguration = null, CancellationToken cancellationToken = default, HttpCompletionOption completionOption = HttpCompletionOption.ResponseContentRead)

Parameters

Type	Name	Description
UpdateIotDomainGroupRequest	request	The request object containing the details to send. Required.
RetryConfiguration	retryConfiguration	The retry configuration that will be used by to send this request. Optional.
CancellationToken	cancellationToken	The cancellation token to cancel this operation. Optional.
HttpCompletionOption	completionOption	The completion option for this operation. Optional.

Returns

Type	Description
Task<UpdateIotDomainGroupResponse>	A response object containing details about the completed operation

Examples

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

Implements

IDisposable