lance_namespace_reqwest_client/models/declare_table_request.rs
1/*
2 * Lance Namespace Specification
3 *
4 * This OpenAPI specification is a part of the Lance namespace specification. It contains 2 parts: The `components/schemas`, `components/responses`, `components/examples`, `tags` sections define the request and response shape for each operation in a Lance Namespace across all implementations. See https://lance.org/format/namespace/operations for more details. The `servers`, `security`, `paths`, `components/parameters` sections are for the Lance REST Namespace implementation, which defines a complete REST server that can work with Lance datasets. See https://lance.org/format/namespace/rest for more details.
5 *
6 * The version of the OpenAPI document: 1.0.0
7 *
8 * Generated by: https://openapi-generator.tech
9 */
10
11use crate::models;
12use serde::{Deserialize, Serialize};
13
14/// DeclareTableRequest : Request for declaring a table.
15#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
16pub struct DeclareTableRequest {
17 #[serde(rename = "identity", skip_serializing_if = "Option::is_none")]
18 pub identity: Option<Box<models::Identity>>,
19 /// Arbitrary context for a request as key-value pairs. How to use the context is custom to the specific implementation. REST NAMESPACE ONLY Context entries are passed via HTTP headers using the naming convention `x-lance-ctx-<key>: <value>`. For example, a context entry `{\"trace_id\": \"abc123\"}` would be sent as the header `x-lance-ctx-trace_id: abc123`.
20 #[serde(rename = "context", skip_serializing_if = "Option::is_none")]
21 pub context: Option<std::collections::HashMap<String, String>>,
22 #[serde(rename = "id", skip_serializing_if = "Option::is_none")]
23 pub id: Option<Vec<String>>,
24 /// Optional storage location for the table. If not provided, the namespace implementation should determine the table location.
25 #[serde(rename = "location", skip_serializing_if = "Option::is_none")]
26 pub location: Option<String>,
27 /// Whether to include vended credentials in the response `storage_options`. When true, the implementation should provide vended credentials for accessing storage. When not set, the implementation can decide whether to return vended credentials.
28 #[serde(rename = "vend_credentials", skip_serializing_if = "Option::is_none")]
29 pub vend_credentials: Option<bool>,
30}
31
32impl DeclareTableRequest {
33 /// Request for declaring a table.
34 pub fn new() -> DeclareTableRequest {
35 DeclareTableRequest {
36 identity: None,
37 context: None,
38 id: None,
39 location: None,
40 vend_credentials: None,
41 }
42 }
43}
44