Skip to main content

DataReviewServiceClient

nominal_api::scout::datareview::api

Struct DataReviewServiceClient

pub struct DataReviewServiceClient<T>(/* private fields */);

Expand description

The data review service manages the evaluation, disposition, and historical record of checks alerts.

Implementations§

impl<T> DataReviewServiceClient<T>
where T: Client,

pub fn batch_initiate( &self, auth_: &BearerToken, request: &BatchInitiateDataReviewRequest, ) -> Result<BatchInitiateDataReviewResponse, Error>

For each request, initiates data review for the requested run and checklist and executes the automatic checks against the run.

pub fn rerun_failed_automatic_checks( &self, auth_: &BearerToken, request: &RerunFailedAutomaticChecksRequest, ) -> Result<(), Error>

Re-executes the most recent failed automatic checks for the data review.

pub fn find_data_reviews( &self, auth_: &BearerToken, request: &FindDataReviewsRequest, ) -> Result<DataReviewPage, Error>

Returns the data reviews under the provided search parameters.

pub fn get( &self, auth_: &BearerToken, data_review_rid: &DataReviewRid, ) -> Result<DataReview, Error>

Throws if not found.

pub fn get_check_alert( &self, auth_: &BearerToken, check_alert_rid: &CheckAlertRid, ) -> Result<CheckAlert, Error>

👎Deprecated:

CheckAlerts have been replaced by Events. Please use the EventService instead.

Throws if not found.

pub fn get_check_alerts_for_data_review( &self, auth_: &BearerToken, data_review_rid: &DataReviewRid, ) -> Result<BTreeSet<CheckAlert>, Error>

👎Deprecated:

CheckAlerts have been replaced by Events. Please use the EventService instead.

Gets all check alerts from the provided data review.

pub fn get_check_alerts_histogram( &self, auth_: &BearerToken, request: &CheckAlertsHistogramRequest, ) -> Result<CheckAlertsHistogramResponse, Error>

👎Deprecated:

CheckAlerts have been replaced by Events. Please use the EventService instead.

Returns a histogram of alerts that occur across the provided runs or assets. At least one run or asset must be specified.

pub fn search_check_alerts( &self, auth_: &BearerToken, request: &SearchCheckAlertsRequest, ) -> Result<SearchCheckAlertsResponse, Error>

👎Deprecated:

CheckAlerts have been replaced by Events. Please use the EventService instead.

Returns the check alerts under the provided search parameters. At least one run or asset must be specified.

pub fn get_check_alert_action_log( &self, auth_: &BearerToken, check_alert_rid: &CheckAlertRid, ) -> Result<CheckAlertActionLog, Error>

👎Deprecated:

CheckAlerts have been replaced by Events. Please use the EventService instead.

Returns a record of the historical actions taken on the provided check alert.

pub fn get_check_alert_counts_for_notebooks( &self, auth_: &BearerToken, rids: &BTreeSet<NotebookRid>, ) -> Result<BTreeMap<NotebookRid, i32>, Error>

👎Deprecated:

CheckAlerts have been replaced by Events. Please use the EventService instead.

Returns the number of alerts attached to each provided notebook.

pub fn get_check_alert_status_for_notebooks( &self, auth_: &BearerToken, rids: &BTreeSet<NotebookRid>, ) -> Result<BTreeMap<NotebookRid, Option<CheckAlertStatus>>, Error>

👎Deprecated:

CheckAlerts have been replaced by Events. Please use the EventService instead.

Returns the check alert status of any linked violations for the provided notebooks. If none exist, an empty optional is returned.

pub fn perform_check_alert_action( &self, auth_: &BearerToken, check_alert_rid: &CheckAlertRid, request: &CheckAlertAction, ) -> Result<CheckAlert, Error>

👎Deprecated:

CheckAlerts have been replaced by Events. Please use the EventService instead.

Applies a check alert action to the specified check alert RID.

pub fn batch_perform_check_alert_action( &self, auth_: &BearerToken, request: &BatchCheckAlertActionRequest, ) -> Result<BatchCheckAlertActionResponse, Error>

👎Deprecated:

CheckAlerts have been replaced by Events. Please use the EventService instead.

Applies a check alert action to the specified check alert RIDs. If any of the check actions fail, then none of the check actions will be applied.

pub fn batch_perform_automatic_check_evaluation_review_action( &self, auth_: &BearerToken, request: &BatchAutomaticCheckEvaluationActionRequest, ) -> Result<BatchAutomaticCheckEvaluationActionResponse, Error>

👎Deprecated:

CheckAlerts have been replaced by Events. Please use the EventService instead.

Applies an action to the specified check evaluation RIDs. If any of the check actions fail, then none of the actions will be applied.

pub fn get_automatic_check_evaluation_action_log( &self, auth_: &BearerToken, rid: &AutomaticCheckEvaluationRid, ) -> Result<AutomaticCheckEvaluationActionLog, Error>

👎Deprecated:

CheckAlerts have been replaced by Events. Please use the EventService instead.

pub fn batch_perform_manual_check_alert_action( &self, auth_: &BearerToken, request: &BatchManualCheckEvaluationActionRequest, ) -> Result<(), Error>

👎Deprecated:

No longer in use

Applies an action to the specified check evaluation RIDs. If any of the check actions fail, then none of the actions will be applied.

pub fn get_manual_check_evaluation_action_log( &self, auth_: &BearerToken, rid: &ManualCheckEvaluationRid, ) -> Result<ManualCheckEvaluationActionLog, Error>

👎Deprecated:

No longer in use

Returns a record of the historical manual actions taken on the provided check evaluation.

pub fn archive_data_review( &self, auth_: &BearerToken, data_review_rid: &DataReviewRid, ) -> Result<bool, Error>

Archives the data review with the given rid.

pub fn batch_archive_data_review( &self, auth_: &BearerToken, rids: &BTreeSet<DataReviewRid>, ) -> Result<(), Error>

Batch archives the data reviews with the given rids.

pub fn unarchive_data_review( &self, auth_: &BearerToken, data_review_rid: &DataReviewRid, ) -> Result<(), Error>

Unarchives the data review with the given rid.

pub fn get_data_review_check_metrics( &self, auth_: &BearerToken, request: &GetDataReviewCheckMetricsRequest, ) -> Result<GetDataReviewCheckMetricsResponse, Error>

Trait Implementations§

impl<T: Clone> Clone for DataReviewServiceClient<T>

fn clone(&self) -> DataReviewServiceClient<T>

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl<T: Debug> Debug for DataReviewServiceClient<T>

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

Formats the value using the given formatter. Read more

impl<T> Service<T> for DataReviewServiceClient<T>
where T: Client,

fn new(client: T) -> Self

Creates a new service wrapping an HTTP client.

Auto Trait Implementations§

impl<T> Freeze for DataReviewServiceClient<T>
where T: Freeze,

impl<T> RefUnwindSafe for DataReviewServiceClient<T>
where T: RefUnwindSafe,

impl<T> Send for DataReviewServiceClient<T>
where T: Send,

impl<T> Sync for DataReviewServiceClient<T>
where T: Sync,

impl<T> Unpin for DataReviewServiceClient<T>
where T: Unpin,

impl<T> UnsafeUnpin for DataReviewServiceClient<T>
where T: UnsafeUnpin,

impl<T> UnwindSafe for DataReviewServiceClient<T>
where T: UnwindSafe,

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> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.

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> IntoRequest<T> for T

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request

impl<L> LayerExt<L> for L

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.

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 = Infallible

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