Class ListJobDefinitionsRequest

Inheritance

object

ListJobDefinitionsRequest

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

Examples

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

Fields

Declaration

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

Property Value

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

GlossaryKey

Declaration

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

Property Value

Type	Description
string	Unique glossary key.

IsIncremental

Declaration

[HttpConverter(TargetEnum.Query, "isIncremental")]
public bool? IsIncremental { get; set; }

Property Value

Type	Description
bool?	Whether job definition is an incremental harvest (true) or a full harvest (false).

JobExecutionState

Declaration

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

Property Value

Type	Description
JobExecutionState?	Job execution state.

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

Property Value

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

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.

SampleDataSizeInMBs

Declaration

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

Property Value

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

SortBy

Declaration

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

Property Value

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

SortOrder

Declaration

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

Property Value

Type	Description
ListJobDefinitionsRequest.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.

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