Struct ydb_grpc::ydb_proto::operations::OperationParams

pub struct OperationParams {
    pub operation_mode: i32,
    pub operation_timeout: Option<Duration>,
    pub cancel_after: Option<Duration>,
    pub labels: HashMap<String, String>,
    pub report_cost_info: i32,
}

Fields

operation_mode: i32

operation_timeout: Option<Duration>

Indicates that client is no longer interested in the result of operation after the specified duration starting from the time operation arrives at the server. Server will try to stop the execution of operation and if no result is currently available the operation will receive TIMEOUT status code, which will be sent back to client if it was waiting for the operation result. Timeout of operation does not tell anything about its result, it might be completed successfully or cancelled on server.

cancel_after: Option<Duration>

Server will try to cancel the operation after the specified duration starting from the time the operation arrives at server. In case of successful cancellation operation will receive CANCELLED status code, which will be sent back to client if it was waiting for the operation result. In case when cancellation isn’t possible, no action will be performed.

labels: HashMap<String, String>

User-defined labels of operation.

report_cost_info: i32

If enabled, server will report cost information, if supported by the operation. This flag is mostly useful for SYNC operations, to get the cost information in the response.

Implementations

impl OperationParams

pub fn operation_mode(&self) -> OperationMode

Returns the enum value of operation_mode, or the default if the field is set to an invalid enum value.

pub fn set_operation_mode(&mut self, value: OperationMode)

Sets operation_mode to the provided enum value.

pub fn report_cost_info(&self) -> Status

Returns the enum value of report_cost_info, or the default if the field is set to an invalid enum value.

pub fn set_report_cost_info(&mut self, value: Status)

Sets report_cost_info to the provided enum value.

Trait Implementations

impl Clone for OperationParams

fn clone(&self) -> OperationParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OperationParams

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

Formats the value using the given formatter.

impl Default for OperationParams

fn default() -> Self

Returns the “default value” for a type.

impl Message for OperationParams

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8, Global>

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError> where
    B: BufMut, 

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8, Global>

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    B: Buf,
    Self: Default, 

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError> where
    B: Buf, 

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq<OperationParams> for OperationParams

fn eq(&self, other: &OperationParams) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &OperationParams) -> bool

This method tests for !=.

impl StructuralPartialEq for OperationParams