Class ListOdaInstancesRequest

Inheritance
object
ListOdaInstancesRequest
Implements
Inherited Members
Namespace: Oci.OdaService.Requests
Assembly: OCI.DotNetSDK.Oda.dll
Syntax
public class ListOdaInstancesRequest : IOciRequest
Examples

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

Properties

CompartmentId

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

List the Digital Assistant instances that belong to this compartment.
Remarks

Required

DisplayName

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

List only the information for the Digital Assistant instance with this user-friendly name. These names don't have to be unique and may change.
Example: My new resource

LifecycleState

Declaration
[HttpConverter(TargetEnum.Query, "lifecycleState")]
public ListOdaInstancesRequest.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type Description
ListOdaInstancesRequest.LifecycleStateEnum?

List only the Digital Assistant instances that are in this lifecycle state.

Limit

Declaration
[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }
Property Value
Type Description
int?

The maximum number of items to return per page.

OpcRequestId

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

The client request ID for tracing. This value is included in the opc-request-id response header.

Page

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

The page at which to start retrieving results.
You get this value from the opc-next-page header in a previous list request. To retireve the first page, omit this query parameter.
Example: MToxMA==

SortBy

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

Sort on this field. You can specify one sort order only. The default sort field is TIMECREATED.
The default sort order for TIMECREATED is descending, and the default sort order for DISPLAYNAME is ascending.

SortOrder

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

Sort the results in this order, use either ASC (ascending) or DESC (descending).

Implements