Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ListJobsRequest

example

Click here to see how to use ListJobsRequest.

Properties

catalogId

catalogId: string

Unique catalog identifier.

Optional connectionKey

connectionKey: undefined | string

Unique connection key.

Optional createdById

createdById: undefined | string

OCID of the user who created the resource.

Optional dataAssetKey

dataAssetKey: undefined | string

Unique data asset key.

Optional displayName

displayName: undefined | string

A filter to return only resources that match the entire display name given. The match is not case sensitive.

Optional displayNameContains

displayNameContains: undefined | string

A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with "Cu".

Optional executionCount

executionCount: undefined | number

The total number of executions for this job schedule.

Optional fields

fields: Array<Fields>

Specifies the fields to return in a job summary response.

Optional jobDefinitionKey

jobDefinitionKey: undefined | string

Unique job definition key.

Optional jobType

jobType: model.JobType

Job type.

Optional lifecycleState

lifecycleState: model.JobLifecycleState

Job lifecycle state.

Optional limit

limit: undefined | number

The maximum number of items to return.

Optional opcRequestId

opcRequestId: undefined | string

The client request ID for tracing.

Optional page

page: undefined | string

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

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 scheduleCronExpression

scheduleCronExpression: undefined | string

Schedule specified in the cron expression format that has seven fields for second, minute, hour, day-of-month, month, day-of-week, year. It can also include special characters like * for all and ? for any. There are also pre-defined schedules that can be specified using special strings. For example, @hourly will run the job every hour.

Optional scheduleType

scheduleType: model.JobScheduleType

Type of the job schedule.

Optional sortBy

sortBy: SortBy

The field to sort by. Only one sort order may be provided. Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If no value is specified TIMECREATED is default.

Optional sortOrder

sortOrder: SortOrder

The sort order to use, either 'asc' or 'desc'.

Optional timeCreated

timeCreated: Date

Time that the resource was created. An RFC3339 formatted datetime string.

Optional timeOfLatestExecution

timeOfLatestExecution: Date

The date and time the most recent execution for this job ,in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z

Optional timeScheduleBegin

timeScheduleBegin: Date

Date that the schedule should be operational. An RFC3339 formatted datetime string.

Optional timeScheduleEnd

timeScheduleEnd: Date

Date that the schedule should end from being operational. An RFC3339 formatted datetime string.

Optional timeUpdated

timeUpdated: Date

Time that the resource was updated. An RFC3339 formatted datetime string.

Optional updatedById

updatedById: undefined | string

OCID of the user who updated the resource.