Show / Hide Table of Contents

Class ListJobsRequest

Inheritance
object
ListJobsRequest
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.ResourcemanagerService.Requests
Assembly: OCI.DotNetSDK.Resourcemanager.dll
Syntax
public class ListJobsRequest : IOciRequest
Examples

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

Properties

CompartmentId

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

A filter to return only resources that exist in the compartment, identified by OCID.

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 given display name exactly. Use this filter to list a resource by name. Requires sortBy set to DISPLAYNAME. Alternatively, when you know the resource OCID, use the related Get operation.

Id

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

The OCID on which to query for jobs.

LifecycleState

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

A filter that returns all resources that match the specified lifecycle state. The state value is case-insensitive.
Allowable values:

  • ACCEPTED
  • IN_PROGRESS
  • FAILED
  • SUCCEEDED
  • CANCELING
  • CANCELED

Limit

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

The number of items returned in a paginated List call. For information about pagination, see List Pagination.

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, please provide the request ID.

Page

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

The value of the opc-next-page response header from the preceding List call. For information about pagination, see List Pagination.

SortBy

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

The field to use when sorting returned resources. By default, TIMECREATED is ordered descending. By default, DISPLAYNAME is ordered ascending. Note that you can sort only on one field.

SortOrder

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

The sort order to use when sorting returned resources. Ascending (ASC) or descending (DESC).

StackId

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

The stack OCID on which to filter.

Implements

IOciRequest
In this article
Back to top