Struct ExecutePlanRequest

pub struct ExecutePlanRequest {
    pub session_id: String,
    pub user_context: Option<UserContext>,
    pub operation_id: Option<String>,
    pub plan: Option<Plan>,
    pub client_type: Option<String>,
    pub request_options: Vec<RequestOption>,
    pub tags: Vec<String>,
}

A request to be executed by the service.

Fields

session_id: String

(Required)

The session_id specifies a spark session for a user id (which is specified by user_context.user_id). The session_id is set by the client to be able to collate streaming responses from different queries within the dedicated session. The id should be an UUID string of the format 00112233-4455-6677-8899-aabbccddeeff

user_context: Option<UserContext>

(Required) User context

user_context.user_id and session+id both identify a unique remote spark session on the server side.

operation_id: Option<String>

(Optional) Provide an id for this request. If not provided, it will be generated by the server. It is returned in every ExecutePlanResponse.operation_id of the ExecutePlan response stream. The id must be an UUID string of the format 00112233-4455-6677-8899-aabbccddeeff

plan: Option<Plan>

(Required) The logical plan to be executed / analyzed.

client_type: Option<String>

Provides optional information about the client sending the request. This field can be used for language or version specific information and is only intended for logging purposes and will not be interpreted by the server.

request_options: Vec<RequestOption>

Repeated element for options that can be passed to the request. This element is currently unused but allows to pass in an extension value used for arbitrary options.

tags: Vec<String>

Tags to tag the given execution with. Tags cannot contain ‘,’ character and cannot be empty strings. Used by Interrupt with interrupt.tag.

Implementations

impl ExecutePlanRequest

pub fn client_type(&self) -> &str

Returns the value of client_type, or the default value if client_type is unset.

pub fn operation_id(&self) -> &str

Returns the value of operation_id, or the default value if operation_id is unset.

Trait Implementations

impl Clone for ExecutePlanRequest

fn clone(&self) -> ExecutePlanRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExecutePlanRequest

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

Formats the value using the given formatter.

impl Default for ExecutePlanRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for ExecutePlanRequest

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, Self: Sized,

Encodes the message to a buffer.

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

where Self: Sized,

Encodes the message to a newly allocated buffer.

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

where B: BufMut, Self: Sized,

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

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

where Self: Sized,

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, Self: Sized,

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, Self: Sized,

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

impl PartialEq for ExecutePlanRequest

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ExecutePlanRequest