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

Assembly: OCI.DotNetSDK.Datacatalog.dll

Syntax

public class ListJobsRequest : IOciRequest

Examples

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

Properties

CatalogId

Declaration

[Required(ErrorMessage = "CatalogId is required.")]
[HttpConverter(TargetEnum.Path, "catalogId")]
public string CatalogId { get; set; }

Property Value

Type	Description
string	Unique catalog identifier.

Remarks

Required

ConnectionKey

Declaration

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

Property Value

Type	Description
string	Unique connection key.

CreatedById

Declaration

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

Property Value

Type	Description
string	OCID of the user who created the resource.

DataAssetKey

Declaration

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

Property Value

Type	Description
string	Unique data asset key.

DisplayName

Declaration

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

Property Value

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

DisplayNameContains

Declaration

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

Property Value

Type	Description
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" or has the pattern "Cu" anywhere in between.

ExecutionCount

Declaration

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

Property Value

Type	Description
int?	The total number of executions for this job schedule.

Fields

Declaration

[HttpConverter(TargetEnum.Query, "fields", CollectionFormatType.Multi)]
public List<ListJobsRequest.FieldsEnum> Fields { get; set; }

Property Value

Type	Description
List<ListJobsRequest.FieldsEnum>	Specifies the fields to return in a job summary response.

GlossaryKey

Declaration

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

Property Value

Type	Description
string	Unique glossary key.

JobDefinitionKey

Declaration

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

Property Value

Type	Description
string	Unique job definition key.

JobType

Declaration

[HttpConverter(TargetEnum.Query, "jobType")]
public JobType? JobType { get; set; }

Property Value

Type	Description
JobType?	Job type.

LifecycleState

Declaration

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

Property Value

Type	Description
JobLifecycleState?	Job lifecycle state.

Limit

Declaration

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

Property Value

Type	Description
int?	The maximum number of items to return.

OpcRequestId

Declaration

[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }

Property Value

Type	Description
string	The client request ID for tracing.

Page

Declaration

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

Property Value

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

ScheduleCronExpression

Declaration

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

Property Value

Type	Description
string	Interval on which the job will be run. Value is specified as a cron-supported time specification "nickname". The following subset of those is supported: @monthly, @weekly, @daily, @hourly. For metastore sync, an additional option @default is supported, which will schedule jobs at a more granular frequency.

ScheduleType

Declaration

[HttpConverter(TargetEnum.Query, "scheduleType")]
public JobScheduleType? ScheduleType { get; set; }

Property Value

Type	Description
JobScheduleType?	Type of the job schedule.

SortBy

Declaration

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

Property Value

Type	Description
ListJobsRequest.SortByEnum?	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.

SortOrder

Declaration

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

Property Value

Type	Description
ListJobsRequest.SortOrderEnum?	The sort order to use, either 'asc' or 'desc'.

TimeCreated

Declaration

[HttpConverter(TargetEnum.Query, "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	Time that the resource was created. An RFC3339 formatted datetime string.

TimeOfLatestExecution

Declaration

[HttpConverter(TargetEnum.Query, "timeOfLatestExecution")]
public DateTime? TimeOfLatestExecution { get; set; }

Property Value

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

TimeScheduleBegin

Declaration

[HttpConverter(TargetEnum.Query, "timeScheduleBegin")]
public DateTime? TimeScheduleBegin { get; set; }

Property Value

Type	Description
DateTime?	Date that the schedule should be operational. An RFC3339 formatted datetime string.

TimeScheduleEnd

Declaration

[HttpConverter(TargetEnum.Query, "timeScheduleEnd")]
public DateTime? TimeScheduleEnd { get; set; }

Property Value

Type	Description
DateTime?	Date that the schedule should end from being operational. An RFC3339 formatted datetime string.

TimeUpdated

Declaration

[HttpConverter(TargetEnum.Query, "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	Time that the resource was updated. An RFC3339 formatted datetime string.

UpdatedById

Declaration

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

Property Value

Type	Description
string	OCID of the user who updated the resource.

Implements

IOciRequest