Struct ArtifactStatusesRequest

pub struct ArtifactStatusesRequest {
    pub session_id: String,
    pub user_context: Option<UserContext>,
    pub client_type: Option<String>,
    pub names: Vec<String>,
}

Request to get current statuses of artifacts at the server side.

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>

User context

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.

names: Vec<String>

The name of the artifact is expected in the form of a “Relative Path” that is made up of a sequence of directories and the final file element. Examples of “Relative Path“s: “jars/test.jar”, “classes/xyz.class”, “abc.xyz”, “a/b/X.jar”. The server is expected to maintain the hierarchy of files as defined by their name. (i.e The relative path of the file on the server’s filesystem will be the same as the name of the provided artifact)

Implementations

impl ArtifactStatusesRequest

pub fn client_type(&self) -> &str

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

Trait Implementations

impl Clone for ArtifactStatusesRequest

fn clone(&self) -> ArtifactStatusesRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ArtifactStatusesRequest

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

Formats the value using the given formatter.

impl Default for ArtifactStatusesRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for ArtifactStatusesRequest

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 ArtifactStatusesRequest

fn eq(&self, other: &ArtifactStatusesRequest) -> 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 ArtifactStatusesRequest