Class IotAsyncClient
- java.lang.Object
-
- com.oracle.bmc.http.internal.BaseAsyncClient
-
- com.oracle.bmc.iot.IotAsyncClient
-
- All Implemented Interfaces:
IotAsync
,AutoCloseable
@Generated(value="OracleSDKGenerator", comments="API Version: 20250531") public class IotAsyncClient extends BaseAsyncClient implements IotAsync
Async client implementation for Iot service.
There are two ways to use async client: 1. Use AsyncHandler: using AsyncHandler, if the response to the call is anInputStream
, like getObject Api in object storage service, developers need to process the stream in AsyncHandler, and not anywhere else, because the stream will be closed right after the AsyncHandler is invoked.
2. Use Java Future: using Java Future, developers need to close the stream after they are done with the Java Future.
Accessing the result should be done in a mutually exclusive manner, either through the Future or the AsyncHandler, but not both. If the Future is used, the caller should pass in null as the AsyncHandler. If the AsyncHandler is used, it is still safe to use the Future to determine whether or not the request was completed via Future.isDone/isCancelled.
Please refer to https://github.com/oracle/oci-java-sdk/blob/master/bmc-examples/src/main/java/ResteasyClientWithObjectStorageExample.java
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
IotAsyncClient.Builder
Builder class for this client.
-
Field Summary
Fields Modifier and Type Field Description String
clientCommonLibraryVersion
Compatible SDK version, provided by the codegen.Optional<String>
minimumClientCommonLibraryVersionFromClient
Minimum compatible SDK version, maybe provided by the codegen.static Service
SERVICE
Service instance for Iot.
-
Constructor Summary
Constructors Constructor Description IotAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.IotAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.IotAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.IotAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.IotAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.IotAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.IotAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.
-
Method Summary
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface java.lang.AutoCloseable
close
-
Methods inherited from interface com.oracle.bmc.iot.IotAsync
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
-
-
-
-
Constructor Detail
-
IotAsyncClient
@Deprecated public IotAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeIotAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)
-
IotAsyncClient
@Deprecated public IotAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeIotAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
-
IotAsyncClient
@Deprecated public IotAsyncClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeIotAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
-
IotAsyncClient
@Deprecated public IotAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeIotAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
-
IotAsyncClient
@Deprecated public IotAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeIotAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
-
IotAsyncClient
@Deprecated public IotAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeIotAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
endpoint
-ClientBuilderBase.endpoint(java.lang.String)
-
IotAsyncClient
@Deprecated public IotAsyncClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
Deprecated.Use thebuilder
instead.Create a new client instance.- Parameters:
authenticationDetailsProvider
- The authentication details (seeIotAsyncClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
-ClientBuilderBase.configuration
clientConfigurator
-ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
-ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
-ClientBuilderBase.additionalClientConfigurators
endpoint
-ClientBuilderBase.endpoint(java.lang.String)
signingStrategyRequestSignerFactories
-ClientBuilderBase.signingStrategyRequestSignerFactories
-
-
Method Detail
-
builder
public static IotAsyncClient.Builder builder()
Create a builder for this client.- Returns:
- builder
-
setRegion
public void setRegion(Region region)
Description copied from interface:IotAsync
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.
-
setRegion
public void setRegion(String regionId)
Description copied from interface:IotAsync
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 callsetEndpoint
.
-
changeIotDomainCompartment
public Future<ChangeIotDomainCompartmentResponse> changeIotDomainCompartment(ChangeIotDomainCompartmentRequest request, AsyncHandler<ChangeIotDomainCompartmentRequest,ChangeIotDomainCompartmentResponse> handler)
Description copied from interface:IotAsync
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.
- Specified by:
changeIotDomainCompartment
in interfaceIotAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
changeIotDomainDataRetentionPeriod
public Future<ChangeIotDomainDataRetentionPeriodResponse> changeIotDomainDataRetentionPeriod(ChangeIotDomainDataRetentionPeriodRequest request, AsyncHandler<ChangeIotDomainDataRetentionPeriodRequest,ChangeIotDomainDataRetentionPeriodResponse> handler)
Description copied from interface:IotAsync
Updates Data Retention Period of the IoT Domain.- Specified by:
changeIotDomainDataRetentionPeriod
in interfaceIotAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
changeIotDomainGroupCompartment
public Future<ChangeIotDomainGroupCompartmentResponse> changeIotDomainGroupCompartment(ChangeIotDomainGroupCompartmentRequest request, AsyncHandler<ChangeIotDomainGroupCompartmentRequest,ChangeIotDomainGroupCompartmentResponse> handler)
Description copied from interface:IotAsync
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.
- Specified by:
changeIotDomainGroupCompartment
in interfaceIotAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
configureIotDomainDataAccess
public Future<ConfigureIotDomainDataAccessResponse> configureIotDomainDataAccess(ConfigureIotDomainDataAccessRequest request, AsyncHandler<ConfigureIotDomainDataAccessRequest,ConfigureIotDomainDataAccessResponse> handler)
Description copied from interface:IotAsync
Updates an IoT domain Data Access.- Specified by:
configureIotDomainDataAccess
in interfaceIotAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
configureIotDomainGroupDataAccess
public Future<ConfigureIotDomainGroupDataAccessResponse> configureIotDomainGroupDataAccess(ConfigureIotDomainGroupDataAccessRequest request, AsyncHandler<ConfigureIotDomainGroupDataAccessRequest,ConfigureIotDomainGroupDataAccessResponse> handler)
Description copied from interface:IotAsync
Updates an IoT domain Group Data Access.- Specified by:
configureIotDomainGroupDataAccess
in interfaceIotAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
createDigitalTwinAdapter
public Future<CreateDigitalTwinAdapterResponse> createDigitalTwinAdapter(CreateDigitalTwinAdapterRequest request, AsyncHandler<CreateDigitalTwinAdapterRequest,CreateDigitalTwinAdapterResponse> handler)
Description copied from interface:IotAsync
Creates a new digital twin adapter.- Specified by:
createDigitalTwinAdapter
in interfaceIotAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
createDigitalTwinInstance
public Future<CreateDigitalTwinInstanceResponse> createDigitalTwinInstance(CreateDigitalTwinInstanceRequest request, AsyncHandler<CreateDigitalTwinInstanceRequest,CreateDigitalTwinInstanceResponse> handler)
Description copied from interface:IotAsync
Creates a new digital twin instance.- Specified by:
createDigitalTwinInstance
in interfaceIotAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
createDigitalTwinModel
public Future<CreateDigitalTwinModelResponse> createDigitalTwinModel(CreateDigitalTwinModelRequest request, AsyncHandler<CreateDigitalTwinModelRequest,CreateDigitalTwinModelResponse> handler)
Description copied from interface:IotAsync
Creates a new digital twin model.- Specified by:
createDigitalTwinModel
in interfaceIotAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
createDigitalTwinRelationship
public Future<CreateDigitalTwinRelationshipResponse> createDigitalTwinRelationship(CreateDigitalTwinRelationshipRequest request, AsyncHandler<CreateDigitalTwinRelationshipRequest,CreateDigitalTwinRelationshipResponse> handler)
Description copied from interface:IotAsync
Creates a new digital twin relationship.- Specified by:
createDigitalTwinRelationship
in interfaceIotAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<CreateIotDomainResponse> createIotDomain(CreateIotDomainRequest request, AsyncHandler<CreateIotDomainRequest,CreateIotDomainResponse> handler)
Description copied from interface:IotAsync
Creates a new IoT domain.- Specified by:
createIotDomain
in interfaceIotAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<CreateIotDomainGroupResponse> createIotDomainGroup(CreateIotDomainGroupRequest request, AsyncHandler<CreateIotDomainGroupRequest,CreateIotDomainGroupResponse> handler)
Description copied from interface:IotAsync
Creates a new IoT domain group.- Specified by:
createIotDomainGroup
in interfaceIotAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<DeleteDigitalTwinAdapterResponse> deleteDigitalTwinAdapter(DeleteDigitalTwinAdapterRequest request, AsyncHandler<DeleteDigitalTwinAdapterRequest,DeleteDigitalTwinAdapterResponse> handler)
Description copied from interface:IotAsync
Deletes the digital twin adapter identified by the specified OCID.- Specified by:
deleteDigitalTwinAdapter
in interfaceIotAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
deleteDigitalTwinInstance
public Future<DeleteDigitalTwinInstanceResponse> deleteDigitalTwinInstance(DeleteDigitalTwinInstanceRequest request, AsyncHandler<DeleteDigitalTwinInstanceRequest,DeleteDigitalTwinInstanceResponse> handler)
Description copied from interface:IotAsync
Deletes the digital twin instance identified by the specified OCID.- Specified by:
deleteDigitalTwinInstance
in interfaceIotAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<DeleteDigitalTwinModelResponse> deleteDigitalTwinModel(DeleteDigitalTwinModelRequest request, AsyncHandler<DeleteDigitalTwinModelRequest,DeleteDigitalTwinModelResponse> handler)
Description copied from interface:IotAsync
Deletes the digital twin model identified by the specified OCID.- Specified by:
deleteDigitalTwinModel
in interfaceIotAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
deleteDigitalTwinRelationship
public Future<DeleteDigitalTwinRelationshipResponse> deleteDigitalTwinRelationship(DeleteDigitalTwinRelationshipRequest request, AsyncHandler<DeleteDigitalTwinRelationshipRequest,DeleteDigitalTwinRelationshipResponse> handler)
Description copied from interface:IotAsync
Deletes the digital twin relationship identified by the specified OCID.- Specified by:
deleteDigitalTwinRelationship
in interfaceIotAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<DeleteIotDomainResponse> deleteIotDomain(DeleteIotDomainRequest request, AsyncHandler<DeleteIotDomainRequest,DeleteIotDomainResponse> handler)
Description copied from interface:IotAsync
Deletes the IoT domain identified by the specified OCID.- Specified by:
deleteIotDomain
in interfaceIotAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<DeleteIotDomainGroupResponse> deleteIotDomainGroup(DeleteIotDomainGroupRequest request, AsyncHandler<DeleteIotDomainGroupRequest,DeleteIotDomainGroupResponse> handler)
Description copied from interface:IotAsync
Deletes the IoT domain group identified by the specified OCID.- Specified by:
deleteIotDomainGroup
in interfaceIotAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<GetDigitalTwinAdapterResponse> getDigitalTwinAdapter(GetDigitalTwinAdapterRequest request, AsyncHandler<GetDigitalTwinAdapterRequest,GetDigitalTwinAdapterResponse> handler)
Description copied from interface:IotAsync
Retrieves the digital twin adapter identified by the specified OCID.- Specified by:
getDigitalTwinAdapter
in interfaceIotAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<GetDigitalTwinInstanceResponse> getDigitalTwinInstance(GetDigitalTwinInstanceRequest request, AsyncHandler<GetDigitalTwinInstanceRequest,GetDigitalTwinInstanceResponse> handler)
Description copied from interface:IotAsync
Retrieves the digital twin instance identified by the specified OCID.- Specified by:
getDigitalTwinInstance
in interfaceIotAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
getDigitalTwinInstanceContent
public Future<GetDigitalTwinInstanceContentResponse> getDigitalTwinInstanceContent(GetDigitalTwinInstanceContentRequest request, AsyncHandler<GetDigitalTwinInstanceContentRequest,GetDigitalTwinInstanceContentResponse> handler)
Description copied from interface:IotAsync
Retrieves the latest snapshot data of digital twin instance identified by the specified OCID.- Specified by:
getDigitalTwinInstanceContent
in interfaceIotAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<GetDigitalTwinModelResponse> getDigitalTwinModel(GetDigitalTwinModelRequest request, AsyncHandler<GetDigitalTwinModelRequest,GetDigitalTwinModelResponse> handler)
Description copied from interface:IotAsync
Retrieves the digital twin model identified by the specified OCID.- Specified by:
getDigitalTwinModel
in interfaceIotAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<GetDigitalTwinModelSpecResponse> getDigitalTwinModelSpec(GetDigitalTwinModelSpecRequest request, AsyncHandler<GetDigitalTwinModelSpecRequest,GetDigitalTwinModelSpecResponse> handler)
Description copied from interface:IotAsync
Retrieves the spec of digital twin model identified by the specified OCID.- Specified by:
getDigitalTwinModelSpec
in interfaceIotAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
getDigitalTwinRelationship
public Future<GetDigitalTwinRelationshipResponse> getDigitalTwinRelationship(GetDigitalTwinRelationshipRequest request, AsyncHandler<GetDigitalTwinRelationshipRequest,GetDigitalTwinRelationshipResponse> handler)
Description copied from interface:IotAsync
Retrieves the digital twin relationship identified by the specified OCID.- Specified by:
getDigitalTwinRelationship
in interfaceIotAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<GetIotDomainResponse> getIotDomain(GetIotDomainRequest request, AsyncHandler<GetIotDomainRequest,GetIotDomainResponse> handler)
Description copied from interface:IotAsync
Retrieves the IoT domain identified by the specified OCID.- Specified by:
getIotDomain
in interfaceIotAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<GetIotDomainGroupResponse> getIotDomainGroup(GetIotDomainGroupRequest request, AsyncHandler<GetIotDomainGroupRequest,GetIotDomainGroupResponse> handler)
Description copied from interface:IotAsync
Retrieves the IoT domain group identified by the specified OCID.- Specified by:
getIotDomainGroup
in interfaceIotAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<GetWorkRequestResponse> getWorkRequest(GetWorkRequestRequest request, AsyncHandler<GetWorkRequestRequest,GetWorkRequestResponse> handler)
Description copied from interface:IotAsync
Retrieves the status of the work request with the given ID.- Specified by:
getWorkRequest
in interfaceIotAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<InvokeRawCommandResponse> invokeRawCommand(InvokeRawCommandRequest request, AsyncHandler<InvokeRawCommandRequest,InvokeRawCommandResponse> handler)
Description copied from interface:IotAsync
Invokes the raw command on the specified digital twin instance.- Specified by:
invokeRawCommand
in interfaceIotAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<ListDigitalTwinAdaptersResponse> listDigitalTwinAdapters(ListDigitalTwinAdaptersRequest request, AsyncHandler<ListDigitalTwinAdaptersRequest,ListDigitalTwinAdaptersResponse> handler)
Description copied from interface:IotAsync
Retrieves a list of digital twin adapters within the specified IoT domain.- Specified by:
listDigitalTwinAdapters
in interfaceIotAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<ListDigitalTwinInstancesResponse> listDigitalTwinInstances(ListDigitalTwinInstancesRequest request, AsyncHandler<ListDigitalTwinInstancesRequest,ListDigitalTwinInstancesResponse> handler)
Description copied from interface:IotAsync
Retrieves a list of digital twin instances within the specified IoT domain.- Specified by:
listDigitalTwinInstances
in interfaceIotAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<ListDigitalTwinModelsResponse> listDigitalTwinModels(ListDigitalTwinModelsRequest request, AsyncHandler<ListDigitalTwinModelsRequest,ListDigitalTwinModelsResponse> handler)
Description copied from interface:IotAsync
Retrieves a list of digital twin models within the specified IoT domain.- Specified by:
listDigitalTwinModels
in interfaceIotAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
listDigitalTwinRelationships
public Future<ListDigitalTwinRelationshipsResponse> listDigitalTwinRelationships(ListDigitalTwinRelationshipsRequest request, AsyncHandler<ListDigitalTwinRelationshipsRequest,ListDigitalTwinRelationshipsResponse> handler)
Description copied from interface:IotAsync
Retrieves a list of digital twin relationships within the specified IoT domain.- Specified by:
listDigitalTwinRelationships
in interfaceIotAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<ListIotDomainGroupsResponse> listIotDomainGroups(ListIotDomainGroupsRequest request, AsyncHandler<ListIotDomainGroupsRequest,ListIotDomainGroupsResponse> handler)
Description copied from interface:IotAsync
Retrieves a list of IoT domain groups within the specified compartment.- Specified by:
listIotDomainGroups
in interfaceIotAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<ListIotDomainsResponse> listIotDomains(ListIotDomainsRequest request, AsyncHandler<ListIotDomainsRequest,ListIotDomainsResponse> handler)
Description copied from interface:IotAsync
Retrieves a list of IoT domains within the specified compartment.- Specified by:
listIotDomains
in interfaceIotAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<ListWorkRequestErrorsResponse> listWorkRequestErrors(ListWorkRequestErrorsRequest request, AsyncHandler<ListWorkRequestErrorsRequest,ListWorkRequestErrorsResponse> handler)
Description copied from interface:IotAsync
Lists errors associated with the specified work request.- Specified by:
listWorkRequestErrors
in interfaceIotAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<ListWorkRequestLogsResponse> listWorkRequestLogs(ListWorkRequestLogsRequest request, AsyncHandler<ListWorkRequestLogsRequest,ListWorkRequestLogsResponse> handler)
Description copied from interface:IotAsync
Lists the logs associated with the specified work request.- Specified by:
listWorkRequestLogs
in interfaceIotAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<ListWorkRequestsResponse> listWorkRequests(ListWorkRequestsRequest request, AsyncHandler<ListWorkRequestsRequest,ListWorkRequestsResponse> handler)
Description copied from interface:IotAsync
Lists work requests in the specified compartment.- Specified by:
listWorkRequests
in interfaceIotAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<UpdateDigitalTwinAdapterResponse> updateDigitalTwinAdapter(UpdateDigitalTwinAdapterRequest request, AsyncHandler<UpdateDigitalTwinAdapterRequest,UpdateDigitalTwinAdapterResponse> handler)
Description copied from interface:IotAsync
Updates the details of digital twin adapter identified by the specified OCID.- Specified by:
updateDigitalTwinAdapter
in interfaceIotAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<UpdateDigitalTwinInstanceResponse> updateDigitalTwinInstance(UpdateDigitalTwinInstanceRequest request, AsyncHandler<UpdateDigitalTwinInstanceRequest,UpdateDigitalTwinInstanceResponse> handler)
Description copied from interface:IotAsync
Updates the details of digital twin instance identified by the specified OCID.- Specified by:
updateDigitalTwinInstance
in interfaceIotAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<UpdateDigitalTwinModelResponse> updateDigitalTwinModel(UpdateDigitalTwinModelRequest request, AsyncHandler<UpdateDigitalTwinModelRequest,UpdateDigitalTwinModelResponse> handler)
Description copied from interface:IotAsync
Updates the details of the digital twin model identified by the specified OCID.- Specified by:
updateDigitalTwinModel
in interfaceIotAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
updateDigitalTwinRelationship
public Future<UpdateDigitalTwinRelationshipResponse> updateDigitalTwinRelationship(UpdateDigitalTwinRelationshipRequest request, AsyncHandler<UpdateDigitalTwinRelationshipRequest,UpdateDigitalTwinRelationshipResponse> handler)
Description copied from interface:IotAsync
Updates the details of digital twin relationship identified by the specified OCID.- Specified by:
updateDigitalTwinRelationship
in interfaceIotAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<UpdateIotDomainResponse> updateIotDomain(UpdateIotDomainRequest request, AsyncHandler<UpdateIotDomainRequest,UpdateIotDomainResponse> handler)
Description copied from interface:IotAsync
Updates the details of IoT domain identified by the specified OCID.- Specified by:
updateIotDomain
in interfaceIotAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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
public Future<UpdateIotDomainGroupResponse> updateIotDomainGroup(UpdateIotDomainGroupRequest request, AsyncHandler<UpdateIotDomainGroupRequest,UpdateIotDomainGroupResponse> handler)
Description copied from interface:IotAsync
Updates the details of IoT domain group identified by the specified OCID.- Specified by:
updateIotDomainGroup
in interfaceIotAsync
- Parameters:
request
- The request object containing the details to sendhandler
- 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.
-
getDefaultConfigurator
protected ClientConfigurator getDefaultConfigurator()
-
useRealmSpecificEndpointTemplate
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
This method should be used to enable or disable the use of realm-specific endpoint template.The default value is null. To enable the use of endpoint template defined for the realm in use, set the flag to true To disable the use of endpoint template defined for the realm in use, set the flag to false
- Parameters:
useOfRealmSpecificEndpointTemplateEnabled
- This flag can be set to true or false to enable or disable the use of realm-specific endpoint template respectively
-
populateServiceParametersInEndpoint
public final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
Populate the parameters in the endpoint with its corresponding value and update the base endpoint.The value will be populated iff the parameter in endpoint is a required request path parameter or a required request query parameter. If not, the parameter in the endpoint will be ignored and left blank.
- Parameters:
endpoint
- The endpoint template in userequiredParametersMap
- Map of parameter name as key and value set in request path or query parameter as value
-
updateBaseEndpoint
public final void updateBaseEndpoint(String endpoint)
This method should be used for parameterized endpoint templates only.This does not include {region} and {secondLevelDomain} parameters.
- Parameters:
endpoint
- The updated endpoint to use
-
setEndpoint
public final void setEndpoint(String endpoint)
-
getEndpoint
public final String getEndpoint()
-
refreshClient
public final void refreshClient()
Rebuild the backingHttpClient
.This will call
ClientConfigurator
s again, and can be used to e.g. refresh the SSL certificate.
-
close
public final void close()
- Specified by:
close
in interfaceAutoCloseable
-
getClientCommonLibraryVersion
public String getClientCommonLibraryVersion()
-
getMinimumClientCommonLibraryVersionFromClient
public Optional<String> getMinimumClientCommonLibraryVersionFromClient()
-
clientCall
protected <REQ extends BmcRequest<?>,RESP extends BmcResponse,RESP_BUILDER extends BmcResponse.Builder<RESP>> ClientCall<REQ,RESP,RESP_BUILDER> clientCall(REQ request, Supplier<RESP_BUILDER> responseBuilder)
-
-