NYT::TListJobsOptions Struct Reference

Options for NYT::IClient::ListJobs. More...

#include <operation.h>

Public Member Functions
TSelf &	Offset (i64)
	Data source.
Filters
Return only jobs with given value of parameter (type, state, address and existence of stderr). If a field is Nothing(), return jobs with all possible values of the corresponding parameter.
TSelf &	Type (EJobType)
	Job type.
TSelf &	State (EJobState)
	Job state.
TSelf &	Address (TString)
	Address of the cluster node where job was running.
TSelf &	WithStderr (bool)
	Return only jobs whose stderr has been saved.
TSelf &	WithSpec (bool)
	Return only jobs whose spec has been saved.
TSelf &	WithFailContext (bool)
	Return only jobs whose fail context has been saved.
TSelf &	WithMonitoringDescriptor (bool)
	Return only jobs with monitoring descriptor.
TSelf &	WithInterruptionInfo (bool)
	Return only jobs with interruption info.
TSelf &	OperationIncarnation (TString)
	Return only jobs with given operation incarnation.
TSelf &	MonitoringDescriptor (TString)
	Return only jobs with given monitoring descriptor.
TSelf &	FromTime (TInstant)
	Search for jobs with start time >= FromTime.
TSelf &	ToTime (TInstant)
	Search for jobs with start time <= ToTime.
TSelf &	ContinuationToken (TString)
	Search for jobs with filters encoded in token.
TSelf &	AttributeFilter (TJobAttributeFilter)
	Return only requested job attributes.
Sort options
TSelf &	SortField (EJobSortField)
	Sort by this field.
TSelf &	SortOrder (ESortOrder)
	Sort order.

Detailed Description

Options for NYT::IClient::ListJobs.

See also

https://ytsaurus.tech/docs/en/api/commands.html#list_jobs

Member Function Documentation

Offset()

TSelf & NYT::TListJobsOptions::Offset

(

i64

)

Data source.

Where to search for jobs: in scheduler and Cypress ('Runtime'), in archive ('Archive'), automatically basing on operation presence in Cypress ('Auto') or choose manually (`Manual'). */ TSelf& DataSource ( EListJobsDataSource ); ;

/

Deprecated

TSelf& IncludeCypress ( bool ); ;

/

Deprecated

TSelf& IncludeControllerAgent ( bool ); ;

/

Deprecated

TSelf& IncludeArchive ( bool ); ;

/ / Maximum number of jobs to return. TSelf& Limit ( i64 ); ;

/**

Number of jobs (in specified sort order) to skip.

Together with NYT::TListJobsOptions::Limit may be used for pagination.

---

The documentation for this struct was generated from the following file:

• yt/cpp/mapreduce/interface/operation.h