com.oracle.bmc.datacatalog.requests

Class ListJobsRequest

java.lang.Object

com.oracle.bmc.requests.BmcRequest<Void>

com.oracle.bmc.datacatalog.requests.ListJobsRequest

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20190325")
public class ListJobsRequest
extends BmcRequest<Void>

Example: Click here to see how to use ListJobsRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListJobsRequest.Builder
static class	ListJobsRequest.Fields Specifies the fields to return in a job summary response.
static class	ListJobsRequest.SortBy The field to sort by.
static class	ListJobsRequest.SortOrder The sort order to use, either ‘asc’ or ‘desc’.

Method Summary

Modifier and Type	Method and Description
static ListJobsRequest.Builder	builder()
String	getCatalogId() Unique catalog identifier.
String	getConnectionKey() Unique connection key.
String	getCreatedById() OCID of the user who created the resource.
String	getDisplayName() A filter to return only resources that match the entire display name given.
String	getDisplayNameContains() A filter to return only resources that match display name pattern given.
Integer	getExecutionCount() The total number of executions for this job schedule.
List<ListJobsRequest.Fields>	getFields() Specifies the fields to return in a job summary response.
String	getJobDefinitionKey() Unique job definition key.
JobType	getJobType() Job type.
JobLifecycleState	getLifecycleState() Job lifecycle state.
Integer	getLimit() The maximum number of items to return.
String	getOpcRequestId() The client request ID for tracing.
String	getPage() The page token representing the page at which to start retrieving results.
String	getScheduleCronExpression() Schedule specified in the cron expression format that has seven fields for second, minute, hour, day-of-month, month, day-of-week, year.
JobScheduleType	getScheduleType() Type of the job schedule.
ListJobsRequest.SortBy	getSortBy() The field to sort by.
ListJobsRequest.SortOrder	getSortOrder() The sort order to use, either ‘asc’ or ‘desc’.
Date	getTimeCreated() Time that the resource was created.
Date	getTimeOfLatestExecution() The date and time the most recent execution for this job ,in the format defined by RFC3339.
Date	getTimeScheduleBegin() Date that the schedule should be operational.
Date	getTimeScheduleEnd() Date that the schedule should end from being operational.
Date	getTimeUpdated() Time that the resource was updated.
String	getUpdatedById() OCID of the user who updated the resource.

Methods inherited from class com.oracle.bmc.requests.BmcRequest

getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static ListJobsRequest.Builder builder()

getCatalogId

public String getCatalogId()

Unique catalog identifier.

getDisplayName

public String getDisplayName()

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

getDisplayNameContains

public String getDisplayNameContains()

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".

getLifecycleState

public JobLifecycleState getLifecycleState()

Job lifecycle state.

getTimeCreated

public Date getTimeCreated()

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

getTimeUpdated

public Date getTimeUpdated()

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

getCreatedById

public String getCreatedById()

OCID of the user who created the resource.

getUpdatedById

public String getUpdatedById()

OCID of the user who updated the resource.

getJobType

public JobType getJobType()

Job type.

getJobDefinitionKey

public String getJobDefinitionKey()

Unique job definition key.

getScheduleCronExpression

public String getScheduleCronExpression()

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.

getTimeScheduleBegin

public Date getTimeScheduleBegin()

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

getTimeScheduleEnd

public Date getTimeScheduleEnd()

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

getScheduleType

public JobScheduleType getScheduleType()

Type of the job schedule.

getConnectionKey

public String getConnectionKey()

Unique connection key.

getFields

public List<ListJobsRequest.Fields> getFields()

Specifies the fields to return in a job summary response.

getExecutionCount

public Integer getExecutionCount()

The total number of executions for this job schedule.

getTimeOfLatestExecution

public Date getTimeOfLatestExecution()

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

getSortBy

public ListJobsRequest.SortBy getSortBy()

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.

getSortOrder

public ListJobsRequest.SortOrder getSortOrder()

The sort order to use, either ‘asc’ or ‘desc’.

getLimit

public Integer getLimit()

The maximum number of items to return.

getPage

public String getPage()

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

getOpcRequestId

public String getOpcRequestId()

The client request ID for tracing.