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 as key-value pairs. How to use the context is custom to the specific implementation. On a request, it carries caller-provided context to the implementation. On a response, it carries implementation-provided context back to the caller. REST NAMESPACE ONLY Context entries are mapped to and from HTTP headers using the `header.` prefix: - On a request, any entry whose key starts with `header.` is sent as an HTTP request header with the prefix stripped. For example, the entry `{\"header.Authorization\": \"Bearer abc\"}` is sent as the request header `Authorization: Bearer abc`. - On a response, every HTTP response header is returned as an entry whose key is the header name prefixed with `header.`. For example, the response header `x-request-id: abc123` is returned as the entry `{\"header.x-request-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 /// Business logic properties stored and managed by the namespace implementation outside Lance context, if supported by the implementation.
31 #[serde(rename = "properties", skip_serializing_if = "Option::is_none")]
32 pub properties: Option<std::collections::HashMap<String, String>>,
33}
34
35impl DeclareTableRequest {
36 /// Request for declaring a table.
37 pub fn new() -> DeclareTableRequest {
38 DeclareTableRequest {
39 identity: None,
40 context: None,
41 id: None,
42 location: None,
43 vend_credentials: None,
44 properties: None,
45 }
46 }
47}
48