1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
#[allow(missing_docs)] // documentation missing in model
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct DescribeDashboardOutput {
/// <p>The ID of the dashboard.</p>
pub dashboard_id: ::std::string::String,
/// <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the dashboard, which has the following format.</p>
/// <p> <code>arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}</code> </p>
pub dashboard_arn: ::std::string::String,
/// <p>The name of the dashboard.</p>
pub dashboard_name: ::std::string::String,
/// <p>The ID of the project that the dashboard is in.</p>
pub project_id: ::std::string::String,
/// <p>The dashboard's description.</p>
pub dashboard_description: ::std::option::Option<::std::string::String>,
/// <p>The dashboard's definition JSON literal. For detailed information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html">Creating dashboards (CLI)</a> in the <i>IoT SiteWise User Guide</i>.</p>
pub dashboard_definition: ::std::string::String,
/// <p>The date the dashboard was created, in Unix epoch time.</p>
pub dashboard_creation_date: ::aws_smithy_types::DateTime,
/// <p>The date the dashboard was last updated, in Unix epoch time.</p>
pub dashboard_last_update_date: ::aws_smithy_types::DateTime,
_request_id: Option<String>,
}
impl DescribeDashboardOutput {
/// <p>The ID of the dashboard.</p>
pub fn dashboard_id(&self) -> &str {
use std::ops::Deref;
self.dashboard_id.deref()
}
/// <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the dashboard, which has the following format.</p>
/// <p> <code>arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}</code> </p>
pub fn dashboard_arn(&self) -> &str {
use std::ops::Deref;
self.dashboard_arn.deref()
}
/// <p>The name of the dashboard.</p>
pub fn dashboard_name(&self) -> &str {
use std::ops::Deref;
self.dashboard_name.deref()
}
/// <p>The ID of the project that the dashboard is in.</p>
pub fn project_id(&self) -> &str {
use std::ops::Deref;
self.project_id.deref()
}
/// <p>The dashboard's description.</p>
pub fn dashboard_description(&self) -> ::std::option::Option<&str> {
self.dashboard_description.as_deref()
}
/// <p>The dashboard's definition JSON literal. For detailed information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html">Creating dashboards (CLI)</a> in the <i>IoT SiteWise User Guide</i>.</p>
pub fn dashboard_definition(&self) -> &str {
use std::ops::Deref;
self.dashboard_definition.deref()
}
/// <p>The date the dashboard was created, in Unix epoch time.</p>
pub fn dashboard_creation_date(&self) -> &::aws_smithy_types::DateTime {
&self.dashboard_creation_date
}
/// <p>The date the dashboard was last updated, in Unix epoch time.</p>
pub fn dashboard_last_update_date(&self) -> &::aws_smithy_types::DateTime {
&self.dashboard_last_update_date
}
}
impl ::aws_types::request_id::RequestId for DescribeDashboardOutput {
fn request_id(&self) -> Option<&str> {
self._request_id.as_deref()
}
}
impl DescribeDashboardOutput {
/// Creates a new builder-style object to manufacture [`DescribeDashboardOutput`](crate::operation::describe_dashboard::DescribeDashboardOutput).
pub fn builder() -> crate::operation::describe_dashboard::builders::DescribeDashboardOutputBuilder {
crate::operation::describe_dashboard::builders::DescribeDashboardOutputBuilder::default()
}
}
/// A builder for [`DescribeDashboardOutput`](crate::operation::describe_dashboard::DescribeDashboardOutput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
pub struct DescribeDashboardOutputBuilder {
pub(crate) dashboard_id: ::std::option::Option<::std::string::String>,
pub(crate) dashboard_arn: ::std::option::Option<::std::string::String>,
pub(crate) dashboard_name: ::std::option::Option<::std::string::String>,
pub(crate) project_id: ::std::option::Option<::std::string::String>,
pub(crate) dashboard_description: ::std::option::Option<::std::string::String>,
pub(crate) dashboard_definition: ::std::option::Option<::std::string::String>,
pub(crate) dashboard_creation_date: ::std::option::Option<::aws_smithy_types::DateTime>,
pub(crate) dashboard_last_update_date: ::std::option::Option<::aws_smithy_types::DateTime>,
_request_id: Option<String>,
}
impl DescribeDashboardOutputBuilder {
/// <p>The ID of the dashboard.</p>
/// This field is required.
pub fn dashboard_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.dashboard_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The ID of the dashboard.</p>
pub fn set_dashboard_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.dashboard_id = input;
self
}
/// <p>The ID of the dashboard.</p>
pub fn get_dashboard_id(&self) -> &::std::option::Option<::std::string::String> {
&self.dashboard_id
}
/// <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the dashboard, which has the following format.</p>
/// <p> <code>arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}</code> </p>
/// This field is required.
pub fn dashboard_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.dashboard_arn = ::std::option::Option::Some(input.into());
self
}
/// <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the dashboard, which has the following format.</p>
/// <p> <code>arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}</code> </p>
pub fn set_dashboard_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.dashboard_arn = input;
self
}
/// <p>The <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">ARN</a> of the dashboard, which has the following format.</p>
/// <p> <code>arn:${Partition}:iotsitewise:${Region}:${Account}:dashboard/${DashboardId}</code> </p>
pub fn get_dashboard_arn(&self) -> &::std::option::Option<::std::string::String> {
&self.dashboard_arn
}
/// <p>The name of the dashboard.</p>
/// This field is required.
pub fn dashboard_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.dashboard_name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name of the dashboard.</p>
pub fn set_dashboard_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.dashboard_name = input;
self
}
/// <p>The name of the dashboard.</p>
pub fn get_dashboard_name(&self) -> &::std::option::Option<::std::string::String> {
&self.dashboard_name
}
/// <p>The ID of the project that the dashboard is in.</p>
/// This field is required.
pub fn project_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.project_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The ID of the project that the dashboard is in.</p>
pub fn set_project_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.project_id = input;
self
}
/// <p>The ID of the project that the dashboard is in.</p>
pub fn get_project_id(&self) -> &::std::option::Option<::std::string::String> {
&self.project_id
}
/// <p>The dashboard's description.</p>
pub fn dashboard_description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.dashboard_description = ::std::option::Option::Some(input.into());
self
}
/// <p>The dashboard's description.</p>
pub fn set_dashboard_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.dashboard_description = input;
self
}
/// <p>The dashboard's description.</p>
pub fn get_dashboard_description(&self) -> &::std::option::Option<::std::string::String> {
&self.dashboard_description
}
/// <p>The dashboard's definition JSON literal. For detailed information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html">Creating dashboards (CLI)</a> in the <i>IoT SiteWise User Guide</i>.</p>
/// This field is required.
pub fn dashboard_definition(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.dashboard_definition = ::std::option::Option::Some(input.into());
self
}
/// <p>The dashboard's definition JSON literal. For detailed information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html">Creating dashboards (CLI)</a> in the <i>IoT SiteWise User Guide</i>.</p>
pub fn set_dashboard_definition(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.dashboard_definition = input;
self
}
/// <p>The dashboard's definition JSON literal. For detailed information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/create-dashboards-using-aws-cli.html">Creating dashboards (CLI)</a> in the <i>IoT SiteWise User Guide</i>.</p>
pub fn get_dashboard_definition(&self) -> &::std::option::Option<::std::string::String> {
&self.dashboard_definition
}
/// <p>The date the dashboard was created, in Unix epoch time.</p>
/// This field is required.
pub fn dashboard_creation_date(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.dashboard_creation_date = ::std::option::Option::Some(input);
self
}
/// <p>The date the dashboard was created, in Unix epoch time.</p>
pub fn set_dashboard_creation_date(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.dashboard_creation_date = input;
self
}
/// <p>The date the dashboard was created, in Unix epoch time.</p>
pub fn get_dashboard_creation_date(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
&self.dashboard_creation_date
}
/// <p>The date the dashboard was last updated, in Unix epoch time.</p>
/// This field is required.
pub fn dashboard_last_update_date(mut self, input: ::aws_smithy_types::DateTime) -> Self {
self.dashboard_last_update_date = ::std::option::Option::Some(input);
self
}
/// <p>The date the dashboard was last updated, in Unix epoch time.</p>
pub fn set_dashboard_last_update_date(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
self.dashboard_last_update_date = input;
self
}
/// <p>The date the dashboard was last updated, in Unix epoch time.</p>
pub fn get_dashboard_last_update_date(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
&self.dashboard_last_update_date
}
pub(crate) fn _request_id(mut self, request_id: impl Into<String>) -> Self {
self._request_id = Some(request_id.into());
self
}
pub(crate) fn _set_request_id(&mut self, request_id: Option<String>) -> &mut Self {
self._request_id = request_id;
self
}
/// Consumes the builder and constructs a [`DescribeDashboardOutput`](crate::operation::describe_dashboard::DescribeDashboardOutput).
/// This method will fail if any of the following fields are not set:
/// - [`dashboard_id`](crate::operation::describe_dashboard::builders::DescribeDashboardOutputBuilder::dashboard_id)
/// - [`dashboard_arn`](crate::operation::describe_dashboard::builders::DescribeDashboardOutputBuilder::dashboard_arn)
/// - [`dashboard_name`](crate::operation::describe_dashboard::builders::DescribeDashboardOutputBuilder::dashboard_name)
/// - [`project_id`](crate::operation::describe_dashboard::builders::DescribeDashboardOutputBuilder::project_id)
/// - [`dashboard_definition`](crate::operation::describe_dashboard::builders::DescribeDashboardOutputBuilder::dashboard_definition)
/// - [`dashboard_creation_date`](crate::operation::describe_dashboard::builders::DescribeDashboardOutputBuilder::dashboard_creation_date)
/// - [`dashboard_last_update_date`](crate::operation::describe_dashboard::builders::DescribeDashboardOutputBuilder::dashboard_last_update_date)
pub fn build(
self,
) -> ::std::result::Result<crate::operation::describe_dashboard::DescribeDashboardOutput, ::aws_smithy_types::error::operation::BuildError> {
::std::result::Result::Ok(crate::operation::describe_dashboard::DescribeDashboardOutput {
dashboard_id: self.dashboard_id.ok_or_else(|| {
::aws_smithy_types::error::operation::BuildError::missing_field(
"dashboard_id",
"dashboard_id was not specified but it is required when building DescribeDashboardOutput",
)
})?,
dashboard_arn: self.dashboard_arn.ok_or_else(|| {
::aws_smithy_types::error::operation::BuildError::missing_field(
"dashboard_arn",
"dashboard_arn was not specified but it is required when building DescribeDashboardOutput",
)
})?,
dashboard_name: self.dashboard_name.ok_or_else(|| {
::aws_smithy_types::error::operation::BuildError::missing_field(
"dashboard_name",
"dashboard_name was not specified but it is required when building DescribeDashboardOutput",
)
})?,
project_id: self.project_id.ok_or_else(|| {
::aws_smithy_types::error::operation::BuildError::missing_field(
"project_id",
"project_id was not specified but it is required when building DescribeDashboardOutput",
)
})?,
dashboard_description: self.dashboard_description,
dashboard_definition: self.dashboard_definition.ok_or_else(|| {
::aws_smithy_types::error::operation::BuildError::missing_field(
"dashboard_definition",
"dashboard_definition was not specified but it is required when building DescribeDashboardOutput",
)
})?,
dashboard_creation_date: self.dashboard_creation_date.ok_or_else(|| {
::aws_smithy_types::error::operation::BuildError::missing_field(
"dashboard_creation_date",
"dashboard_creation_date was not specified but it is required when building DescribeDashboardOutput",
)
})?,
dashboard_last_update_date: self.dashboard_last_update_date.ok_or_else(|| {
::aws_smithy_types::error::operation::BuildError::missing_field(
"dashboard_last_update_date",
"dashboard_last_update_date was not specified but it is required when building DescribeDashboardOutput",
)
})?,
_request_id: self._request_id,
})
}
}