Skip to main content

ValidateProgramRequest

feldera_rest_api::types

Struct ValidateProgramRequest

pub struct ValidateProgramRequest {
    pub ir: Option<bool>,
    pub program_code: String,
    pub runtime_version: Option<String>,
}

Expand description

Request body for the program validation endpoint.

JSON schema

{
 "description": "Request body for the program validation endpoint.",
 "type": "object",
 "required": [
   "program_code"
 ],
 "properties": {
   "ir": {
     "description": "Return the program IR (dataflow) in the response. `false` by default;\nmost callers only need to know whether the program is valid.",
     "type": "boolean"
   },
   "program_code": {
     "description": "SQL program code to validate.",
     "type": "string"
   },
   "runtime_version": {
     "description": "Runtime version to compile with: a version tag (`vX.Y.Z`) or a\n40-character git SHA. If omitted, the platform's default runtime is used.",
     "type": [
       "string",
       "null"
     ]
   }
 }
}

Fields§

§ir: Option<bool>

Return the program IR (dataflow) in the response. false by default; most callers only need to know whether the program is valid.

§program_code: String

SQL program code to validate.

§runtime_version: Option<String>

Runtime version to compile with: a version tag (vX.Y.Z) or a 40-character git SHA. If omitted, the platform’s default runtime is used.

Implementations§

impl ValidateProgramRequest

pub fn builder() -> ValidateProgramRequest

Trait Implementations§

impl Clone for ValidateProgramRequest

fn clone(&self) -> ValidateProgramRequest

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

impl Debug for ValidateProgramRequest

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for ValidateProgramRequest

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

impl From<&ValidateProgramRequest> for ValidateProgramRequest

fn from(value: &ValidateProgramRequest) -> Self

Converts to this type from the input type.

impl From<ValidateProgramRequest> for ValidateProgramRequest

fn from(value: ValidateProgramRequest) -> Self

Converts to this type from the input type.

impl Serialize for ValidateProgramRequest

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

Serialize this value into the given Serde serializer. Read more

impl TryFrom<ValidateProgramRequest> for ValidateProgramRequest

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: ValidateProgramRequest) -> Result<Self, ConversionError>

Performs the conversion.

Auto Trait Implementations§

impl Freeze for ValidateProgramRequest

impl RefUnwindSafe for ValidateProgramRequest

impl Send for ValidateProgramRequest

impl Sync for ValidateProgramRequest

impl Unpin for ValidateProgramRequest

impl UnsafeUnpin for ValidateProgramRequest

impl UnwindSafe for ValidateProgramRequest

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

impl<T> ErasedDestructor for T
where T: 'static,

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self> ⓘ

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

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

fn into(self) -> U

Calls U::from(self).

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

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

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more

impl<T> Same for T

type Output = T

Should always be Self

impl<T> Serialize for T
where T: Serialize + ?Sized,

fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<Ok, Error>

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = !

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

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