aws_sdk_glue/operation/describe_entity/
_describe_entity_input.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2#[allow(missing_docs)] // documentation missing in model
3#[non_exhaustive]
4#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
5pub struct DescribeEntityInput {
6    /// <p>The name of the connection that contains the connection type credentials.</p>
7    pub connection_name: ::std::option::Option<::std::string::String>,
8    /// <p>The catalog ID of the catalog that contains the connection. This can be null, By default, the Amazon Web Services Account ID is the catalog ID.</p>
9    pub catalog_id: ::std::option::Option<::std::string::String>,
10    /// <p>The name of the entity that you want to describe from the connection type.</p>
11    pub entity_name: ::std::option::Option<::std::string::String>,
12    /// <p>A continuation token, included if this is a continuation call.</p>
13    pub next_token: ::std::option::Option<::std::string::String>,
14    /// <p>The version of the API used for the data store.</p>
15    pub data_store_api_version: ::std::option::Option<::std::string::String>,
16}
17impl DescribeEntityInput {
18    /// <p>The name of the connection that contains the connection type credentials.</p>
19    pub fn connection_name(&self) -> ::std::option::Option<&str> {
20        self.connection_name.as_deref()
21    }
22    /// <p>The catalog ID of the catalog that contains the connection. This can be null, By default, the Amazon Web Services Account ID is the catalog ID.</p>
23    pub fn catalog_id(&self) -> ::std::option::Option<&str> {
24        self.catalog_id.as_deref()
25    }
26    /// <p>The name of the entity that you want to describe from the connection type.</p>
27    pub fn entity_name(&self) -> ::std::option::Option<&str> {
28        self.entity_name.as_deref()
29    }
30    /// <p>A continuation token, included if this is a continuation call.</p>
31    pub fn next_token(&self) -> ::std::option::Option<&str> {
32        self.next_token.as_deref()
33    }
34    /// <p>The version of the API used for the data store.</p>
35    pub fn data_store_api_version(&self) -> ::std::option::Option<&str> {
36        self.data_store_api_version.as_deref()
37    }
38}
39impl DescribeEntityInput {
40    /// Creates a new builder-style object to manufacture [`DescribeEntityInput`](crate::operation::describe_entity::DescribeEntityInput).
41    pub fn builder() -> crate::operation::describe_entity::builders::DescribeEntityInputBuilder {
42        crate::operation::describe_entity::builders::DescribeEntityInputBuilder::default()
43    }
44}
45
46/// A builder for [`DescribeEntityInput`](crate::operation::describe_entity::DescribeEntityInput).
47#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
48#[non_exhaustive]
49pub struct DescribeEntityInputBuilder {
50    pub(crate) connection_name: ::std::option::Option<::std::string::String>,
51    pub(crate) catalog_id: ::std::option::Option<::std::string::String>,
52    pub(crate) entity_name: ::std::option::Option<::std::string::String>,
53    pub(crate) next_token: ::std::option::Option<::std::string::String>,
54    pub(crate) data_store_api_version: ::std::option::Option<::std::string::String>,
55}
56impl DescribeEntityInputBuilder {
57    /// <p>The name of the connection that contains the connection type credentials.</p>
58    /// This field is required.
59    pub fn connection_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
60        self.connection_name = ::std::option::Option::Some(input.into());
61        self
62    }
63    /// <p>The name of the connection that contains the connection type credentials.</p>
64    pub fn set_connection_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
65        self.connection_name = input;
66        self
67    }
68    /// <p>The name of the connection that contains the connection type credentials.</p>
69    pub fn get_connection_name(&self) -> &::std::option::Option<::std::string::String> {
70        &self.connection_name
71    }
72    /// <p>The catalog ID of the catalog that contains the connection. This can be null, By default, the Amazon Web Services Account ID is the catalog ID.</p>
73    pub fn catalog_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
74        self.catalog_id = ::std::option::Option::Some(input.into());
75        self
76    }
77    /// <p>The catalog ID of the catalog that contains the connection. This can be null, By default, the Amazon Web Services Account ID is the catalog ID.</p>
78    pub fn set_catalog_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
79        self.catalog_id = input;
80        self
81    }
82    /// <p>The catalog ID of the catalog that contains the connection. This can be null, By default, the Amazon Web Services Account ID is the catalog ID.</p>
83    pub fn get_catalog_id(&self) -> &::std::option::Option<::std::string::String> {
84        &self.catalog_id
85    }
86    /// <p>The name of the entity that you want to describe from the connection type.</p>
87    /// This field is required.
88    pub fn entity_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
89        self.entity_name = ::std::option::Option::Some(input.into());
90        self
91    }
92    /// <p>The name of the entity that you want to describe from the connection type.</p>
93    pub fn set_entity_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
94        self.entity_name = input;
95        self
96    }
97    /// <p>The name of the entity that you want to describe from the connection type.</p>
98    pub fn get_entity_name(&self) -> &::std::option::Option<::std::string::String> {
99        &self.entity_name
100    }
101    /// <p>A continuation token, included if this is a continuation call.</p>
102    pub fn next_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
103        self.next_token = ::std::option::Option::Some(input.into());
104        self
105    }
106    /// <p>A continuation token, included if this is a continuation call.</p>
107    pub fn set_next_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
108        self.next_token = input;
109        self
110    }
111    /// <p>A continuation token, included if this is a continuation call.</p>
112    pub fn get_next_token(&self) -> &::std::option::Option<::std::string::String> {
113        &self.next_token
114    }
115    /// <p>The version of the API used for the data store.</p>
116    pub fn data_store_api_version(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
117        self.data_store_api_version = ::std::option::Option::Some(input.into());
118        self
119    }
120    /// <p>The version of the API used for the data store.</p>
121    pub fn set_data_store_api_version(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
122        self.data_store_api_version = input;
123        self
124    }
125    /// <p>The version of the API used for the data store.</p>
126    pub fn get_data_store_api_version(&self) -> &::std::option::Option<::std::string::String> {
127        &self.data_store_api_version
128    }
129    /// Consumes the builder and constructs a [`DescribeEntityInput`](crate::operation::describe_entity::DescribeEntityInput).
130    pub fn build(
131        self,
132    ) -> ::std::result::Result<crate::operation::describe_entity::DescribeEntityInput, ::aws_smithy_types::error::operation::BuildError> {
133        ::std::result::Result::Ok(crate::operation::describe_entity::DescribeEntityInput {
134            connection_name: self.connection_name,
135            catalog_id: self.catalog_id,
136            entity_name: self.entity_name,
137            next_token: self.next_token,
138            data_store_api_version: self.data_store_api_version,
139        })
140    }
141}