Package com.oracle.bmc.iot

Interface IotAsync

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

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

      • 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

      • createDigitalTwinModel

        Future<CreateDigitalTwinModelResponse> createDigitalTwinModel​(CreateDigitalTwinModelRequest request,
                                                              AsyncHandler<CreateDigitalTwinModelRequest,​CreateDigitalTwinModelResponse> handler)
        Creates a new digital twin model.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • createIotDomain

        Future<CreateIotDomainResponse> createIotDomain​(CreateIotDomainRequest request,
                                                AsyncHandler<CreateIotDomainRequest,​CreateIotDomainResponse> handler)
        Creates a new IoT domain.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • createIotDomainGroup

        Future<CreateIotDomainGroupResponse> createIotDomainGroup​(CreateIotDomainGroupRequest request,
                                                          AsyncHandler<CreateIotDomainGroupRequest,​CreateIotDomainGroupResponse> handler)
        Creates a new IoT domain group.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • deleteDigitalTwinAdapter

        Future<DeleteDigitalTwinAdapterResponse> deleteDigitalTwinAdapter​(DeleteDigitalTwinAdapterRequest request,
                                                                  AsyncHandler<DeleteDigitalTwinAdapterRequest,​DeleteDigitalTwinAdapterResponse> handler)
        Deletes the digital twin adapter identified by the specified OCID.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • deleteDigitalTwinModel

        Future<DeleteDigitalTwinModelResponse> deleteDigitalTwinModel​(DeleteDigitalTwinModelRequest request,
                                                              AsyncHandler<DeleteDigitalTwinModelRequest,​DeleteDigitalTwinModelResponse> handler)
        Deletes the digital twin model identified by the specified OCID.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • deleteIotDomain

        Future<DeleteIotDomainResponse> deleteIotDomain​(DeleteIotDomainRequest request,
                                                AsyncHandler<DeleteIotDomainRequest,​DeleteIotDomainResponse> handler)
        Deletes the IoT domain identified by the specified OCID.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • deleteIotDomainGroup

        Future<DeleteIotDomainGroupResponse> deleteIotDomainGroup​(DeleteIotDomainGroupRequest request,
                                                          AsyncHandler<DeleteIotDomainGroupRequest,​DeleteIotDomainGroupResponse> handler)
        Deletes the IoT domain group identified by the specified OCID.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • getDigitalTwinAdapter

        Future<GetDigitalTwinAdapterResponse> getDigitalTwinAdapter​(GetDigitalTwinAdapterRequest request,
                                                            AsyncHandler<GetDigitalTwinAdapterRequest,​GetDigitalTwinAdapterResponse> handler)
        Retrieves the digital twin adapter identified by the specified OCID.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • getDigitalTwinInstance

        Future<GetDigitalTwinInstanceResponse> getDigitalTwinInstance​(GetDigitalTwinInstanceRequest request,
                                                              AsyncHandler<GetDigitalTwinInstanceRequest,​GetDigitalTwinInstanceResponse> handler)
        Retrieves the digital twin instance identified by the specified OCID.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • getDigitalTwinModel

        Future<GetDigitalTwinModelResponse> getDigitalTwinModel​(GetDigitalTwinModelRequest request,
                                                        AsyncHandler<GetDigitalTwinModelRequest,​GetDigitalTwinModelResponse> handler)
        Retrieves the digital twin model identified by the specified OCID.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • getDigitalTwinModelSpec

        Future<GetDigitalTwinModelSpecResponse> getDigitalTwinModelSpec​(GetDigitalTwinModelSpecRequest request,
                                                                AsyncHandler<GetDigitalTwinModelSpecRequest,​GetDigitalTwinModelSpecResponse> handler)
        Retrieves the spec of digital twin model identified by the specified OCID.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • getIotDomain

        Future<GetIotDomainResponse> getIotDomain​(GetIotDomainRequest request,
                                          AsyncHandler<GetIotDomainRequest,​GetIotDomainResponse> handler)
        Retrieves the IoT domain identified by the specified OCID.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • getIotDomainGroup

        Future<GetIotDomainGroupResponse> getIotDomainGroup​(GetIotDomainGroupRequest request,
                                                    AsyncHandler<GetIotDomainGroupRequest,​GetIotDomainGroupResponse> handler)
        Retrieves the IoT domain group identified by the specified OCID.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • getWorkRequest

        Future<GetWorkRequestResponse> getWorkRequest​(GetWorkRequestRequest request,
                                              AsyncHandler<GetWorkRequestRequest,​GetWorkRequestResponse> handler)
        Retrieves the status of the work request with the given ID.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • invokeRawCommand

        Future<InvokeRawCommandResponse> invokeRawCommand​(InvokeRawCommandRequest request,
                                                  AsyncHandler<InvokeRawCommandRequest,​InvokeRawCommandResponse> handler)
        Invokes the raw command on the specified digital twin instance.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • listDigitalTwinAdapters

        Future<ListDigitalTwinAdaptersResponse> listDigitalTwinAdapters​(ListDigitalTwinAdaptersRequest request,
                                                                AsyncHandler<ListDigitalTwinAdaptersRequest,​ListDigitalTwinAdaptersResponse> handler)
        Retrieves a list of digital twin adapters within the specified IoT domain.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • listDigitalTwinInstances

        Future<ListDigitalTwinInstancesResponse> listDigitalTwinInstances​(ListDigitalTwinInstancesRequest request,
                                                                  AsyncHandler<ListDigitalTwinInstancesRequest,​ListDigitalTwinInstancesResponse> handler)
        Retrieves a list of digital twin instances within the specified IoT domain.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • listDigitalTwinModels

        Future<ListDigitalTwinModelsResponse> listDigitalTwinModels​(ListDigitalTwinModelsRequest request,
                                                            AsyncHandler<ListDigitalTwinModelsRequest,​ListDigitalTwinModelsResponse> handler)
        Retrieves a list of digital twin models within the specified IoT domain.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • listIotDomainGroups

        Future<ListIotDomainGroupsResponse> listIotDomainGroups​(ListIotDomainGroupsRequest request,
                                                        AsyncHandler<ListIotDomainGroupsRequest,​ListIotDomainGroupsResponse> handler)
        Retrieves a list of IoT domain groups within the specified compartment.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • listIotDomains

        Future<ListIotDomainsResponse> listIotDomains​(ListIotDomainsRequest request,
                                              AsyncHandler<ListIotDomainsRequest,​ListIotDomainsResponse> handler)
        Retrieves a list of IoT domains within the specified compartment.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • listWorkRequestErrors

        Future<ListWorkRequestErrorsResponse> listWorkRequestErrors​(ListWorkRequestErrorsRequest request,
                                                            AsyncHandler<ListWorkRequestErrorsRequest,​ListWorkRequestErrorsResponse> handler)
        Lists errors associated with the specified work request.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • listWorkRequestLogs

        Future<ListWorkRequestLogsResponse> listWorkRequestLogs​(ListWorkRequestLogsRequest request,
                                                        AsyncHandler<ListWorkRequestLogsRequest,​ListWorkRequestLogsResponse> handler)
        Lists the logs associated with the specified work request.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • listWorkRequests

        Future<ListWorkRequestsResponse> listWorkRequests​(ListWorkRequestsRequest request,
                                                  AsyncHandler<ListWorkRequestsRequest,​ListWorkRequestsResponse> handler)
        Lists work requests in the specified compartment.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • updateDigitalTwinAdapter

        Future<UpdateDigitalTwinAdapterResponse> updateDigitalTwinAdapter​(UpdateDigitalTwinAdapterRequest request,
                                                                  AsyncHandler<UpdateDigitalTwinAdapterRequest,​UpdateDigitalTwinAdapterResponse> handler)
        Updates the details of digital twin adapter identified by the specified OCID.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • updateDigitalTwinInstance

        Future<UpdateDigitalTwinInstanceResponse> updateDigitalTwinInstance​(UpdateDigitalTwinInstanceRequest request,
                                                                    AsyncHandler<UpdateDigitalTwinInstanceRequest,​UpdateDigitalTwinInstanceResponse> handler)
        Updates the details of digital twin instance identified by the specified OCID.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • updateDigitalTwinModel

        Future<UpdateDigitalTwinModelResponse> updateDigitalTwinModel​(UpdateDigitalTwinModelRequest request,
                                                              AsyncHandler<UpdateDigitalTwinModelRequest,​UpdateDigitalTwinModelResponse> handler)
        Updates the details of the digital twin model identified by the specified OCID.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • updateIotDomain

        Future<UpdateIotDomainResponse> updateIotDomain​(UpdateIotDomainRequest request,
                                                AsyncHandler<UpdateIotDomainRequest,​UpdateIotDomainResponse> handler)
        Updates the details of IoT domain identified by the specified OCID.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.

      • updateIotDomainGroup

        Future<UpdateIotDomainGroupResponse> updateIotDomainGroup​(UpdateIotDomainGroupRequest request,
                                                          AsyncHandler<UpdateIotDomainGroupRequest,​UpdateIotDomainGroupResponse> handler)
        Updates the details of IoT domain group identified by the specified OCID.
        Parameters:
        request - The request object containing the details to send
        handler - The request handler to invoke upon completion, may be null.
        Returns:
        A Future that can be used to get the response if no AsyncHandler was provided. Note, if you provide an AsyncHandler and use the Future, some types of responses (like java.io.InputStream) may not be able to be read in both places as the underlying stream may only be consumed once.