Struct Client

pub struct Client { /* private fields */ }

A client that implements the API by making HTTP calls out to a server.

Implementations

impl Client

pub fn try_new_http(base_path: &str) -> Result<Client, ClientInitError>

Create an HTTP client.

Arguments

• base_path - base path of the client API, i.e. “www.my-api-implementation.com”

pub fn try_new_with_connector<C, S>( base_path: &str, protocol: Option<&'static str>, connector: C, ) -> Result<Client, ClientInitError>

where C: NetworkConnector<Stream = S> + Send + Sync + 'static, S: NetworkStream,

Create a client with a custom implementation of hyper::net::NetworkConnector.

Intended for use with custom implementations of connect for e.g. protocol logging or similar functionality which requires wrapping the transport layer. When wrapping a TCP connection, this function should be used in conjunction with swagger::{http_connector, https_connector, https_mutual_connector}.

For ordinary tcp connections, prefer the use of try_new_http, try_new_https and try_new_https_mutual, to avoid introducing a dependency on the underlying transport layer.

Arguments

• base_path - base path of the client API, i.e. “www.my-api-implementation.com”
• protocol - Which protocol to use when constructing the request url, e.g. Some("http")
• connector - An instance of C: hyper::net::NetworkConnection

pub fn try_new_with_hyper_client( hyper_client: Arc<Client>, base_path: &str, ) -> Result<Client, ClientInitError>

Constructor for creating a Client by passing in a pre-made hyper client.

One should avoid relying on this function if possible, since it adds a dependency on the underlying transport implementation, which it would be better to abstract away. Therefore, using this function may lead to a loss of code generality, which may make it harder to move the application to a serverless environment, for example.

The reason for this function’s existence is to support legacy test code, which did mocking at the hyper layer. This is not a recommended way to write new tests. If other reasons are found for using this function, they should be mentioned here.

This function is deprecated in the upstream openapi-generator which uses newer hyper. However, the suggested replacement does not exist in hyper 0.9.

pub fn headers(&mut self) -> &mut Headers

Trait Implementations

impl AccountsApi for Client

type Error = ApiError

fn create_account( &self, param_body: AccountRequest, ) -> Result<Account, ApiError>

Create a new account.

fn delete_account(&self, param_account_id: Uuid) -> Result<(), ApiError>

Delete an account.

fn get_account(&self, param_account_id: Uuid) -> Result<Account, ApiError>

Get a specific account.

fn get_accounts(&self) -> Result<AccountListResponse, ApiError>

Get all accounts.

fn select_account(&self, param_account_id: Uuid) -> Result<(), ApiError>

Select a user’s account to work on.

fn update_account( &self, param_account_id: Uuid, param_body: AccountUpdateRequest, ) -> Result<Account, ApiError>

Update an account.

impl AppApi for Client

type Error = ApiError

fn add_application(&self, param_body: AppRequest) -> Result<App, ApiError>

Add an application.

fn delete_app(&self, param_app_id: Uuid) -> Result<(), ApiError>

Delete a particular app

fn get_all_apps( &self, param_name: Option<String>, param_description: Option<String>, param_all_search: Option<String>, param_limit: Option<i32>, param_offset: Option<i32>, param_sort_by: Option<String>, ) -> Result<GetAllAppsResponse, ApiError>

Get all apps information.

fn get_app(&self, param_app_id: Uuid) -> Result<App, ApiError>

Get details of a particular app.

fn get_app_certificate( &self, param_node_id: Uuid, param_app_id: Uuid, ) -> Result<Certificate, ApiError>

Get an attested app’s certificate.

fn get_app_node_certificate_details( &self, param_node_id: Uuid, param_app_id: Uuid, ) -> Result<CertificateDetails, ApiError>

Get an app’s certificate for a compute node.

fn get_apps_unique_labels(&self) -> Result<LabelsCount, ApiError>

Get all the unique labels across all the applications within selected account

fn update_app( &self, param_app_id: Uuid, param_body: AppBodyUpdateRequest, ) -> Result<App, ApiError>

Update details of a particular app.

impl ApplicationConfigApi for Client

type Error = ApiError

fn create_application_config( &self, param_body: ApplicationConfig, ) -> Result<ApplicationConfigResponse, ApiError>

Add an app config.

fn delete_application_config( &self, param_config_id: String, ) -> Result<(), ApiError>

Delete a particular app config

fn get_all_application_configs( &self, param_name: Option<String>, param_description: Option<String>, param_image_id: Option<Uuid>, param_limit: Option<i32>, param_offset: Option<i32>, ) -> Result<GetAllApplicationConfigsResponse, ApiError>

Get all app configs

fn get_application_config( &self, param_config_id: String, ) -> Result<ApplicationConfigResponse, ApiError>

Get details of a particular app config.

fn get_runtime_application_config( &self, expected_hash: &[u8; 32], ) -> Result<RuntimeAppConfig, ApiError>

Get app config

fn get_specific_runtime_application_config( &self, param_config_id: String, ) -> Result<RuntimeAppConfig, ApiError>

Get details of a particular runtime app config.

fn update_application_config( &self, param_config_id: String, param_body: UpdateApplicationConfigRequest, ) -> Result<ApplicationConfigResponse, ApiError>

Update details of a particular app config.

impl ApprovalRequestsApi for Client

type Error = ApiError

fn approve_approval_request( &self, param_request_id: Uuid, param_body: Option<ApproveRequest>, ) -> Result<ApprovalRequest, ApiError>

Approve a request.

fn create_approval_request( &self, param_body: ApprovalRequestRequest, ) -> Result<ApprovalRequest, ApiError>

Create approval request.

fn delete_approval_request( &self, param_request_id: Uuid, ) -> Result<(), ApiError>

Delete an approval request.

fn deny_approval_request( &self, param_request_id: Uuid, param_body: Option<DenyRequest>, ) -> Result<ApprovalRequest, ApiError>

Deny a request.

fn get_all_approval_requests( &self, param_requester: Option<Uuid>, param_reviewer: Option<Uuid>, param_subject: Option<Uuid>, param_status: Option<String>, param_all_search: Option<String>, param_sort_by: Option<String>, param_limit: Option<i32>, param_offset: Option<i32>, ) -> Result<GetAllApprovalRequests, ApiError>

Get all approval requests

fn get_approval_request( &self, param_request_id: Uuid, ) -> Result<ApprovalRequest, ApiError>

Get an approval request.

fn get_approval_request_result( &self, param_request_id: Uuid, ) -> Result<ApprovableResult, ApiError>

Get the result for an approved or failed request.

impl AuthApi for Client

type Error = ApiError

fn authenticate_user( &self, param_body: Option<AuthRequest>, ) -> Result<AuthResponse, ApiError>

User authentication

impl BuildApi for Client

type Error = ApiError

fn convert_app_build( &self, param_body: ConvertAppBuildRequest, ) -> Result<Build, ApiError>

Convert a docker image and create a new image.

fn create_build( &self, param_body: CreateBuildRequest, ) -> Result<Build, ApiError>

Create a new image.

fn delete_build(&self, param_build_id: Uuid) -> Result<(), ApiError>

Delete a particular image.

fn get_all_builds( &self, param_all_search: Option<String>, param_docker_image_name: Option<String>, param_config_id: Option<String>, param_deployed_status: Option<String>, param_status: Option<String>, param_limit: Option<i32>, param_offset: Option<i32>, param_sort_by: Option<String>, ) -> Result<GetAllBuildsResponse, ApiError>

Get all images information.

fn get_build(&self, param_build_id: Uuid) -> Result<Build, ApiError>

Get details of a particular image.

fn get_build_deployments( &self, param_build_id: Uuid, param_status: Option<String>, param_all_search: Option<String>, param_sort_by: Option<String>, param_limit: Option<i32>, param_offset: Option<i32>, ) -> Result<GetAllBuildDeploymentsResponse, ApiError>

Get all deployments of an image.

fn update_build( &self, param_build_id: Uuid, param_body: BuildUpdateRequest, ) -> Result<Build, ApiError>

Update details of a particular image.

impl CertificateApi for Client

type Error = ApiError

fn get_certificate(&self, param_cert_id: Uuid) -> Result<Certificate, ApiError>

Retrieve a certificate.

fn new_certificate( &self, param_body: NewCertificateRequest, ) -> Result<TaskResult, ApiError>

Request a new certificate for an Enclave application

impl Clone for Client

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl DatasetApi for Client

type Error = ApiError

fn create_dataset( &self, param_body: CreateDatasetRequest, ) -> Result<Dataset, ApiError>

fn delete_dataset(&self, param_dataset_id: Uuid) -> Result<(), ApiError>

fn get_all_datasets( &self, param_name: Option<String>, param_description: Option<String>, param_limit: Option<i32>, param_offset: Option<i32>, ) -> Result<GetAllDatasetsResponse, ApiError>

Get all datasets

fn get_dataset(&self, param_dataset_id: Uuid) -> Result<Dataset, ApiError>

fn update_dataset( &self, param_dataset_id: Uuid, param_body: DatasetUpdateRequest, ) -> Result<Dataset, ApiError>

impl Debug for Client

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

Formats the value using the given formatter.

impl NodeApi for Client

type Error = ApiError

fn deactivate_node(&self, param_node_id: Uuid) -> Result<(), ApiError>

Deactivate a particular compute node.

fn get_all_nodes( &self, param_name: Option<String>, param_description: Option<String>, param_sgx_version: Option<String>, param_all_search: Option<String>, param_status: Option<String>, param_limit: Option<i32>, param_offset: Option<i32>, param_sort_by: Option<String>, ) -> Result<GetAllNodesResponse, ApiError>

Get all compute nodes information.

fn get_node(&self, param_node_id: Uuid) -> Result<Node, ApiError>

Get details of a particular compute node.

fn get_node_certificate( &self, param_node_id: Uuid, ) -> Result<Certificate, ApiError>

Get an attested compute node’s certificate.

fn get_node_certificate_details( &self, param_node_id: Uuid, ) -> Result<CertificateDetails, ApiError>

Get a compute node’s certificate.

fn get_nodes_unique_labels(&self) -> Result<LabelsCount, ApiError>

Get all the unique labels across all the nodes within selected account

fn provision_node( &self, param_body: NodeProvisionRequest, ) -> Result<TaskResult, ApiError>

Provision a new compute node.

fn update_node( &self, param_node_id: Uuid, param_body: NodeUpdateRequest, ) -> Result<Node, ApiError>

Update details of a particular compute node.

fn update_node_status( &self, param_body: NodeStatusRequest, ) -> Result<NodeStatusResponse, ApiError>

Called periodically by a compute node.

impl RegistryApi for Client

type Error = ApiError

fn create_registry( &self, param_registry_request: RegistryRequest, ) -> Result<Registry, ApiError>

Add a new registry to an account

fn delete_registry(&self, param_registry_id: Uuid) -> Result<(), ApiError>

Delete registry

fn get_all_registries(&self) -> Result<Vec<Registry>, ApiError>

Get details of all registry in the account

fn get_registry(&self, param_registry_id: Uuid) -> Result<Registry, ApiError>

Get details of a particular registry

fn get_registry_for_app( &self, param_app_id: Uuid, ) -> Result<AppRegistryResponse, ApiError>

Get details of the registry that will be used for the particular app images

fn get_registry_for_image( &self, param_image_name: String, ) -> Result<ImageRegistryResponse, ApiError>

Get details of the registry that will be used for the particular image

fn update_registry( &self, param_registry_id: Uuid, param_body: UpdateRegistryRequest, ) -> Result<Registry, ApiError>

Update a particular registry details

impl SystemApi for Client

type Error = ApiError

fn get_manager_version(&self) -> Result<VersionResponse, ApiError>

Get Manager Version.

impl TaskApi for Client

type Error = ApiError

fn get_all_tasks( &self, param_task_type: Option<String>, param_status: Option<String>, param_requester: Option<String>, param_approver: Option<String>, param_all_search: Option<String>, param_limit: Option<i32>, param_offset: Option<i32>, param_sort_by: Option<String>, param_base_filters: Option<String>, ) -> Result<GetAllTasksResponse, ApiError>

Get all the tasks.

fn get_task(&self, param_task_id: Uuid) -> Result<Task, ApiError>

Get details of a particular task.

fn get_task_status(&self, param_task_id: Uuid) -> Result<TaskResult, ApiError>

Get status and result of a particular task.

fn update_task( &self, param_task_id: Uuid, param_body: TaskUpdateRequest, ) -> Result<TaskResult, ApiError>

Update status of approver and task.

impl ToolsApi for Client

type Error = ApiError

fn convert_app( &self, param_body: ConversionRequest, ) -> Result<ConversionResponse, ApiError>

Convert an application to run in EnclaveOS.

impl UsersApi for Client

type Error = ApiError

fn accept_terms_and_conditions(&self) -> Result<(), ApiError>

Current user accepts latest terms and conditions.

fn change_password( &self, param_body: PasswordChangeRequest, ) -> Result<(), ApiError>

Change user password.

fn confirm_email( &self, param_body: ConfirmEmailRequest, ) -> Result<ConfirmEmailResponse, ApiError>

Confirms user’s email address.

fn create_user(&self, param_body: SignupRequest) -> Result<User, ApiError>

Create a new user.

fn delete_user_account(&self, param_user_id: Uuid) -> Result<(), ApiError>

Completely delete a user profile from system

fn delete_user_from_account(&self, param_user_id: Uuid) -> Result<(), ApiError>

Removed user’s association with an account.

fn forgot_password( &self, param_body: ForgotPasswordRequest, ) -> Result<(), ApiError>

Initiate password reset sequence for a user.

fn get_all_users( &self, param_all_search: Option<String>, param_limit: Option<i32>, param_offset: Option<i32>, param_sort_by: Option<String>, ) -> Result<GetAllUsersResponse, ApiError>

Get all user’s information.

fn get_logged_in_user(&self) -> Result<User, ApiError>

Get details of the current logged in user.

fn get_user(&self, param_user_id: Uuid) -> Result<User, ApiError>

Get details of a particular user.

fn invite_user(&self, param_body: InviteUserRequest) -> Result<User, ApiError>

Invite a user.

fn process_invitations( &self, param_body: ProcessInviteRequest, ) -> Result<(), ApiError>

Process a user’s pending account invitations.

fn resend_confirm_email(&self) -> Result<(), ApiError>

Resend email with link to confirm user’s email address.

fn resend_invitation(&self, param_user_id: Uuid) -> Result<(), ApiError>

Resend invite to the user to join a specific account.

fn reset_password( &self, param_user_id: Uuid, param_body: PasswordResetRequest, ) -> Result<(), ApiError>

Reset a user’s password.

fn update_user( &self, param_user_id: Uuid, param_body: UpdateUserRequest, ) -> Result<User, ApiError>

Update status, name, and the role of a user. User with MANAGER access role can only update another user.

fn validate_password_reset_token( &self, param_user_id: Uuid, param_body: ValidateTokenRequest, ) -> Result<ValidateTokenResponse, ApiError>

Validates password reset token for the user.

impl WorkflowApi for Client

type Error = ApiError

fn create_workflow_graph( &self, param_body: CreateWorkflowGraph, ) -> Result<WorkflowGraph, ApiError>

fn delete_workflow_graph(&self, param_graph_id: Uuid) -> Result<(), ApiError>

Delete a particular draft workflow

fn get_all_workflow_graphs( &self, param_name: Option<String>, param_description: Option<String>, param_all_search: Option<String>, param_parent_graph_id: Option<String>, param_sort_by: Option<String>, param_limit: Option<i32>, param_offset: Option<i32>, ) -> Result<GetAllWorkflowGraphsResponse, ApiError>

fn get_workflow_graph( &self, param_graph_id: Uuid, ) -> Result<WorkflowGraph, ApiError>

Get details of a particular draft workflow

fn update_workflow_graph( &self, param_graph_id: Uuid, param_body: UpdateWorkflowGraph, ) -> Result<WorkflowGraph, ApiError>

impl WorkflowFinalApi for Client

type Error = ApiError

fn create_final_workflow_graph( &self, param_body: CreateFinalWorkflowGraph, ) -> Result<FinalWorkflow, ApiError>

fn delete_final_workflow_graph( &self, param_graph_id: Uuid, param_version: String, ) -> Result<(), ApiError>

Delete a particular final workflow

fn get_all_final_workflow_graphs( &self, param_name: Option<String>, param_description: Option<String>, param_all_search: Option<String>, param_sort_by: Option<String>, param_limit: Option<i32>, param_offset: Option<i32>, ) -> Result<GetAllFinalWorkflowGraphsResponse, ApiError>

fn get_final_workflow_graph( &self, param_graph_id: Uuid, param_version: String, ) -> Result<VersionInFinalWorkflow, ApiError>

Get details of a particular final workflow version

fn get_full_final_workflow_graph( &self, param_graph_id: Uuid, ) -> Result<FinalWorkflow, ApiError>

Get details of a particular final workflow

fn update_final_workflow_graph( &self, param_graph_id: Uuid, param_body: CreateWorkflowVersionRequest, ) -> Result<VersionInFinalWorkflow, ApiError>

Create a new version for a particular final workflow

impl ZoneApi for Client

type Error = ApiError

fn get_zone(&self, param_zone_id: Uuid) -> Result<Zone, ApiError>

Get zone details.

fn get_zone_join_token( &self, param_zone_id: Uuid, ) -> Result<ZoneJoinToken, ApiError>

Get the authentication token.

fn get_zones(&self) -> Result<Vec<Zone>, ApiError>

Get all zones.