Class ListOceInstancesRequest

Inheritance

object

ListOceInstancesRequest

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.OceService.Requests

Assembly: OCI.DotNetSDK.Oce.dll

Syntax

public class ListOceInstancesRequest : IOciRequest

Examples

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

Properties

CompartmentId

Declaration

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

Property Value

Type	Description
string	The ID of the compartment in which to list resources.

Remarks

Required

DisplayName

Declaration

[HttpConverter(TargetEnum.Query, "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	A user-friendly name. Does not have to be unique, and it's changeable. Example: My new resource

LifecycleState

Declaration

[HttpConverter(TargetEnum.Query, "lifecycleState")]
public LifecycleState? LifecycleState { get; set; }

Property Value

Type	Description
LifecycleState?	Filter results on lifecycleState.

Limit

Declaration

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

Property Value

Type	Description
int?	The maximum number of items to return.

OpcRequestId

Declaration

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

Property Value

Type	Description
string	The client request ID for tracing.

Page

Declaration

[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }

Property Value

Type	Description
string	The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

SortBy

Declaration

[HttpConverter(TargetEnum.Query, "sortBy")]
public ListOceInstancesRequest.SortByEnum? SortBy { get; set; }

Property Value

Type	Description
ListOceInstancesRequest.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. If no value is specified timeCreated is default.

SortOrder

Declaration

[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListOceInstancesRequest.SortOrderEnum? SortOrder { get; set; }

Property Value

Type	Description
ListOceInstancesRequest.SortOrderEnum?	The sort order to use, either 'asc' or 'desc'.

TenancyId

Declaration

[HttpConverter(TargetEnum.Query, "tenancyId")]
public string TenancyId { get; set; }

Property Value

Type	Description
string	The ID of the tenancy in which to list resources.

Implements

IOciRequest