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

Assembly: OCI.DotNetSDK.Datascience.dll

Syntax

public class ListJobsRequest : IOciRequest

Examples

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

Properties

CompartmentId

Declaration

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

Property Value

Type	Description
string	Filter results by the OCID of the compartment.

Remarks

Required

CreatedBy

Declaration

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

Property Value

Type	Description
string	Filter results by the OCID of the user who created the resource.

DisplayName

Declaration

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

Property Value

Type	Description
string	Filter results by its user-friendly name.

Id

Declaration

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

Property Value

Type	Description
string	Filter results by OCID. Must be an OCID of the correct type for the resource type.

LifecycleState

Declaration

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

Property Value

Type	Description
JobLifecycleState?	Filter results by the specified lifecycle state. Must be a valid state for the resource type.

Limit

Declaration

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

Property Value

Type	Description
int?	For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. 1 is the minimum, 100 is the maximum. See List Pagination. Example: 50

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

Page

Declaration

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

Property Value

Type	Description
string	For list pagination. The value of the `opc-next-page` response header from the previous "List" call. See List Pagination.

ProjectId

Declaration

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

Property Value

Type	Description
string	Filter results by the OCID of the project.

SortBy

Declaration

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

Property Value

Type	Description
ListJobsRequest.SortByEnum?	Specifies the field to sort by. Accepts only one field. By default, when you sort by `timeCreated`, the results are shown in descending order. When you sort by `displayName`, the results are shown in ascending order. Sort order for the `displayName` field is case sensitive.

SortOrder

Declaration

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

Property Value

Type	Description
ListJobsRequest.SortOrderEnum?	Specifies sort order to use, either `ASC` (ascending) or `DESC` (descending).

Implements

IOciRequest