Show / Hide Table of Contents

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.DevopsService.Requests
Assembly: OCI.DotNetSDK.Devops.dll
Syntax
public class ListProjectsRequest : IOciRequest
Examples

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

Properties

CompartmentId

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

The OCID of the compartment in which to list resources.

Remarks

Required

Id

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

Unique identifier or OCID for listing a single resource by ID.

LifecycleState

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

A filter to return only Projects that matches 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.

Name

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

A filter to return only resources that match the entire name given.

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

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 ListProjectsRequest.SortByEnum? SortBy { get; set; }
Property Value
Type Description
ListProjectsRequest.SortByEnum?

The field to sort by. Only one sort order may be provided. Default order for time created is descending. Default order for display name is ascending. If no value is specified, then the default time created value is considered.

SortOrder

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

The sort order to use. Use either ascending or descending.

Implements

IOciRequest
In this article
Back to top