VizierClient

oss_vizier

Struct VizierClient 

Source 
pub struct VizierClient<T> {
    pub service: VizierServiceClient<T>,
    /* private fields */
}
Expand description

Vizier client.

Fields§

§service: VizierServiceClient<T>

The Vizier service client.

Implementations§

Source§

impl<T> VizierClient<T>
where T: GrpcService<Body>, T::Error: Into<StdError>, T::ResponseBody: Body<Data = Bytes> + Send + 'static, <T::ResponseBody as Body>::Error: Into<StdError> + Send,

Source

pub fn new(owner: String, service: VizierServiceClient<T>) -> Self

Creates a new Vizier client.

Source

pub fn mk_study_request_builder(&self) -> RequestBuilder

Creates a new crate::vizier::CreateStudyRequest builder.

Source

pub fn mk_get_study_request(&self, study_name: StudyName) -> GetStudyRequest

Creates a new GetStudyRequest.

Source

pub fn mk_delete_study_request( &self, study_name: StudyName, ) -> DeleteStudyRequest

Creates a new DeleteStudyRequest.

Source

pub fn mk_list_studies_request_builder(&self) -> RequestBuilder

Creates a new crate::vizier::ListStudiesRequest builder.

Source

pub fn mk_get_trial_request(&self, trial_name: TrialName) -> GetTrialRequest

Creates a new GetTrialRequest.

Source

pub fn mk_suggest_trials_request( &self, study_name: StudyName, suggestion_count: i32, client_id: String, ) -> SuggestTrialsRequest

Creates a new SuggestTrialsRequest.

Source

pub fn mk_create_trial_request( &self, study_name: StudyName, trial: Trial, ) -> CreateTrialRequest

Creates a new CreateTrialRequest.

Source

pub fn mk_delete_trial_request( &self, trial_name: TrialName, ) -> DeleteTrialRequest

Creates a new DeleteTrialRequest.

Source

pub fn mk_list_trials_request_builder( &self, study_name: StudyName, ) -> RequestBuilder

Creates a new crate::vizier::ListTrialsRequest builder.

Source

pub fn mk_add_trial_measurement_request( &self, trial_name: TrialName, measurement: Measurement, ) -> AddTrialMeasurementRequest

Creates a new AddTrialMeasurementRequest.

Source

pub fn mk_complete_trial_request( &self, trial_name: TrialName, final_measurement: FinalMeasurementOrReason, ) -> CompleteTrialRequest

Creates a new CompleteTrialRequest.

Source

pub fn mk_check_trial_early_stopping_state_request( &self, trial_name: TrialName, ) -> CheckTrialEarlyStoppingStateRequest

Creates a new CheckTrialEarlyStoppingStateRequest.

Source

pub fn mk_stop_trial_request(&self, trial_name: TrialName) -> StopTrialRequest

Creates a new StopTrialRequest.

Source

pub fn mk_list_optimal_trials_request( &self, study_name: StudyName, ) -> ListOptimalTrialsRequest

Creates a new ListOptimalTrialsRequest.

Source

pub fn trial_name(&self, study: String, trial: String) -> TrialName

Creates a TrialName (of the form “owners/{owner}/studies/{study}/trials/{trial}”). # Arguments

  • study - The study number - {study} in the pattern.
  • trial - The trial number - {trial} in the pattern.
Source

pub fn trial_name_from_study( &self, study_name: &StudyName, trial: impl Into<String>, ) -> TrialName

Creates a TrialName from a StudyName and trial number.

§Arguments
  • study_name - The StudyName.
  • trial - The trial number.
Source

pub fn study_name(&self, study: impl Into<String>) -> StudyName

Creates a StudyName (of the form “owners/{owner}/studies/{study}”).

§Arguments
  • study - The study number - {study} in the pattern.
Source

pub async fn wait_for_operation( &mut self, retries: usize, operation: Operation, ) -> Result<Option<Result>, Error>

Waits for an operation to be completed. Makes retries attempts and return the error if it still fails.

§Arguments
  • retries - The number of retries.
  • operation - The operation to wait for.
Source

pub async fn get_operation( &mut self, operation_name: String, ) -> Result<Option<Result>, Error>

Gets the operation::Result of an Operation specified by its name.

Source

pub async fn suggest_trials( &mut self, request: SuggestTrialsRequest, ) -> Result<SuggestTrialsResponse, Error>

Suggests trials to a study.

Trait Implementations§

Source§

impl<T: Clone> Clone for VizierClient<T>

Source§

fn clone(&self) -> VizierClient<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

Auto Trait Implementations§

§

impl<T> !Freeze for VizierClient<T>

§

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

§

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

§

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

§

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

§

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

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

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

impl<T> Instrument for T

Source§

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

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.
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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