C++ YT Wrapper
C++ library for working with YT clusters
Loading...
Searching...
No Matches
NYT::TListOperationsOptions Struct Reference

Options of NYT::IClient::ListOperations command. More...

#include <operation.h>

Public Member Functions

TSelf & IncludeArchive (bool)
 Search for operations in the archive in addition to Cypress.
TSelf & IncludeCounters (bool)
 Include the counters for different filter parameters in the response.
TSelf & Limit (i64)
 Return no more than Limit operations (current default and maximum value is 1000).
Time range specification

List operations with start time in half-closed interval [CursorTime, ToTime) if CursorDirection == Future or [FromTime, CursorTime) if CursorDirection == Past.

TSelf & FromTime (TInstant)
 Search for operations with start time >= FromTime.
TSelf & ToTime (TInstant)
 Search for operations with start time < ToTime.
TSelf & CursorTime (TInstant)
 Additional restriction on operation start time (useful for pagination).
TSelf & CursorDirection (ECursorDirection)
 Direction of pagination (see NYT::TListOperationsOptions::CursorTime).
Filters

Choose operations satisfying given filters.

TSelf & Filter (TString)
 Search for Filter as a substring in operation text factors (e.g. title or input/output table paths).
TSelf & Pool (TString)
 Choose operations whose pools include Pool.
TSelf & User (TString)
 Choose operations with given NYT::TOperationAttributes::AuthenticatedUser.
TSelf & State (EOperationState)
 Choose operations with given NYT::TOperationAttributes::State.
TSelf & Type (EOperationType)
 Choose operations with given NYT::TOperationAttributes::Type.
TSelf & WithFailedJobs (bool)
 Choose operations having (or not having) any failed jobs.

Detailed Description

Member Function Documentation

◆ CursorTime()

TSelf & NYT::TListOperationsOptions::CursorTime ( TInstant )

Additional restriction on operation start time (useful for pagination).

Search for operations with start time >= CursorTime if CursorDirection == Future and with start time < CursorTime if CursorDirection == Past

◆ IncludeCounters()

TSelf & NYT::TListOperationsOptions::IncludeCounters ( bool )

Include the counters for different filter parameters in the response.

Include number of operations for each pool, user, state, type and the number of operations having failed jobs.


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