aws-sdk-timestreamquery 1.104.0

AWS SDK for Amazon Timestream Query
Documentation 
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

// 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)]
pub struct ExecuteScheduledQueryInput {
    /// <p>ARN of the scheduled query.</p>
    pub scheduled_query_arn: ::std::option::Option<::std::string::String>,
    /// <p>The timestamp in UTC. Query will be run as if it was invoked at this timestamp.</p>
    pub invocation_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>Not used.</p>
    pub client_token: ::std::option::Option<::std::string::String>,
    /// <p>Encapsulates settings for enabling <code>QueryInsights</code>.</p>
    /// <p>Enabling <code>QueryInsights</code> returns insights and metrics as a part of the Amazon SNS notification for the query that you executed. You can use <code>QueryInsights</code> to tune your query performance and cost.</p>
    pub query_insights: ::std::option::Option<crate::types::ScheduledQueryInsights>,
}
impl ExecuteScheduledQueryInput {
    /// <p>ARN of the scheduled query.</p>
    pub fn scheduled_query_arn(&self) -> ::std::option::Option<&str> {
        self.scheduled_query_arn.as_deref()
    }
    /// <p>The timestamp in UTC. Query will be run as if it was invoked at this timestamp.</p>
    pub fn invocation_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.invocation_time.as_ref()
    }
    /// <p>Not used.</p>
    pub fn client_token(&self) -> ::std::option::Option<&str> {
        self.client_token.as_deref()
    }
    /// <p>Encapsulates settings for enabling <code>QueryInsights</code>.</p>
    /// <p>Enabling <code>QueryInsights</code> returns insights and metrics as a part of the Amazon SNS notification for the query that you executed. You can use <code>QueryInsights</code> to tune your query performance and cost.</p>
    pub fn query_insights(&self) -> ::std::option::Option<&crate::types::ScheduledQueryInsights> {
        self.query_insights.as_ref()
    }
}
impl ::std::fmt::Debug for ExecuteScheduledQueryInput {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("ExecuteScheduledQueryInput");
        formatter.field("scheduled_query_arn", &self.scheduled_query_arn);
        formatter.field("invocation_time", &self.invocation_time);
        formatter.field("client_token", &"*** Sensitive Data Redacted ***");
        formatter.field("query_insights", &self.query_insights);
        formatter.finish()
    }
}
impl ExecuteScheduledQueryInput {
    /// Creates a new builder-style object to manufacture [`ExecuteScheduledQueryInput`](crate::operation::execute_scheduled_query::ExecuteScheduledQueryInput).
    pub fn builder() -> crate::operation::execute_scheduled_query::builders::ExecuteScheduledQueryInputBuilder {
        crate::operation::execute_scheduled_query::builders::ExecuteScheduledQueryInputBuilder::default()
    }
}

/// A builder for [`ExecuteScheduledQueryInput`](crate::operation::execute_scheduled_query::ExecuteScheduledQueryInput).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default)]
#[non_exhaustive]
pub struct ExecuteScheduledQueryInputBuilder {
    pub(crate) scheduled_query_arn: ::std::option::Option<::std::string::String>,
    pub(crate) invocation_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) client_token: ::std::option::Option<::std::string::String>,
    pub(crate) query_insights: ::std::option::Option<crate::types::ScheduledQueryInsights>,
}
impl ExecuteScheduledQueryInputBuilder {
    /// <p>ARN of the scheduled query.</p>
    /// This field is required.
    pub fn scheduled_query_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.scheduled_query_arn = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>ARN of the scheduled query.</p>
    pub fn set_scheduled_query_arn(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.scheduled_query_arn = input;
        self
    }
    /// <p>ARN of the scheduled query.</p>
    pub fn get_scheduled_query_arn(&self) -> &::std::option::Option<::std::string::String> {
        &self.scheduled_query_arn
    }
    /// <p>The timestamp in UTC. Query will be run as if it was invoked at this timestamp.</p>
    /// This field is required.
    pub fn invocation_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.invocation_time = ::std::option::Option::Some(input);
        self
    }
    /// <p>The timestamp in UTC. Query will be run as if it was invoked at this timestamp.</p>
    pub fn set_invocation_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.invocation_time = input;
        self
    }
    /// <p>The timestamp in UTC. Query will be run as if it was invoked at this timestamp.</p>
    pub fn get_invocation_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.invocation_time
    }
    /// <p>Not used.</p>
    pub fn client_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.client_token = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>Not used.</p>
    pub fn set_client_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.client_token = input;
        self
    }
    /// <p>Not used.</p>
    pub fn get_client_token(&self) -> &::std::option::Option<::std::string::String> {
        &self.client_token
    }
    /// <p>Encapsulates settings for enabling <code>QueryInsights</code>.</p>
    /// <p>Enabling <code>QueryInsights</code> returns insights and metrics as a part of the Amazon SNS notification for the query that you executed. You can use <code>QueryInsights</code> to tune your query performance and cost.</p>
    pub fn query_insights(mut self, input: crate::types::ScheduledQueryInsights) -> Self {
        self.query_insights = ::std::option::Option::Some(input);
        self
    }
    /// <p>Encapsulates settings for enabling <code>QueryInsights</code>.</p>
    /// <p>Enabling <code>QueryInsights</code> returns insights and metrics as a part of the Amazon SNS notification for the query that you executed. You can use <code>QueryInsights</code> to tune your query performance and cost.</p>
    pub fn set_query_insights(mut self, input: ::std::option::Option<crate::types::ScheduledQueryInsights>) -> Self {
        self.query_insights = input;
        self
    }
    /// <p>Encapsulates settings for enabling <code>QueryInsights</code>.</p>
    /// <p>Enabling <code>QueryInsights</code> returns insights and metrics as a part of the Amazon SNS notification for the query that you executed. You can use <code>QueryInsights</code> to tune your query performance and cost.</p>
    pub fn get_query_insights(&self) -> &::std::option::Option<crate::types::ScheduledQueryInsights> {
        &self.query_insights
    }
    /// Consumes the builder and constructs a [`ExecuteScheduledQueryInput`](crate::operation::execute_scheduled_query::ExecuteScheduledQueryInput).
    pub fn build(
        self,
    ) -> ::std::result::Result<crate::operation::execute_scheduled_query::ExecuteScheduledQueryInput, ::aws_smithy_types::error::operation::BuildError>
    {
        ::std::result::Result::Ok(crate::operation::execute_scheduled_query::ExecuteScheduledQueryInput {
            scheduled_query_arn: self.scheduled_query_arn,
            invocation_time: self.invocation_time,
            client_token: self.client_token,
            query_insights: self.query_insights,
        })
    }
}
impl ::std::fmt::Debug for ExecuteScheduledQueryInputBuilder {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("ExecuteScheduledQueryInputBuilder");
        formatter.field("scheduled_query_arn", &self.scheduled_query_arn);
        formatter.field("invocation_time", &self.invocation_time);
        formatter.field("client_token", &"*** Sensitive Data Redacted ***");
        formatter.field("query_insights", &self.query_insights);
        formatter.finish()
    }
}