Class ListProjectsRequest

Inheritance

object

ListProjectsRequest

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

Assembly: OCI.DotNetSDK.Aidocument.dll

Syntax

public class ListProjectsRequest : IOciRequest

Examples

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

Properties

CompartmentId

Declaration

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

Property Value

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

DisplayName

Declaration

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

Property Value

Type	Description
string	A filter to return only resources that match the entire display name given.

Id

Declaration

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

Property Value

Type	Description
string	The filter to find the project with the given identifier.

LifecycleState

Declaration

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

Property Value

Type	Description
Project.LifecycleStateEnum?	The filter to match projects with the given 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 position at which to start retrieving results. This must come from the opc-next-page header field of a previous response.

SortBy

Declaration

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

Property Value

Type	Description
ListProjectsRequest.SortByEnum?	The field to sort by. Only one sort order may be provided. The default order for timeCreated is descending. The default order for displayName is ascending.

SortOrder

Declaration

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

Property Value

Type	Description
SortOrder?	The sort order to use, either 'ASC' or 'DESC'.

Implements

IOciRequest