qcs_api_client_openapi/models/
create_engagement_request.rs

1// Copyright 2022 Rigetti Computing
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15/*
16 * Rigetti QCS API
17 *
18 * # Introduction  This is the documentation for the Rigetti QCS HTTP API.  You can find out more about Rigetti at [https://rigetti.com](https://rigetti.com), and also interact with QCS via the web at [https://qcs.rigetti.com](https://qcs.rigetti.com).  This API is documented in **OpenAPI format** and so is compatible with the dozens of language-specific client generators available [here](https://github.com/OpenAPITools/openapi-generator) and elsewhere on the web.  # Principles  This API follows REST design principles where appropriate, and otherwise an HTTP RPC paradigm. We adhere to the Google [API Improvement Proposals](https://google.aip.dev/general) where reasonable to provide a consistent, intuitive developer experience. HTTP response codes match their specifications, and error messages fit a common format.  # Authentication  All access to the QCS API requires OAuth2 authentication provided by Okta. You can request access [here](https://www.rigetti.com/get-quantum). Once you have a user account, you can download your access token from QCS [here](https://qcs.rigetti.com/auth/token).   That access token is valid for 24 hours after issuance. The value of `access_token` within the JSON file is the token used for authentication (don't use the entire JSON file).  Authenticate requests using the `Authorization` header and a `Bearer` prefix:  ``` curl --header \"Authorization: Bearer eyJraW...Iow\" ```  # Quantum Processor Access  Access to the quantum processors themselves is not yet provided directly by this HTTP API, but is instead performed over ZeroMQ/[rpcq](https://github.com/rigetti/rpcq). Until that changes, we suggest using [pyquil](https://github.com/rigetti/pyquil) to build and execute quantum programs via the Legacy API.  # Legacy API  Our legacy HTTP API remains accessible at https://forest-server.qcs.rigetti.com, and it shares a source of truth with this API's services. You can use either service with the same user account and means of authentication. We strongly recommend using the API documented here, as the legacy API is on the path to deprecation.
19 *
20 * The version of the OpenAPI document: 2020-07-31
21 * Contact: support@rigetti.com
22 * Generated by: https://openapi-generator.tech
23 */
24
25use serde::{Deserialize, Serialize};
26
27#[derive(Clone, Debug, Default, PartialEq, Serialize, Deserialize)]
28pub struct CreateEngagementRequest {
29    /// Either the client's user ID or the name of a group on behalf of which the client wishes to engage. This value will override any values set in the headers.
30    #[serde(rename = "accountId", skip_serializing_if = "Option::is_none")]
31    pub account_id: Option<String>,
32    /// Indicates whether the engagement request should be made for the user or on behalf of a group. This value will override any values set in the headers.
33    #[serde(rename = "accountType", skip_serializing_if = "Option::is_none")]
34    pub account_type: Option<Box<crate::models::AccountType>>,
35    /// Unique, opaque identifier for the endpoint
36    #[serde(rename = "endpointId", skip_serializing_if = "Option::is_none")]
37    pub endpoint_id: Option<String>,
38    /// Public identifier for a quantum processor [example: Aspen-1]
39    #[serde(rename = "quantumProcessorId", skip_serializing_if = "Option::is_none")]
40    pub quantum_processor_id: Option<String>,
41    /// Tags recorded on QPU requests, which reporting services may later use for querying usage records.
42    #[serde(rename = "tags", skip_serializing_if = "Option::is_none")]
43    pub tags: Option<Vec<String>>,
44}
45
46impl CreateEngagementRequest {
47    pub fn new() -> CreateEngagementRequest {
48        CreateEngagementRequest {
49            account_id: None,
50            account_type: None,
51            endpoint_id: None,
52            quantum_processor_id: None,
53            tags: None,
54        }
55    }
56}
qcs_api_client_openapi/models/create_engagement_request.rs

qcs_api_client_openapi/models/
create_engagement_request.rs
