Class JobQueryParameters

Namespace

ArcanaDevelopment.adTempus.Shared

Assembly

ArcanaDevelopment.adTempus.Shared.dll

Parameters used when querying for jobs

[DataContract]
public class JobQueryParameters

Inheritance

object

JobQueryParameters

Derived

HistoryQueryParameters

Constructors

JobQueryParameters()

public JobQueryParameters()

JobQueryParameters(JobQueryParameters)

public JobQueryParameters(JobQueryParameters source)

Parameters

Name	Type	Description
source	JobQueryParameters

Fields

FetchOptions

Controls how data is fetched.

[DataMember]
public ObjectFetchOptions FetchOptions

Field Value

ObjectFetchOptions

IncludeHeldJobs

Determines whether data for held jobs is returned

[DataMember]
public IncludeExcludeType IncludeHeldJobs

Field Value

IncludeExcludeType

PageNumber

The page number of results to fetch.

[DataMember]
public int PageNumber

Field Value

int

Remarks

Set to 0 for no paging. See PageSize for more information.

PageSize

The number of records to return in one batch when using paging

[DataMember]
public int PageSize

Field Value

int

Remarks

By default a fetch returns all available records, which may exceed the limits of the communication channel. Use paging to return records in smaller batches. On the first call set PageSize to the maximum number of records to return in a single call and set PageNumber to 1. Continue calling the fetch method, incrementing PageNumber each time, until the call does not return any more records.

See Also

PageNumber

Properties

Agents

List of OIDs of Remote Agents to return records for

[DataMember]
public List<OID> Agents { get; protected set; }

Property Value

List<OID>

Tags

List of tags to include or exclude.

[DataMember]
public List<string> Tags { get; protected set; }

Property Value

List<string>

Remarks

To include a tag, prefix it with "-" in the list.

TargetComputers

List of names of computers (e.g., agents) to return records for

[DataMember]
public List<string> TargetComputers { get; protected set; }

Property Value

List<string>

TargetObjects

List of OIDs of the jobs, groups, or queues to query for. If no jobs or groups are specified, all jobs are included.

[DataMember]
public List<OID> TargetObjects { get; protected set; }

Property Value

List<OID>

Methods

GetTargetObjects(ClassID)

Gets all members of the TargetObjects collection that have the specified classID.

public List<OID> GetTargetObjects(ClassID classID)

Parameters

Name	Type	Description
classID	ClassID

Returns

List<OID>