superposition_sdk 0.106.1

Rust SDK to work with Superposition
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListExperiment`](crate::operation::list_experiment::builders::ListExperimentFluentBuilder) operation.
                            ///
                            /// - The fluent builder is configurable:
    ///   - [`count(i32)`](crate::operation::list_experiment::builders::ListExperimentFluentBuilder::count) / [`set_count(Option<i32>)`](crate::operation::list_experiment::builders::ListExperimentFluentBuilder::set_count):<br>required: **false**<br>Number of items to be returned in each page.<br>
    ///   - [`page(i32)`](crate::operation::list_experiment::builders::ListExperimentFluentBuilder::page) / [`set_page(Option<i32>)`](crate::operation::list_experiment::builders::ListExperimentFluentBuilder::set_page):<br>required: **false**<br>Page number to retrieve, starting from 1.<br>
    ///   - [`all(bool)`](crate::operation::list_experiment::builders::ListExperimentFluentBuilder::all) / [`set_all(Option<bool>)`](crate::operation::list_experiment::builders::ListExperimentFluentBuilder::set_all):<br>required: **false**<br>If true, returns all requested items, ignoring pagination parameters page and count.<br>
    ///   - [`workspace_id(impl Into<String>)`](crate::operation::list_experiment::builders::ListExperimentFluentBuilder::workspace_id) / [`set_workspace_id(Option<String>)`](crate::operation::list_experiment::builders::ListExperimentFluentBuilder::set_workspace_id):<br>required: **true**<br>(undocumented)<br>
    ///   - [`org_id(impl Into<String>)`](crate::operation::list_experiment::builders::ListExperimentFluentBuilder::org_id) / [`set_org_id(Option<String>)`](crate::operation::list_experiment::builders::ListExperimentFluentBuilder::set_org_id):<br>required: **true**<br>(undocumented)<br>
    ///   - [`if_modified_since(DateTime)`](crate::operation::list_experiment::builders::ListExperimentFluentBuilder::if_modified_since) / [`set_if_modified_since(Option<DateTime>)`](crate::operation::list_experiment::builders::ListExperimentFluentBuilder::set_if_modified_since):<br>required: **false**<br>While using this, 304 response is treated as error, which needs to be handled separately by checking the response code of the http response. This is required to make sure that clients can cache the response and avoid unnecessary calls when there are no updates.<br>
    ///   - [`status(ExperimentStatusType)`](crate::operation::list_experiment::builders::ListExperimentFluentBuilder::status) / [`set_status(Option<Vec::<ExperimentStatusType>>)`](crate::operation::list_experiment::builders::ListExperimentFluentBuilder::set_status):<br>required: **false**<br>(undocumented)<br>
    ///   - [`from_date(DateTime)`](crate::operation::list_experiment::builders::ListExperimentFluentBuilder::from_date) / [`set_from_date(Option<DateTime>)`](crate::operation::list_experiment::builders::ListExperimentFluentBuilder::set_from_date):<br>required: **false**<br>(undocumented)<br>
    ///   - [`to_date(DateTime)`](crate::operation::list_experiment::builders::ListExperimentFluentBuilder::to_date) / [`set_to_date(Option<DateTime>)`](crate::operation::list_experiment::builders::ListExperimentFluentBuilder::set_to_date):<br>required: **false**<br>(undocumented)<br>
    ///   - [`experiment_name(impl Into<String>)`](crate::operation::list_experiment::builders::ListExperimentFluentBuilder::experiment_name) / [`set_experiment_name(Option<String>)`](crate::operation::list_experiment::builders::ListExperimentFluentBuilder::set_experiment_name):<br>required: **false**<br>(undocumented)<br>
    ///   - [`experiment_ids(impl Into<String>)`](crate::operation::list_experiment::builders::ListExperimentFluentBuilder::experiment_ids) / [`set_experiment_ids(Option<Vec::<String>>)`](crate::operation::list_experiment::builders::ListExperimentFluentBuilder::set_experiment_ids):<br>required: **false**<br>(undocumented)<br>
    ///   - [`experiment_group_ids(impl Into<String>)`](crate::operation::list_experiment::builders::ListExperimentFluentBuilder::experiment_group_ids) / [`set_experiment_group_ids(Option<Vec::<String>>)`](crate::operation::list_experiment::builders::ListExperimentFluentBuilder::set_experiment_group_ids):<br>required: **false**<br>(undocumented)<br>
    ///   - [`created_by(impl Into<String>)`](crate::operation::list_experiment::builders::ListExperimentFluentBuilder::created_by) / [`set_created_by(Option<Vec::<String>>)`](crate::operation::list_experiment::builders::ListExperimentFluentBuilder::set_created_by):<br>required: **false**<br>(undocumented)<br>
    ///   - [`sort_on(ExperimentSortOn)`](crate::operation::list_experiment::builders::ListExperimentFluentBuilder::sort_on) / [`set_sort_on(Option<ExperimentSortOn>)`](crate::operation::list_experiment::builders::ListExperimentFluentBuilder::set_sort_on):<br>required: **false**<br>(undocumented)<br>
    ///   - [`sort_by(SortBy)`](crate::operation::list_experiment::builders::ListExperimentFluentBuilder::sort_by) / [`set_sort_by(Option<SortBy>)`](crate::operation::list_experiment::builders::ListExperimentFluentBuilder::set_sort_by):<br>required: **false**<br>Sort order enumeration for list operations.<br>
    ///   - [`global_experiments_only(bool)`](crate::operation::list_experiment::builders::ListExperimentFluentBuilder::global_experiments_only) / [`set_global_experiments_only(Option<bool>)`](crate::operation::list_experiment::builders::ListExperimentFluentBuilder::set_global_experiments_only):<br>required: **false**<br>(undocumented)<br>
    ///   - [`dimension_match_strategy(DimensionMatchStrategy)`](crate::operation::list_experiment::builders::ListExperimentFluentBuilder::dimension_match_strategy) / [`set_dimension_match_strategy(Option<DimensionMatchStrategy>)`](crate::operation::list_experiment::builders::ListExperimentFluentBuilder::set_dimension_match_strategy):<br>required: **false**<br>Strategy to follow while filter items based on the context<br>
    ///   - [`prefix(impl Into<String>)`](crate::operation::list_experiment::builders::ListExperimentFluentBuilder::prefix) / [`set_prefix(Option<Vec::<String>>)`](crate::operation::list_experiment::builders::ListExperimentFluentBuilder::set_prefix):<br>required: **false**<br>(undocumented)<br>
    ///   - [`context(impl Into<String>, Document)`](crate::operation::list_experiment::builders::ListExperimentFluentBuilder::context) / [`set_context(Option<HashMap::<String, Document>>)`](crate::operation::list_experiment::builders::ListExperimentFluentBuilder::set_context):<br>required: **false**<br>Map representing the context. Keys correspond to the names of the dimensions.<br>
                            /// - On success, responds with [`ListExperimentOutput`](crate::operation::list_experiment::ListExperimentOutput) with field(s):
    ///   - [`total_pages(i32)`](crate::operation::list_experiment::ListExperimentOutput::total_pages): (undocumented)
    ///   - [`total_items(i32)`](crate::operation::list_experiment::ListExperimentOutput::total_items): (undocumented)
    ///   - [`data(Vec::<ExperimentResponse>)`](crate::operation::list_experiment::ListExperimentOutput::data): (undocumented)
    ///   - [`last_modified(DateTime)`](crate::operation::list_experiment::ListExperimentOutput::last_modified): (undocumented)
                            /// - On failure, responds with [`SdkError<ListExperimentError>`](crate::operation::list_experiment::ListExperimentError)
    pub fn list_experiment(&self) -> crate::operation::list_experiment::builders::ListExperimentFluentBuilder {
                                crate::operation::list_experiment::builders::ListExperimentFluentBuilder::new(self.handle.clone())
                            }
}