/*
* Lance Namespace Specification
*
* 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.
*
* The version of the OpenAPI document: 1.0.0
*
* Generated by: https://openapi-generator.tech
*/
use crate::models;
use serde::{Deserialize, Serialize};
#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
pub struct DescribeTableRequest {
#[serde(rename = "identity", skip_serializing_if = "Option::is_none")]
pub identity: Option<Box<models::Identity>>,
/// 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`.
#[serde(rename = "context", skip_serializing_if = "Option::is_none")]
pub context: Option<std::collections::HashMap<String, String>>,
#[serde(rename = "id", skip_serializing_if = "Option::is_none")]
pub id: Option<Vec<String>>,
/// Version of the table to describe. If not specified, server should resolve it to the latest version.
#[serde(rename = "version", skip_serializing_if = "Option::is_none")]
pub version: Option<i64>,
/// Whether to include the table URI in the response. Default is false.
#[serde(rename = "with_table_uri", skip_serializing_if = "Option::is_none")]
pub with_table_uri: Option<bool>,
/// 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.
#[serde(rename = "load_detailed_metadata", skip_serializing_if = "Option::is_none")]
pub load_detailed_metadata: Option<bool>,
/// 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.
#[serde(rename = "check_declared", skip_serializing_if = "Option::is_none")]
pub check_declared: Option<bool>,
/// 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.
#[serde(rename = "vend_credentials", skip_serializing_if = "Option::is_none")]
pub vend_credentials: Option<bool>,
}
impl DescribeTableRequest {
pub fn new() -> DescribeTableRequest {
DescribeTableRequest {
identity: None,
context: None,
id: None,
version: None,
with_table_uri: None,
load_detailed_metadata: None,
check_declared: None,
vend_credentials: None,
}
}
}