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 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\"}`. 
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    /// Tag name to describe the table at. If specified, the server should resolve the tag to a version number and describe that version. Cannot be used together with `version` or `branch`. 
27    #[serde(rename = "tag", skip_serializing_if = "Option::is_none")]
28    pub tag: Option<String>,
29    /// Branch to target. When not specified, the main branch is used. 
30    #[serde(rename = "branch", skip_serializing_if = "Option::is_none")]
31    pub branch: Option<String>,
32    /// Whether to include the table URI in the response. Default is false. 
33    #[serde(rename = "with_table_uri", skip_serializing_if = "Option::is_none")]
34    pub with_table_uri: Option<bool>,
35    /// 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. 
36    #[serde(rename = "load_detailed_metadata", skip_serializing_if = "Option::is_none")]
37    pub load_detailed_metadata: Option<bool>,
38    /// Whether to check if the table exists only as a namespace declaration without storage data. Default is false. When true, the response should populate `is_only_declared`. When false, the implementation should return null for `is_only_declared` unless another option such as `load_detailed_metadata` requires checking declared-only table state. 
39    #[serde(rename = "check_declared", skip_serializing_if = "Option::is_none")]
40    pub check_declared: Option<bool>,
41    /// 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. 
42    #[serde(rename = "vend_credentials", skip_serializing_if = "Option::is_none")]
43    pub vend_credentials: Option<bool>,
44}
45
46impl DescribeTableRequest {
47    pub fn new() -> DescribeTableRequest {
48        DescribeTableRequest {
49            identity: None,
50            context: None,
51            id: None,
52            version: None,
53            tag: None,
54            branch: None,
55            with_table_uri: None,
56            load_detailed_metadata: None,
57            check_declared: None,
58            vend_credentials: None,
59        }
60    }
61}
62
lance_namespace_reqwest_client/models/describe_table_request.rs

lance_namespace_reqwest_client/models/
describe_table_request.rs
