Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ListJobsRequest

example

Click here to see how to use ListJobsRequest.

Properties

Optional compartmentId

compartmentId: undefined | string

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

Optional displayName

displayName: undefined | string

A filter to return only resources that match the specified display name.

Optional id

id: undefined | string

The OCID on which to query for jobs.

Optional lifecycleState

lifecycleState: undefined | string

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

Optional limit

limit: undefined | number

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

Optional opcRequestId

opcRequestId: undefined | string

Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Optional page

page: undefined | string

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

Optional retryConfiguration

retryConfiguration: RetryConfiguration

RetryConfiguration to be used for the request NOTE : Retries are not supported for requests that have binary or stream bodies this also affects UploadManager operations For all requests with binary/stream bodies, retry attempts are not made

Optional sortBy

sortBy: SortBy

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.

Optional sortOrder

sortOrder: SortOrder

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

Optional stackId

stackId: undefined | string

The stack OCID on which to filter.