Class ListDigitalTwinAdaptersRequest
Implements
Inherited Members
Namespace: Oci.IotService.Requests
Assembly: OCI.DotNetSDK.Iot.dll
Syntax
public class ListDigitalTwinAdaptersRequest : IOciRequest
Examples
Click here to see an example of how to use ListDigitalTwinAdapters request.
Properties
DigitalTwinModelId
Declaration
[HttpConverter(TargetEnum.Query, "digitalTwinModelId")]
public string DigitalTwinModelId { get; set; }
Property Value
Type | Description |
---|---|
string | Filter resources that match the specified OCID of the digital twin model. |
DigitalTwinModelSpecUri
Declaration
[HttpConverter(TargetEnum.Query, "digitalTwinModelSpecUri")]
public string DigitalTwinModelSpecUri { get; set; }
Property Value
Type | Description |
---|---|
string | Filter resources that match the specified URI (DTMI) of the digital twin model. |
DisplayName
Declaration
[HttpConverter(TargetEnum.Query, "displayName")]
public string DisplayName { get; set; }
Property Value
Type | Description |
---|---|
string | Filter resources whose display name matches the specified value. |
Id
Declaration
[HttpConverter(TargetEnum.Query, "id")]
public string Id { get; set; }
Property Value
Type | Description |
---|---|
string | Filter resources by OCID. Must be a valid OCID of the resource type. |
IotDomainId
Declaration
[Required(ErrorMessage = "IotDomainId is required.")]
[HttpConverter(TargetEnum.Query, "iotDomainId")]
public string IotDomainId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID of the IoT domain in which to list digital twin resources. |
Remarks
Required
LifecycleState
Declaration
[HttpConverter(TargetEnum.Query, "lifecycleState")]
public LifecycleState? LifecycleState { get; set; }
Property Value
Type | Description |
---|---|
LifecycleState? | Filter resources whose lifecycleState matches the specified value. |
Limit
Declaration
[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }
Property Value
Type | Description |
---|---|
int? | For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. For important details about how pagination works, see List Pagination. |
OpcRequestId
Declaration
[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }
Property Value
Type | Description |
---|---|
string | Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, provide the request ID. |
Page
Declaration
[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }
Property Value
Type | Description |
---|---|
string | Page representing the requested page of items. |
SortBy
Declaration
[HttpConverter(TargetEnum.Query, "sortBy")]
public ListDigitalTwinAdaptersRequest.SortByEnum? SortBy { get; set; }
Property Value
Type | Description |
---|---|
ListDigitalTwinAdaptersRequest.SortByEnum? | The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. |
SortOrder
Declaration
[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListDigitalTwinAdaptersRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type | Description |
---|---|
ListDigitalTwinAdaptersRequest.SortOrderEnum? | Specifies sort order to use, either ASC (ascending) or DESC (descending). |