Class ListJobExecutionsRequest

Inheritance

object

ListJobExecutionsRequest

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 ListJobExecutionsRequest : IOciRequest

Examples

Click here to see an example of how to use ListJobExecutions 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

CreatedById

Declaration

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

Property Value

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

DataEntityKey

Declaration

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

Property Value

Type	Description
string	Unique entity key.

ErrorCode

Declaration

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

Property Value

Type	Description
string	Error code returned from the job execution or null if job is still running or didn't return an error.

ErrorMessage

Declaration

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

Property Value

Type	Description
string	Error message returned from the job execution or null if job is still running or didn't return an error.

EventKey

Declaration

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

Property Value

Type	Description
string	Event that triggered the execution of this job or null.

ExternalUrl

Declaration

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

Property Value

Type	Description
string	The a URL of the job for accessing this resource and its status.

Fields

Declaration

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

Property Value

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

JobKey

Declaration

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

Property Value

Type	Description
string	Unique job key.

Remarks

Required

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 JobExecutionState? LifecycleState { get; set; }

Property Value

Type	Description
JobExecutionState?	Job execution 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.

ParentKey

Declaration

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

Property Value

Type	Description
string	The unique key of the parent execution or null if this job execution has no parent.

ProcessKey

Declaration

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

Property Value

Type	Description
string	Process identifier related to the job execution.

SortBy

Declaration

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

Property Value

Type	Description
ListJobExecutionsRequest.SortByEnum?	The field to sort by. Only one sort order may be provided; the default is descending. Use sortOrder query param to specify order.

SortOrder

Declaration

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

Property Value

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

SubType

Declaration

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

Property Value

Type	Description
string	Sub-type of this job execution.

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.

TimeEnd

Declaration

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

Property Value

Type	Description
DateTime?	Time that the job execution ended or null if the job is still running or hasn't run yet. An RFC3339 formatted datetime string.

TimeStart

Declaration

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

Property Value

Type	Description
DateTime?	Time that the job execution was started or in the case of a future time, the time when the job will start. 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