com.oracle.bmc.datacatalog.requests

Class ListJobDefinitionsRequest

java.lang.Object

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

com.oracle.bmc.datacatalog.requests.ListJobDefinitionsRequest

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

Example: Click here to see how to use ListJobDefinitionsRequest.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ListJobDefinitionsRequest.Builder	builder()
String	getCatalogId() Unique catalog identifier.
String	getConnectionKey() Unique connection key.
String	getCreatedById() OCID of the user who created the resource.
String	getDataAssetKey() Unique data asset key.
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.
List<ListJobDefinitionsRequest.Fields>	getFields() Specifies the fields to return in a job definition summary response.
Boolean	getIsIncremental() Whether job definition is an incremental harvest (true) or a full harvest (false).
JobExecutionState	getJobExecutionState() Job execution state.
JobType	getJobType() Job type.
LifecycleState	getLifecycleState() A filter to return only resources that match the specified 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	getSampleDataSizeInMBs() The sample data size in MB, specified as number of rows, for a metadata harvest.
ListJobDefinitionsRequest.SortBy	getSortBy() The field to sort by.
ListJobDefinitionsRequest.SortOrder	getSortOrder() The sort order to use, either ‘asc’ or ‘desc’.
Date	getTimeCreated() Time that the resource was created.
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 ListJobDefinitionsRequest.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".

getJobExecutionState

public JobExecutionState getJobExecutionState()

Job execution state.

getLifecycleState

public LifecycleState getLifecycleState()

A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

getJobType

public JobType getJobType()

Job type.

getIsIncremental

public Boolean getIsIncremental()

Whether job definition is an incremental harvest (true) or a full harvest (false).

getDataAssetKey

public String getDataAssetKey()

Unique data asset key.

getConnectionKey

public String getConnectionKey()

Unique connection key.

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.

getSampleDataSizeInMBs

public String getSampleDataSizeInMBs()

The sample data size in MB, specified as number of rows, for a metadata harvest.

getFields

public List<ListJobDefinitionsRequest.Fields> getFields()

Specifies the fields to return in a job definition summary response.

getSortBy

public ListJobDefinitionsRequest.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. Default order for TIMELATESTEXECUTIONSTARTED is descending. If no value is specified TIMECREATED is default.

getSortOrder

public ListJobDefinitionsRequest.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.