Show / Hide Table of Contents

Class ListInstanceDevicesRequest

Inheritance
object
ListInstanceDevicesRequest
Implements
IOciRequest
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Oci.CoreService.Requests
Assembly: OCI.DotNetSDK.Core.dll
Syntax
public class ListInstanceDevicesRequest : IOciRequest
Examples

Click here to see an example of how to use ListInstanceDevices request.

Properties

InstanceId

Declaration
[Required(ErrorMessage = "InstanceId is required.")]
[HttpConverter(TargetEnum.Path, "instanceId")]
public string InstanceId { get; set; }
Property Value
Type Description
string

The OCID of the instance.

Remarks

Required

IsAvailable

Declaration
[HttpConverter(TargetEnum.Query, "isAvailable")]
public bool? IsAvailable { get; set; }
Property Value
Type Description
bool?

A filter to return only available devices or only used devices.

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.
Example: 50

Name

Declaration
[HttpConverter(TargetEnum.Query, "name")]
public string Name { get; set; }
Property Value
Type Description
string

A filter to return only devices that match the given name exactly.

OpcRequestId

Declaration
[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }
Property Value
Type Description
string

Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Page

Declaration
[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }
Property Value
Type Description
string

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

SortBy

Declaration
[HttpConverter(TargetEnum.Query, "sortBy")]
public ListInstanceDevicesRequest.SortByEnum? SortBy { get; set; }
Property Value
Type Description
ListInstanceDevicesRequest.SortByEnum?

The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.
Note: In general, some "List" operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these "List" operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

SortOrder

Declaration
[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListInstanceDevicesRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type Description
ListInstanceDevicesRequest.SortOrderEnum?

The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

Implements

IOciRequest
In this article
Back to top