Package com.oracle.bmc.iot

Interface Iot

  • All Superinterfaces:
    AutoCloseable
    All Known Implementing Classes:
    IotClient
    @Generated(value="OracleSDKGenerator",
           comments="API Version: 20250531")
public interface Iot
extends AutoCloseable
    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.

    This service client uses CircuitBreakerUtils.DEFAULT_CIRCUIT_BREAKER for all the operations by default if no circuit breaker configuration is defined by the user.

    • Method Detail

      • refreshClient

        void refreshClient()
        Rebuilds the client from scratch.

        Useful to refresh certificates.

      • setEndpoint

        void setEndpoint​(String endpoint)
        Sets the endpoint to call (ex, https://www.example.com).
        Parameters:
        endpoint - The endpoint of the service.

      • getEndpoint

        String getEndpoint()
        Gets the set endpoint for REST call (ex, https://www.example.com)

      • setRegion

        void setRegion​(Region region)
        Sets the region to call (ex, Region.US_PHOENIX_1).

        Note, this will call setEndpoint after resolving the endpoint. If the service is not available in this Region, however, an IllegalArgumentException will be raised.

        Parameters:
        region - The region of the service.

      • setRegion

        void setRegion​(String regionId)
        Sets the region to call (ex, ‘us-phoenix-1’).

        Note, this will first try to map the region ID to a known Region and call setRegion.

        If no known Region could be determined, it will create an endpoint based on the default endpoint format (Region.formatDefaultRegionEndpoint(Service, String) and then call setEndpoint.

        Parameters:
        regionId - The public region ID.

      • useRealmSpecificEndpointTemplate

        void useRealmSpecificEndpointTemplate​(boolean realmSpecificEndpointTemplateEnabled)
        Determines whether realm specific endpoint should be used or not.

        Set realmSpecificEndpointTemplateEnabled to “true” if the user wants to enable use of realm specific endpoint template, otherwise set it to “false”

        Parameters:
        realmSpecificEndpointTemplateEnabled - flag to enable the use of realm specific endpoint template

      • changeIotDomainCompartment

        ChangeIotDomainCompartmentResponse changeIotDomainCompartment​(ChangeIotDomainCompartmentRequest request)
        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:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/iot/ChangeIotDomainCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeIotDomainCompartment API.

      • changeIotDomainDataRetentionPeriod

        ChangeIotDomainDataRetentionPeriodResponse changeIotDomainDataRetentionPeriod​(ChangeIotDomainDataRetentionPeriodRequest request)
        Updates Data Retention Period of the IoT Domain.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/iot/ChangeIotDomainDataRetentionPeriodExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeIotDomainDataRetentionPeriod API.

      • changeIotDomainGroupCompartment

        ChangeIotDomainGroupCompartmentResponse changeIotDomainGroupCompartment​(ChangeIotDomainGroupCompartmentRequest request)
        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:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/iot/ChangeIotDomainGroupCompartmentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ChangeIotDomainGroupCompartment API.

      • configureIotDomainDataAccess

        ConfigureIotDomainDataAccessResponse configureIotDomainDataAccess​(ConfigureIotDomainDataAccessRequest request)
        Updates an IoT domain Data Access.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/iot/ConfigureIotDomainDataAccessExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ConfigureIotDomainDataAccess API.

      • configureIotDomainGroupDataAccess

        ConfigureIotDomainGroupDataAccessResponse configureIotDomainGroupDataAccess​(ConfigureIotDomainGroupDataAccessRequest request)
        Updates an IoT domain Group Data Access.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/iot/ConfigureIotDomainGroupDataAccessExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ConfigureIotDomainGroupDataAccess API.

      • createDigitalTwinAdapter

        CreateDigitalTwinAdapterResponse createDigitalTwinAdapter​(CreateDigitalTwinAdapterRequest request)
        Creates a new digital twin adapter.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/iot/CreateDigitalTwinAdapterExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateDigitalTwinAdapter API.

      • createDigitalTwinInstance

        CreateDigitalTwinInstanceResponse createDigitalTwinInstance​(CreateDigitalTwinInstanceRequest request)
        Creates a new digital twin instance.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/iot/CreateDigitalTwinInstanceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateDigitalTwinInstance API.

      • createDigitalTwinModel

        CreateDigitalTwinModelResponse createDigitalTwinModel​(CreateDigitalTwinModelRequest request)
        Creates a new digital twin model.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/iot/CreateDigitalTwinModelExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateDigitalTwinModel API.

      • createDigitalTwinRelationship

        CreateDigitalTwinRelationshipResponse createDigitalTwinRelationship​(CreateDigitalTwinRelationshipRequest request)
        Creates a new digital twin relationship.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/iot/CreateDigitalTwinRelationshipExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateDigitalTwinRelationship API.

      • createIotDomain

        CreateIotDomainResponse createIotDomain​(CreateIotDomainRequest request)
        Creates a new IoT domain.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/iot/CreateIotDomainExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateIotDomain API.

      • createIotDomainGroup

        CreateIotDomainGroupResponse createIotDomainGroup​(CreateIotDomainGroupRequest request)
        Creates a new IoT domain group.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/iot/CreateIotDomainGroupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use CreateIotDomainGroup API.

      • deleteDigitalTwinAdapter

        DeleteDigitalTwinAdapterResponse deleteDigitalTwinAdapter​(DeleteDigitalTwinAdapterRequest request)
        Deletes the digital twin adapter identified by the specified OCID.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/iot/DeleteDigitalTwinAdapterExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteDigitalTwinAdapter API.

      • deleteDigitalTwinInstance

        DeleteDigitalTwinInstanceResponse deleteDigitalTwinInstance​(DeleteDigitalTwinInstanceRequest request)
        Deletes the digital twin instance identified by the specified OCID.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/iot/DeleteDigitalTwinInstanceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteDigitalTwinInstance API.

      • deleteDigitalTwinModel

        DeleteDigitalTwinModelResponse deleteDigitalTwinModel​(DeleteDigitalTwinModelRequest request)
        Deletes the digital twin model identified by the specified OCID.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/iot/DeleteDigitalTwinModelExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteDigitalTwinModel API.

      • deleteDigitalTwinRelationship

        DeleteDigitalTwinRelationshipResponse deleteDigitalTwinRelationship​(DeleteDigitalTwinRelationshipRequest request)
        Deletes the digital twin relationship identified by the specified OCID.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/iot/DeleteDigitalTwinRelationshipExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteDigitalTwinRelationship API.

      • deleteIotDomain

        DeleteIotDomainResponse deleteIotDomain​(DeleteIotDomainRequest request)
        Deletes the IoT domain identified by the specified OCID.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/iot/DeleteIotDomainExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteIotDomain API.

      • deleteIotDomainGroup

        DeleteIotDomainGroupResponse deleteIotDomainGroup​(DeleteIotDomainGroupRequest request)
        Deletes the IoT domain group identified by the specified OCID.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/iot/DeleteIotDomainGroupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use DeleteIotDomainGroup API.

      • getDigitalTwinAdapter

        GetDigitalTwinAdapterResponse getDigitalTwinAdapter​(GetDigitalTwinAdapterRequest request)
        Retrieves the digital twin adapter identified by the specified OCID.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/iot/GetDigitalTwinAdapterExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetDigitalTwinAdapter API.

      • getDigitalTwinInstance

        GetDigitalTwinInstanceResponse getDigitalTwinInstance​(GetDigitalTwinInstanceRequest request)
        Retrieves the digital twin instance identified by the specified OCID.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/iot/GetDigitalTwinInstanceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetDigitalTwinInstance API.

      • getDigitalTwinInstanceContent

        GetDigitalTwinInstanceContentResponse getDigitalTwinInstanceContent​(GetDigitalTwinInstanceContentRequest request)
        Retrieves the latest snapshot data of digital twin instance identified by the specified OCID.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/iot/GetDigitalTwinInstanceContentExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetDigitalTwinInstanceContent API.

      • getDigitalTwinModel

        GetDigitalTwinModelResponse getDigitalTwinModel​(GetDigitalTwinModelRequest request)
        Retrieves the digital twin model identified by the specified OCID.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/iot/GetDigitalTwinModelExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetDigitalTwinModel API.

      • getDigitalTwinModelSpec

        GetDigitalTwinModelSpecResponse getDigitalTwinModelSpec​(GetDigitalTwinModelSpecRequest request)
        Retrieves the spec of digital twin model identified by the specified OCID.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/iot/GetDigitalTwinModelSpecExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetDigitalTwinModelSpec API.

      • getDigitalTwinRelationship

        GetDigitalTwinRelationshipResponse getDigitalTwinRelationship​(GetDigitalTwinRelationshipRequest request)
        Retrieves the digital twin relationship identified by the specified OCID.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/iot/GetDigitalTwinRelationshipExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetDigitalTwinRelationship API.

      • getIotDomain

        GetIotDomainResponse getIotDomain​(GetIotDomainRequest request)
        Retrieves the IoT domain identified by the specified OCID.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/iot/GetIotDomainExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetIotDomain API.

      • getIotDomainGroup

        GetIotDomainGroupResponse getIotDomainGroup​(GetIotDomainGroupRequest request)
        Retrieves the IoT domain group identified by the specified OCID.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/iot/GetIotDomainGroupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetIotDomainGroup API.

      • getWorkRequest

        GetWorkRequestResponse getWorkRequest​(GetWorkRequestRequest request)
        Retrieves the status of the work request with the given ID.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/iot/GetWorkRequestExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use GetWorkRequest API.

      • invokeRawCommand

        InvokeRawCommandResponse invokeRawCommand​(InvokeRawCommandRequest request)
        Invokes the raw command on the specified digital twin instance.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/iot/InvokeRawCommandExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use InvokeRawCommand API.

      • listDigitalTwinAdapters

        ListDigitalTwinAdaptersResponse listDigitalTwinAdapters​(ListDigitalTwinAdaptersRequest request)
        Retrieves a list of digital twin adapters within the specified IoT domain.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/iot/ListDigitalTwinAdaptersExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDigitalTwinAdapters API.

      • listDigitalTwinInstances

        ListDigitalTwinInstancesResponse listDigitalTwinInstances​(ListDigitalTwinInstancesRequest request)
        Retrieves a list of digital twin instances within the specified IoT domain.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/iot/ListDigitalTwinInstancesExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDigitalTwinInstances API.

      • listDigitalTwinModels

        ListDigitalTwinModelsResponse listDigitalTwinModels​(ListDigitalTwinModelsRequest request)
        Retrieves a list of digital twin models within the specified IoT domain.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/iot/ListDigitalTwinModelsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDigitalTwinModels API.

      • listDigitalTwinRelationships

        ListDigitalTwinRelationshipsResponse listDigitalTwinRelationships​(ListDigitalTwinRelationshipsRequest request)
        Retrieves a list of digital twin relationships within the specified IoT domain.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/iot/ListDigitalTwinRelationshipsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListDigitalTwinRelationships API.

      • listIotDomainGroups

        ListIotDomainGroupsResponse listIotDomainGroups​(ListIotDomainGroupsRequest request)
        Retrieves a list of IoT domain groups within the specified compartment.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/iot/ListIotDomainGroupsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListIotDomainGroups API.

      • listIotDomains

        ListIotDomainsResponse listIotDomains​(ListIotDomainsRequest request)
        Retrieves a list of IoT domains within the specified compartment.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/iot/ListIotDomainsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListIotDomains API.

      • listWorkRequestErrors

        ListWorkRequestErrorsResponse listWorkRequestErrors​(ListWorkRequestErrorsRequest request)
        Lists errors associated with the specified work request.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/iot/ListWorkRequestErrorsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequestErrors API.

      • listWorkRequestLogs

        ListWorkRequestLogsResponse listWorkRequestLogs​(ListWorkRequestLogsRequest request)
        Lists the logs associated with the specified work request.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/iot/ListWorkRequestLogsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequestLogs API.

      • listWorkRequests

        ListWorkRequestsResponse listWorkRequests​(ListWorkRequestsRequest request)
        Lists work requests in the specified compartment.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/iot/ListWorkRequestsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListWorkRequests API.

      • updateDigitalTwinAdapter

        UpdateDigitalTwinAdapterResponse updateDigitalTwinAdapter​(UpdateDigitalTwinAdapterRequest request)
        Updates the details of digital twin adapter identified by the specified OCID.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/iot/UpdateDigitalTwinAdapterExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateDigitalTwinAdapter API.

      • updateDigitalTwinInstance

        UpdateDigitalTwinInstanceResponse updateDigitalTwinInstance​(UpdateDigitalTwinInstanceRequest request)
        Updates the details of digital twin instance identified by the specified OCID.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/iot/UpdateDigitalTwinInstanceExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateDigitalTwinInstance API.

      • updateDigitalTwinModel

        UpdateDigitalTwinModelResponse updateDigitalTwinModel​(UpdateDigitalTwinModelRequest request)
        Updates the details of the digital twin model identified by the specified OCID.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/iot/UpdateDigitalTwinModelExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateDigitalTwinModel API.

      • updateDigitalTwinRelationship

        UpdateDigitalTwinRelationshipResponse updateDigitalTwinRelationship​(UpdateDigitalTwinRelationshipRequest request)
        Updates the details of digital twin relationship identified by the specified OCID.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/iot/UpdateDigitalTwinRelationshipExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateDigitalTwinRelationship API.

      • updateIotDomain

        UpdateIotDomainResponse updateIotDomain​(UpdateIotDomainRequest request)
        Updates the details of IoT domain identified by the specified OCID.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/iot/UpdateIotDomainExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateIotDomain API.

      • updateIotDomainGroup

        UpdateIotDomainGroupResponse updateIotDomainGroup​(UpdateIotDomainGroupRequest request)
        Updates the details of IoT domain group identified by the specified OCID.
        Parameters:
        request - The request object containing the details to send
        Returns:
        A response object containing details about the completed operation
        Throws:
        BmcException - when an error occurs. This operation uses RetryConfiguration.SDK_DEFAULT_RETRY_CONFIGURATION as default if no retry strategy is provided. The specifics of the default retry strategy are described here https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/javasdkconcepts.htm#javasdkconcepts_topic_Retries

        Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.75.0/iot/UpdateIotDomainGroupExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use UpdateIotDomainGroup API.

      • getWaiters

        IotWaiters getWaiters()
        Gets the pre-configured waiters available for resources for this service.
        Returns:
        The service waiters.

      • getPaginators

        IotPaginators getPaginators()
        Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.

        These paginators provide an Iterable interface so that service responses, or resources/records, can be iterated through without having to manually deal with pagination and page tokens.

        Returns:
        The service paginators.