lance_namespace_reqwest_client/models/describe_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#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
15pub struct DescribeTableRequest {
16 #[serde(rename = "identity", skip_serializing_if = "Option::is_none")]
17 pub identity: Option<Box<models::Identity>>,
18 /// 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`.
19 #[serde(rename = "context", skip_serializing_if = "Option::is_none")]
20 pub context: Option<std::collections::HashMap<String, String>>,
21 #[serde(rename = "id", skip_serializing_if = "Option::is_none")]
22 pub id: Option<Vec<String>>,
23 /// Version of the table to describe. If not specified, server should resolve it to the latest version.
24 #[serde(rename = "version", skip_serializing_if = "Option::is_none")]
25 pub version: Option<i64>,
26 /// Whether to include the table URI in the response. Default is false.
27 #[serde(rename = "with_table_uri", skip_serializing_if = "Option::is_none")]
28 pub with_table_uri: Option<bool>,
29 /// Whether to load detailed metadata that requires opening the dataset. When true, the response must include all detailed metadata such as `version`, `schema`, and `stats` which require reading the dataset. When not set, the implementation can decide whether to return detailed metadata and which parts of detailed metadata to return.
30 #[serde(rename = "load_detailed_metadata", skip_serializing_if = "Option::is_none")]
31 pub load_detailed_metadata: Option<bool>,
32 /// 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.
33 #[serde(rename = "vend_credentials", skip_serializing_if = "Option::is_none")]
34 pub vend_credentials: Option<bool>,
35}
36
37impl DescribeTableRequest {
38 pub fn new() -> DescribeTableRequest {
39 DescribeTableRequest {
40 identity: None,
41 context: None,
42 id: None,
43 version: None,
44 with_table_uri: None,
45 load_detailed_metadata: None,
46 vend_credentials: None,
47 }
48 }
49}
50