Package com.oracle.bmc.iot.model

Class CreateDigitalTwinInstanceDetails

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.iot.model.CreateDigitalTwinInstanceDetails

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20250531")
public final class CreateDigitalTwinInstanceDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

The information about new digital twin instance to be created.
Note: Objects should always be created or deserialized using the CreateDigitalTwinInstanceDetails.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the CreateDigitalTwinInstanceDetails.Builder, which maintain a set of all explicitly set fields called CreateDigitalTwinInstanceDetails.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CreateDigitalTwinInstanceDetails.Builder

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
CreateDigitalTwinInstanceDetails(String iotDomainId, String authId, String externalKey, String displayName, String description, String digitalTwinAdapterId, String digitalTwinModelId, String digitalTwinModelSpecUri, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static CreateDigitalTwinInstanceDetails.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getAuthId()	The OCID of the resource (like VaultSecret, ClientCertificate etc.,) used to authenticate the digital twin instance.
Map<String,Map<String,Object>>	getDefinedTags()	Defined tags for this resource.
String	getDescription()	A short description of the resource.
String	getDigitalTwinAdapterId()	The OCID of the digital twin adapter.
String	getDigitalTwinModelId()	The OCID of the digital twin model.
String	getDigitalTwinModelSpecUri()	The URI of the digital twin model specification.
String	getDisplayName()	A user-friendly name.
String	getExternalKey()	A unique identifier for the physical entity (typically an IoT device) represented by the digital twin instance.
Map<String,String>	getFreeformTags()	Free-form tags for this resource.
String	getIotDomainId()	The OCID of the IoT domain.
int	hashCode()
CreateDigitalTwinInstanceDetails.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateDigitalTwinInstanceDetails

@Deprecated
@ConstructorProperties({"iotDomainId","authId","externalKey","displayName","description","digitalTwinAdapterId","digitalTwinModelId","digitalTwinModelSpecUri","freeformTags","definedTags"})
public CreateDigitalTwinInstanceDetails(String iotDomainId,
                                        String authId,
                                        String externalKey,
                                        String displayName,
                                        String description,
                                        String digitalTwinAdapterId,
                                        String digitalTwinModelId,
                                        String digitalTwinModelSpecUri,
                                        Map<String,String> freeformTags,
                                        Map<String,Map<String,Object>> definedTags)

Deprecated.

Method Detail

builder

public static CreateDigitalTwinInstanceDetails.Builder builder()

Create a new builder.

toBuilder

public CreateDigitalTwinInstanceDetails.Builder toBuilder()

getIotDomainId

public String getIotDomainId()

The OCID of the IoT domain.

Returns:

the value

getAuthId

public String getAuthId()

The OCID of the resource (like VaultSecret, ClientCertificate etc.,) used to authenticate the digital twin instance.

Returns:

the value

getExternalKey

public String getExternalKey()

A unique identifier for the physical entity (typically an IoT device) represented by the digital twin instance.

This could be a Bluetooth address, Ethernet MAC address, or serial number, depending on the use case. If not provided, the system will automatically generate one.

Returns:

the value

getDisplayName

public String getDisplayName()

A user-friendly name.

Does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns:

the value

getDescription

public String getDescription()

A short description of the resource.

Returns:

the value

getDigitalTwinAdapterId

public String getDigitalTwinAdapterId()

The OCID of the digital twin adapter.

Returns:

the value

getDigitalTwinModelId

public String getDigitalTwinModelId()

The OCID of the digital twin model.

Returns:

the value

getDigitalTwinModelSpecUri

public String getDigitalTwinModelSpecUri()

The URI of the digital twin model specification.

Returns:

the value

getFreeformTags

public Map<String,String> getFreeformTags()

Free-form tags for this resource.

Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.

Example: {"Department": "Finance"}

Returns:

the value

getDefinedTags

public Map<String,Map<String,Object>> getDefinedTags()

Defined tags for this resource.

Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {"Operations": {"CostCenter": "42"}}

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel