java.lang.Object
- com.oracle.bmc.http.internal.BaseSyncClient
- - com.oracle.bmc.iot.IotClient

All Implemented Interfaces:: Iot, AutoCloseable

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20250531")
public class IotClient
extends BaseSyncClient
implements Iot

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class IotClient.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
`IotClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)`	Deprecated. Use the `builder` instead.
`IotClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)`	Deprecated. Use the `builder` instead.
`IotClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)`	Deprecated. Use the `builder` instead.
`IotClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)`	Deprecated. Use the `builder` instead.
`IotClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)`	Deprecated. Use the `builder` instead.
`IotClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)`	Deprecated. Use the `builder` instead.
`IotClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)`	Deprecated. Use the `builder` instead.
`IotClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)`	Deprecated. Use the `builder` instead.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static IotClient.Builder`	`builder()`	Create a builder for this client.
`ChangeIotDomainCompartmentResponse`	`changeIotDomainCompartment(ChangeIotDomainCompartmentRequest request)`	Moves an IoT domain to a different compartment within the same tenancy.
`ChangeIotDomainDataRetentionPeriodResponse`	`changeIotDomainDataRetentionPeriod(ChangeIotDomainDataRetentionPeriodRequest request)`	Updates Data Retention Period of the IoT Domain.
`ChangeIotDomainGroupCompartmentResponse`	`changeIotDomainGroupCompartment(ChangeIotDomainGroupCompartmentRequest request)`	Moves an IoT domain group to a different compartment within the same tenancy.
`void`	`close()`
`ConfigureIotDomainDataAccessResponse`	`configureIotDomainDataAccess(ConfigureIotDomainDataAccessRequest request)`	Updates an IoT domain Data Access.
`ConfigureIotDomainGroupDataAccessResponse`	`configureIotDomainGroupDataAccess(ConfigureIotDomainGroupDataAccessRequest request)`	Updates an IoT domain Group Data Access.
`CreateDigitalTwinAdapterResponse`	`createDigitalTwinAdapter(CreateDigitalTwinAdapterRequest request)`	Creates a new digital twin adapter.
`CreateDigitalTwinInstanceResponse`	`createDigitalTwinInstance(CreateDigitalTwinInstanceRequest request)`	Creates a new digital twin instance.
`CreateDigitalTwinModelResponse`	`createDigitalTwinModel(CreateDigitalTwinModelRequest request)`	Creates a new digital twin model.
`CreateDigitalTwinRelationshipResponse`	`createDigitalTwinRelationship(CreateDigitalTwinRelationshipRequest request)`	Creates a new digital twin relationship.
`CreateIotDomainResponse`	`createIotDomain(CreateIotDomainRequest request)`	Creates a new IoT domain.
`CreateIotDomainGroupResponse`	`createIotDomainGroup(CreateIotDomainGroupRequest request)`	Creates a new IoT domain group.
`DeleteDigitalTwinAdapterResponse`	`deleteDigitalTwinAdapter(DeleteDigitalTwinAdapterRequest request)`	Deletes the digital twin adapter identified by the specified OCID.
`DeleteDigitalTwinInstanceResponse`	`deleteDigitalTwinInstance(DeleteDigitalTwinInstanceRequest request)`	Deletes the digital twin instance identified by the specified OCID.
`DeleteDigitalTwinModelResponse`	`deleteDigitalTwinModel(DeleteDigitalTwinModelRequest request)`	Deletes the digital twin model identified by the specified OCID.
`DeleteDigitalTwinRelationshipResponse`	`deleteDigitalTwinRelationship(DeleteDigitalTwinRelationshipRequest request)`	Deletes the digital twin relationship identified by the specified OCID.
`DeleteIotDomainResponse`	`deleteIotDomain(DeleteIotDomainRequest request)`	Deletes the IoT domain identified by the specified OCID.
`DeleteIotDomainGroupResponse`	`deleteIotDomainGroup(DeleteIotDomainGroupRequest request)`	Deletes the IoT domain group identified by the specified OCID.
`String`	`getClientCommonLibraryVersion()`
`protected ClientConfigurator`	`getDefaultConfigurator()`
`GetDigitalTwinAdapterResponse`	`getDigitalTwinAdapter(GetDigitalTwinAdapterRequest request)`	Retrieves the digital twin adapter identified by the specified OCID.
`GetDigitalTwinInstanceResponse`	`getDigitalTwinInstance(GetDigitalTwinInstanceRequest request)`	Retrieves the digital twin instance identified by the specified OCID.
`GetDigitalTwinInstanceContentResponse`	`getDigitalTwinInstanceContent(GetDigitalTwinInstanceContentRequest request)`	Retrieves the latest snapshot data of digital twin instance identified by the specified OCID.
`GetDigitalTwinModelResponse`	`getDigitalTwinModel(GetDigitalTwinModelRequest request)`	Retrieves the digital twin model identified by the specified OCID.
`GetDigitalTwinModelSpecResponse`	`getDigitalTwinModelSpec(GetDigitalTwinModelSpecRequest request)`	Retrieves the spec of digital twin model identified by the specified OCID.
`GetDigitalTwinRelationshipResponse`	`getDigitalTwinRelationship(GetDigitalTwinRelationshipRequest request)`	Retrieves the digital twin relationship identified by the specified OCID.
`String`	`getEndpoint()`
`GetIotDomainResponse`	`getIotDomain(GetIotDomainRequest request)`	Retrieves the IoT domain identified by the specified OCID.
`GetIotDomainGroupResponse`	`getIotDomainGroup(GetIotDomainGroupRequest request)`	Retrieves the IoT domain group identified by the specified OCID.
`Optional<String>`	`getMinimumClientCommonLibraryVersionFromClient()`
`IotPaginators`	`getPaginators()`	Gets the pre-configured paginators available for list operations in this service which may return multiple pages of data.
`IotWaiters`	`getWaiters()`	Gets the pre-configured waiters available for resources for this service.
`GetWorkRequestResponse`	`getWorkRequest(GetWorkRequestRequest request)`	Retrieves the status of the work request with the given ID.
`InvokeRawCommandResponse`	`invokeRawCommand(InvokeRawCommandRequest request)`	Invokes the raw command on the specified digital twin instance.
`ListDigitalTwinAdaptersResponse`	`listDigitalTwinAdapters(ListDigitalTwinAdaptersRequest request)`	Retrieves a list of digital twin adapters within the specified IoT domain.
`ListDigitalTwinInstancesResponse`	`listDigitalTwinInstances(ListDigitalTwinInstancesRequest request)`	Retrieves a list of digital twin instances within the specified IoT domain.
`ListDigitalTwinModelsResponse`	`listDigitalTwinModels(ListDigitalTwinModelsRequest request)`	Retrieves a list of digital twin models within the specified IoT domain.
`ListDigitalTwinRelationshipsResponse`	`listDigitalTwinRelationships(ListDigitalTwinRelationshipsRequest request)`	Retrieves a list of digital twin relationships within the specified IoT domain.
`ListIotDomainGroupsResponse`	`listIotDomainGroups(ListIotDomainGroupsRequest request)`	Retrieves a list of IoT domain groups within the specified compartment.
`ListIotDomainsResponse`	`listIotDomains(ListIotDomainsRequest request)`	Retrieves a list of IoT domains within the specified compartment.
`ListWorkRequestErrorsResponse`	`listWorkRequestErrors(ListWorkRequestErrorsRequest request)`	Lists errors associated with the specified work request.
`ListWorkRequestLogsResponse`	`listWorkRequestLogs(ListWorkRequestLogsRequest request)`	Lists the logs associated with the specified work request.
`ListWorkRequestsResponse`	`listWorkRequests(ListWorkRequestsRequest request)`	Lists work requests in the specified compartment.
`void`	`populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)`	Populate the parameters in the endpoint with its corresponding value and update the base endpoint.
`void`	`refreshClient()`	Rebuild the backing `HttpClient`.
`void`	`setEndpoint(String endpoint)`
`void`	`setRegion(Region region)`	Sets the region to call (ex, Region.US_PHOENIX_1).
`void`	`setRegion(String regionId)`	Sets the region to call (ex, ‘us-phoenix-1’).
`void`	`updateBaseEndpoint(String endpoint)`	This method should be used for parameterized endpoint templates only.
`UpdateDigitalTwinAdapterResponse`	`updateDigitalTwinAdapter(UpdateDigitalTwinAdapterRequest request)`	Updates the details of digital twin adapter identified by the specified OCID.
`UpdateDigitalTwinInstanceResponse`	`updateDigitalTwinInstance(UpdateDigitalTwinInstanceRequest request)`	Updates the details of digital twin instance identified by the specified OCID.
`UpdateDigitalTwinModelResponse`	`updateDigitalTwinModel(UpdateDigitalTwinModelRequest request)`	Updates the details of the digital twin model identified by the specified OCID.
`UpdateDigitalTwinRelationshipResponse`	`updateDigitalTwinRelationship(UpdateDigitalTwinRelationshipRequest request)`	Updates the details of digital twin relationship identified by the specified OCID.
`UpdateIotDomainResponse`	`updateIotDomain(UpdateIotDomainRequest request)`	Updates the details of IoT domain identified by the specified OCID.
`UpdateIotDomainGroupResponse`	`updateIotDomainGroup(UpdateIotDomainGroupRequest request)`	Updates the details of IoT domain group identified by the specified OCID.
`void`	`useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)`	This method should be used to enable or disable the use of realm-specific endpoint template.

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient
clientCall

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.Iot
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate

- Field Detail
  - SERVICE
```
public static final Service SERVICE
```
    Service instance for Iot.
  - clientCommonLibraryVersion
```
public final String clientCommonLibraryVersion
```
    Compatible SDK version, provided by the codegen.
  - minimumClientCommonLibraryVersionFromClient
```
public final Optional<String> minimumClientCommonLibraryVersionFromClient
```
    Minimum compatible SDK version, maybe provided by the codegen.
- Constructor Detail
  - IotClient
```
@Deprecated
public IotClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see IotClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
  - IotClient
```
@Deprecated
public IotClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                 ClientConfiguration configuration)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see IotClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
  - IotClient
```
@Deprecated
public IotClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
                 ClientConfiguration configuration,
                 ClientConfigurator clientConfigurator)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see IotClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
  - IotClient
```
@Deprecated
public IotClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                 ClientConfiguration configuration,
                 ClientConfigurator clientConfigurator,
                 RequestSignerFactory defaultRequestSignerFactory)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see IotClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
  - IotClient
```
@Deprecated
public IotClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                 ClientConfiguration configuration,
                 ClientConfigurator clientConfigurator,
                 RequestSignerFactory defaultRequestSignerFactory,
                 List<ClientConfigurator> additionalClientConfigurators)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see IotClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider))
    
    configuration - ClientBuilderBase.configuration
    
    clientConfigurator - ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
    
    defaultRequestSignerFactory - ClientBuilderBase.requestSignerFactory
    
    additionalClientConfigurators - ClientBuilderBase.additionalClientConfigurators
  - IotClient
```
@Deprecated
public IotClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                 ClientConfiguration configuration,
                 ClientConfigurator clientConfigurator,
                 RequestSignerFactory defaultRequestSignerFactory,
                 List<ClientConfigurator> additionalClientConfigurators,
                 String endpoint)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see IotClient.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)
  - IotClient
```
@Deprecated
public IotClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                 ClientConfiguration configuration,
                 ClientConfigurator clientConfigurator,
                 RequestSignerFactory defaultRequestSignerFactory,
                 Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                 List<ClientConfigurator> additionalClientConfigurators,
                 String endpoint)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see IotClient.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
  - IotClient
```
@Deprecated
public IotClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
                 ClientConfiguration configuration,
                 ClientConfigurator clientConfigurator,
                 RequestSignerFactory defaultRequestSignerFactory,
                 Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
                 List<ClientConfigurator> additionalClientConfigurators,
                 String endpoint,
                 ExecutorService executorService)
```
    Deprecated.
    Use the builder instead.
    
    Create a new client instance.
    
    Parameters:
    
    authenticationDetailsProvider - The authentication details (see IotClient.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
    
    executorService - IotClient.Builder.executorService
- Method Detail
  - builder
```
public static IotClient.Builder builder()
```
    Create a builder for this client.
    
    Returns:
    
    builder
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: Iot
    
    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.
    
    Specified by:
    
    setRegion in interface Iot
    
    Parameters:
    
    region - The region of the service.
  - setRegion
```
public void setRegion(String regionId)
```
    Description copied from interface: Iot
    
    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.
    
    Specified by:
    
    setRegion in interface Iot
    
    Parameters:
    
    regionId - The public region ID.
  - changeIotDomainCompartment
```
public ChangeIotDomainCompartmentResponse changeIotDomainCompartment(ChangeIotDomainCompartmentRequest request)
```
    Description copied from interface: Iot
    
    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 interface Iot
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - changeIotDomainDataRetentionPeriod
```
public ChangeIotDomainDataRetentionPeriodResponse changeIotDomainDataRetentionPeriod(ChangeIotDomainDataRetentionPeriodRequest request)
```
    Description copied from interface: Iot
    
    Updates Data Retention Period of the IoT Domain.
    
    Specified by:
    
    changeIotDomainDataRetentionPeriod in interface Iot
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - changeIotDomainGroupCompartment
```
public ChangeIotDomainGroupCompartmentResponse changeIotDomainGroupCompartment(ChangeIotDomainGroupCompartmentRequest request)
```
    Description copied from interface: Iot
    
    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 interface Iot
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - configureIotDomainDataAccess
```
public ConfigureIotDomainDataAccessResponse configureIotDomainDataAccess(ConfigureIotDomainDataAccessRequest request)
```
    Description copied from interface: Iot
    
    Updates an IoT domain Data Access.
    
    Specified by:
    
    configureIotDomainDataAccess in interface Iot
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - configureIotDomainGroupDataAccess
```
public ConfigureIotDomainGroupDataAccessResponse configureIotDomainGroupDataAccess(ConfigureIotDomainGroupDataAccessRequest request)
```
    Description copied from interface: Iot
    
    Updates an IoT domain Group Data Access.
    
    Specified by:
    
    configureIotDomainGroupDataAccess in interface Iot
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createDigitalTwinAdapter
```
public CreateDigitalTwinAdapterResponse createDigitalTwinAdapter(CreateDigitalTwinAdapterRequest request)
```
    Description copied from interface: Iot
    
    Creates a new digital twin adapter.
    
    Specified by:
    
    createDigitalTwinAdapter in interface Iot
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createDigitalTwinInstance
```
public CreateDigitalTwinInstanceResponse createDigitalTwinInstance(CreateDigitalTwinInstanceRequest request)
```
    Description copied from interface: Iot
    
    Creates a new digital twin instance.
    
    Specified by:
    
    createDigitalTwinInstance in interface Iot
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createDigitalTwinModel
```
public CreateDigitalTwinModelResponse createDigitalTwinModel(CreateDigitalTwinModelRequest request)
```
    Description copied from interface: Iot
    
    Creates a new digital twin model.
    
    Specified by:
    
    createDigitalTwinModel in interface Iot
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createDigitalTwinRelationship
```
public CreateDigitalTwinRelationshipResponse createDigitalTwinRelationship(CreateDigitalTwinRelationshipRequest request)
```
    Description copied from interface: Iot
    
    Creates a new digital twin relationship.
    
    Specified by:
    
    createDigitalTwinRelationship in interface Iot
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createIotDomain
```
public CreateIotDomainResponse createIotDomain(CreateIotDomainRequest request)
```
    Description copied from interface: Iot
    
    Creates a new IoT domain.
    
    Specified by:
    
    createIotDomain in interface Iot
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - createIotDomainGroup
```
public CreateIotDomainGroupResponse createIotDomainGroup(CreateIotDomainGroupRequest request)
```
    Description copied from interface: Iot
    
    Creates a new IoT domain group.
    
    Specified by:
    
    createIotDomainGroup in interface Iot
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteDigitalTwinAdapter
```
public DeleteDigitalTwinAdapterResponse deleteDigitalTwinAdapter(DeleteDigitalTwinAdapterRequest request)
```
    Description copied from interface: Iot
    
    Deletes the digital twin adapter identified by the specified OCID.
    
    Specified by:
    
    deleteDigitalTwinAdapter in interface Iot
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteDigitalTwinInstance
```
public DeleteDigitalTwinInstanceResponse deleteDigitalTwinInstance(DeleteDigitalTwinInstanceRequest request)
```
    Description copied from interface: Iot
    
    Deletes the digital twin instance identified by the specified OCID.
    
    Specified by:
    
    deleteDigitalTwinInstance in interface Iot
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteDigitalTwinModel
```
public DeleteDigitalTwinModelResponse deleteDigitalTwinModel(DeleteDigitalTwinModelRequest request)
```
    Description copied from interface: Iot
    
    Deletes the digital twin model identified by the specified OCID.
    
    Specified by:
    
    deleteDigitalTwinModel in interface Iot
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteDigitalTwinRelationship
```
public DeleteDigitalTwinRelationshipResponse deleteDigitalTwinRelationship(DeleteDigitalTwinRelationshipRequest request)
```
    Description copied from interface: Iot
    
    Deletes the digital twin relationship identified by the specified OCID.
    
    Specified by:
    
    deleteDigitalTwinRelationship in interface Iot
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteIotDomain
```
public DeleteIotDomainResponse deleteIotDomain(DeleteIotDomainRequest request)
```
    Description copied from interface: Iot
    
    Deletes the IoT domain identified by the specified OCID.
    
    Specified by:
    
    deleteIotDomain in interface Iot
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - deleteIotDomainGroup
```
public DeleteIotDomainGroupResponse deleteIotDomainGroup(DeleteIotDomainGroupRequest request)
```
    Description copied from interface: Iot
    
    Deletes the IoT domain group identified by the specified OCID.
    
    Specified by:
    
    deleteIotDomainGroup in interface Iot
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getDigitalTwinAdapter
```
public GetDigitalTwinAdapterResponse getDigitalTwinAdapter(GetDigitalTwinAdapterRequest request)
```
    Description copied from interface: Iot
    
    Retrieves the digital twin adapter identified by the specified OCID.
    
    Specified by:
    
    getDigitalTwinAdapter in interface Iot
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getDigitalTwinInstance
```
public GetDigitalTwinInstanceResponse getDigitalTwinInstance(GetDigitalTwinInstanceRequest request)
```
    Description copied from interface: Iot
    
    Retrieves the digital twin instance identified by the specified OCID.
    
    Specified by:
    
    getDigitalTwinInstance in interface Iot
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getDigitalTwinInstanceContent
```
public GetDigitalTwinInstanceContentResponse getDigitalTwinInstanceContent(GetDigitalTwinInstanceContentRequest request)
```
    Description copied from interface: Iot
    
    Retrieves the latest snapshot data of digital twin instance identified by the specified OCID.
    
    Specified by:
    
    getDigitalTwinInstanceContent in interface Iot
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getDigitalTwinModel
```
public GetDigitalTwinModelResponse getDigitalTwinModel(GetDigitalTwinModelRequest request)
```
    Description copied from interface: Iot
    
    Retrieves the digital twin model identified by the specified OCID.
    
    Specified by:
    
    getDigitalTwinModel in interface Iot
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getDigitalTwinModelSpec
```
public GetDigitalTwinModelSpecResponse getDigitalTwinModelSpec(GetDigitalTwinModelSpecRequest request)
```
    Description copied from interface: Iot
    
    Retrieves the spec of digital twin model identified by the specified OCID.
    
    Specified by:
    
    getDigitalTwinModelSpec in interface Iot
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getDigitalTwinRelationship
```
public GetDigitalTwinRelationshipResponse getDigitalTwinRelationship(GetDigitalTwinRelationshipRequest request)
```
    Description copied from interface: Iot
    
    Retrieves the digital twin relationship identified by the specified OCID.
    
    Specified by:
    
    getDigitalTwinRelationship in interface Iot
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getIotDomain
```
public GetIotDomainResponse getIotDomain(GetIotDomainRequest request)
```
    Description copied from interface: Iot
    
    Retrieves the IoT domain identified by the specified OCID.
    
    Specified by:
    
    getIotDomain in interface Iot
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getIotDomainGroup
```
public GetIotDomainGroupResponse getIotDomainGroup(GetIotDomainGroupRequest request)
```
    Description copied from interface: Iot
    
    Retrieves the IoT domain group identified by the specified OCID.
    
    Specified by:
    
    getIotDomainGroup in interface Iot
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getWorkRequest
```
public GetWorkRequestResponse getWorkRequest(GetWorkRequestRequest request)
```
    Description copied from interface: Iot
    
    Retrieves the status of the work request with the given ID.
    
    Specified by:
    
    getWorkRequest in interface Iot
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - invokeRawCommand
```
public InvokeRawCommandResponse invokeRawCommand(InvokeRawCommandRequest request)
```
    Description copied from interface: Iot
    
    Invokes the raw command on the specified digital twin instance.
    
    Specified by:
    
    invokeRawCommand in interface Iot
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listDigitalTwinAdapters
```
public ListDigitalTwinAdaptersResponse listDigitalTwinAdapters(ListDigitalTwinAdaptersRequest request)
```
    Description copied from interface: Iot
    
    Retrieves a list of digital twin adapters within the specified IoT domain.
    
    Specified by:
    
    listDigitalTwinAdapters in interface Iot
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listDigitalTwinInstances
```
public ListDigitalTwinInstancesResponse listDigitalTwinInstances(ListDigitalTwinInstancesRequest request)
```
    Description copied from interface: Iot
    
    Retrieves a list of digital twin instances within the specified IoT domain.
    
    Specified by:
    
    listDigitalTwinInstances in interface Iot
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listDigitalTwinModels
```
public ListDigitalTwinModelsResponse listDigitalTwinModels(ListDigitalTwinModelsRequest request)
```
    Description copied from interface: Iot
    
    Retrieves a list of digital twin models within the specified IoT domain.
    
    Specified by:
    
    listDigitalTwinModels in interface Iot
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listDigitalTwinRelationships
```
public ListDigitalTwinRelationshipsResponse listDigitalTwinRelationships(ListDigitalTwinRelationshipsRequest request)
```
    Description copied from interface: Iot
    
    Retrieves a list of digital twin relationships within the specified IoT domain.
    
    Specified by:
    
    listDigitalTwinRelationships in interface Iot
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listIotDomainGroups
```
public ListIotDomainGroupsResponse listIotDomainGroups(ListIotDomainGroupsRequest request)
```
    Description copied from interface: Iot
    
    Retrieves a list of IoT domain groups within the specified compartment.
    
    Specified by:
    
    listIotDomainGroups in interface Iot
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listIotDomains
```
public ListIotDomainsResponse listIotDomains(ListIotDomainsRequest request)
```
    Description copied from interface: Iot
    
    Retrieves a list of IoT domains within the specified compartment.
    
    Specified by:
    
    listIotDomains in interface Iot
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listWorkRequestErrors
```
public ListWorkRequestErrorsResponse listWorkRequestErrors(ListWorkRequestErrorsRequest request)
```
    Description copied from interface: Iot
    
    Lists errors associated with the specified work request.
    
    Specified by:
    
    listWorkRequestErrors in interface Iot
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listWorkRequestLogs
```
public ListWorkRequestLogsResponse listWorkRequestLogs(ListWorkRequestLogsRequest request)
```
    Description copied from interface: Iot
    
    Lists the logs associated with the specified work request.
    
    Specified by:
    
    listWorkRequestLogs in interface Iot
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - listWorkRequests
```
public ListWorkRequestsResponse listWorkRequests(ListWorkRequestsRequest request)
```
    Description copied from interface: Iot
    
    Lists work requests in the specified compartment.
    
    Specified by:
    
    listWorkRequests in interface Iot
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateDigitalTwinAdapter
```
public UpdateDigitalTwinAdapterResponse updateDigitalTwinAdapter(UpdateDigitalTwinAdapterRequest request)
```
    Description copied from interface: Iot
    
    Updates the details of digital twin adapter identified by the specified OCID.
    
    Specified by:
    
    updateDigitalTwinAdapter in interface Iot
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateDigitalTwinInstance
```
public UpdateDigitalTwinInstanceResponse updateDigitalTwinInstance(UpdateDigitalTwinInstanceRequest request)
```
    Description copied from interface: Iot
    
    Updates the details of digital twin instance identified by the specified OCID.
    
    Specified by:
    
    updateDigitalTwinInstance in interface Iot
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateDigitalTwinModel
```
public UpdateDigitalTwinModelResponse updateDigitalTwinModel(UpdateDigitalTwinModelRequest request)
```
    Description copied from interface: Iot
    
    Updates the details of the digital twin model identified by the specified OCID.
    
    Specified by:
    
    updateDigitalTwinModel in interface Iot
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateDigitalTwinRelationship
```
public UpdateDigitalTwinRelationshipResponse updateDigitalTwinRelationship(UpdateDigitalTwinRelationshipRequest request)
```
    Description copied from interface: Iot
    
    Updates the details of digital twin relationship identified by the specified OCID.
    
    Specified by:
    
    updateDigitalTwinRelationship in interface Iot
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateIotDomain
```
public UpdateIotDomainResponse updateIotDomain(UpdateIotDomainRequest request)
```
    Description copied from interface: Iot
    
    Updates the details of IoT domain identified by the specified OCID.
    
    Specified by:
    
    updateIotDomain in interface Iot
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - updateIotDomainGroup
```
public UpdateIotDomainGroupResponse updateIotDomainGroup(UpdateIotDomainGroupRequest request)
```
    Description copied from interface: Iot
    
    Updates the details of IoT domain group identified by the specified OCID.
    
    Specified by:
    
    updateIotDomainGroup in interface Iot
    
    Parameters:
    
    request - The request object containing the details to send
    
    Returns:
    
    A response object containing details about the completed operation
  - getWaiters
```
public IotWaiters getWaiters()
```
    Description copied from interface: Iot
    
    Gets the pre-configured waiters available for resources for this service.
    
    Specified by:
    
    getWaiters in interface Iot
    
    Returns:
    
    The service waiters.
  - getPaginators
```
public IotPaginators getPaginators()
```
    Description copied from interface: Iot
    
    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.
    
    Specified by:
    
    getPaginators in interface Iot
    
    Returns:
    
    The service paginators.
  - 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 use
    
    requiredParametersMap - 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 backing HttpClient.
    This will call ClientConfigurators again, and can be used to e.g. refresh the SSL certificate.
  - close
```
public final void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - getClientCommonLibraryVersion
```
public String getClientCommonLibraryVersion()
```
  - getMinimumClientCommonLibraryVersionFromClient
```
public Optional<String> getMinimumClientCommonLibraryVersionFromClient()
```

Class IotClient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.oracle.bmc.http.internal.BaseSyncClient

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.AutoCloseable

Methods inherited from interface com.oracle.bmc.iot.Iot

Field Detail

SERVICE

clientCommonLibraryVersion

minimumClientCommonLibraryVersionFromClient

Constructor Detail

IotClient

IotClient

IotClient

IotClient

IotClient

IotClient

IotClient

IotClient

Method Detail

builder

setRegion

setRegion

changeIotDomainCompartment

changeIotDomainDataRetentionPeriod

changeIotDomainGroupCompartment

configureIotDomainDataAccess

configureIotDomainGroupDataAccess

createDigitalTwinAdapter

createDigitalTwinInstance

createDigitalTwinModel

createDigitalTwinRelationship

createIotDomain

createIotDomainGroup

deleteDigitalTwinAdapter

deleteDigitalTwinInstance

deleteDigitalTwinModel

deleteDigitalTwinRelationship

deleteIotDomain

deleteIotDomainGroup

getDigitalTwinAdapter

getDigitalTwinInstance

getDigitalTwinInstanceContent

getDigitalTwinModel

getDigitalTwinModelSpec

getDigitalTwinRelationship

getIotDomain

getIotDomainGroup

getWorkRequest

invokeRawCommand

listDigitalTwinAdapters

listDigitalTwinInstances

listDigitalTwinModels

listDigitalTwinRelationships

listIotDomainGroups

listIotDomains

listWorkRequestErrors

listWorkRequestLogs

listWorkRequests

updateDigitalTwinAdapter

updateDigitalTwinInstance

updateDigitalTwinModel

updateDigitalTwinRelationship

updateIotDomain

updateIotDomainGroup

getWaiters

getPaginators

getDefaultConfigurator

useRealmSpecificEndpointTemplate

populateServiceParametersInEndpoint

updateBaseEndpoint

setEndpoint

getEndpoint

refreshClient

close

getClientCommonLibraryVersion

getMinimumClientCommonLibraryVersionFromClient