Skip to main content

OperationParameters

Struct OperationParameters 

Source
pub struct OperationParameters { /* private fields */ }
Expand description

What Client::update_operation_parameters should change.

The parameters a running operation will accept: which pool it competes in, and how much of that pool it gets. Everything else about an operation is fixed when it starts.

use ytsaurus_client::OperationParameters;

// Move a job that turned out to matter into the pool that gets served
// first, and give it twice the share.
let urgent = OperationParameters::new().with_pool("interactive").with_weight(2.0);

Implementations§

Source§

impl OperationParameters

Source

pub fn new() -> Self

Changes nothing yet.

Source

pub fn with_pool(self, pool: impl AsRef<str>) -> Self

Moves the operation into another pool.

Applies to every pool tree the operation runs in. Verified on a local cluster: a top-level key here lands under runtime_parameters/scheduling_options_per_pool_tree/<tree>, once per tree. OperationParameters::with_pool_in_tree names one instead.

Source

pub fn with_weight(self, weight: f64) -> Self

Changes the operation’s share of its pool.

A double, and the cluster means it: 1.0 is the default share, 2.0 is twice as much of whatever the pool gets.

Source

pub fn with_pool_in_tree( self, tree: impl AsRef<str>, pool: impl AsRef<str>, ) -> Self

Moves the operation into another pool of one tree.

For an installation with more than one pool tree, where the operation should move in one of them and stay where it is in the others.

Adds to what the tree’s entry already holds rather than replacing it: update_operation_parameters assigns, so an entry that arrived here with a weight in it and left with only a pool would reset that weight on the cluster and report success.

Source

pub fn with_raw(self, key: impl AsRef<str>, value: YsonValue) -> Self

Sets any parameter this builder does not model — acl, annotations, scheduling_tag_filter.

Source

pub fn is_empty(&self) -> bool

Whether this would ask the cluster to change nothing.

Client::update_operation_parameters refuses an empty update: the cluster answers 200 and does nothing, so the mistake is invisible where it is made.

Source

pub fn to_yson(&self) -> YsonValue

The parameters as update_operation_parameters wants them.

Trait Implementations§

Source§

impl Clone for OperationParameters

Source§

fn clone(&self) -> OperationParameters

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for OperationParameters

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for OperationParameters

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more