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
// 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 UpdateTemplateInput {
/// <p>The ID of the Amazon Web Services account that contains the template that you're updating.</p>
pub aws_account_id: ::std::option::Option<::std::string::String>,
/// <p>The ID for the template.</p>
pub template_id: ::std::option::Option<::std::string::String>,
/// <p>The entity that you are using as a source when you update the template. In <code>SourceEntity</code>, you specify the type of object you're using as source: <code>SourceTemplate</code> for a template or <code>SourceAnalysis</code> for an analysis. Both of these require an Amazon Resource Name (ARN). For <code>SourceTemplate</code>, specify the ARN of the source template. For <code>SourceAnalysis</code>, specify the ARN of the source analysis. The <code>SourceTemplate</code> ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region;. </p>
/// <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> or <code>SourceAnalysis</code> to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder. </p>
pub source_entity: ::std::option::Option<crate::types::TemplateSourceEntity>,
/// <p>A description of the current template version that is being updated. Every time you call <code>UpdateTemplate</code>, you create a new version of the template. Each version of the template maintains a description of the version in the <code>VersionDescription</code> field.</p>
pub version_description: ::std::option::Option<::std::string::String>,
/// <p>The name for the template.</p>
pub name: ::std::option::Option<::std::string::String>,
/// <p>The definition of a template.</p>
/// <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
pub definition: ::std::option::Option<crate::types::TemplateVersionDefinition>,
}
impl UpdateTemplateInput {
/// <p>The ID of the Amazon Web Services account that contains the template that you're updating.</p>
pub fn aws_account_id(&self) -> ::std::option::Option<&str> {
self.aws_account_id.as_deref()
}
/// <p>The ID for the template.</p>
pub fn template_id(&self) -> ::std::option::Option<&str> {
self.template_id.as_deref()
}
/// <p>The entity that you are using as a source when you update the template. In <code>SourceEntity</code>, you specify the type of object you're using as source: <code>SourceTemplate</code> for a template or <code>SourceAnalysis</code> for an analysis. Both of these require an Amazon Resource Name (ARN). For <code>SourceTemplate</code>, specify the ARN of the source template. For <code>SourceAnalysis</code>, specify the ARN of the source analysis. The <code>SourceTemplate</code> ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region;. </p>
/// <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> or <code>SourceAnalysis</code> to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder. </p>
pub fn source_entity(&self) -> ::std::option::Option<&crate::types::TemplateSourceEntity> {
self.source_entity.as_ref()
}
/// <p>A description of the current template version that is being updated. Every time you call <code>UpdateTemplate</code>, you create a new version of the template. Each version of the template maintains a description of the version in the <code>VersionDescription</code> field.</p>
pub fn version_description(&self) -> ::std::option::Option<&str> {
self.version_description.as_deref()
}
/// <p>The name for the template.</p>
pub fn name(&self) -> ::std::option::Option<&str> {
self.name.as_deref()
}
/// <p>The definition of a template.</p>
/// <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
pub fn definition(&self) -> ::std::option::Option<&crate::types::TemplateVersionDefinition> {
self.definition.as_ref()
}
}
impl UpdateTemplateInput {
/// Creates a new builder-style object to manufacture [`UpdateTemplateInput`](crate::operation::update_template::UpdateTemplateInput).
pub fn builder() -> crate::operation::update_template::builders::UpdateTemplateInputBuilder {
crate::operation::update_template::builders::UpdateTemplateInputBuilder::default()
}
}
/// A builder for [`UpdateTemplateInput`](crate::operation::update_template::UpdateTemplateInput).
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
pub struct UpdateTemplateInputBuilder {
pub(crate) aws_account_id: ::std::option::Option<::std::string::String>,
pub(crate) template_id: ::std::option::Option<::std::string::String>,
pub(crate) source_entity: ::std::option::Option<crate::types::TemplateSourceEntity>,
pub(crate) version_description: ::std::option::Option<::std::string::String>,
pub(crate) name: ::std::option::Option<::std::string::String>,
pub(crate) definition: ::std::option::Option<crate::types::TemplateVersionDefinition>,
}
impl UpdateTemplateInputBuilder {
/// <p>The ID of the Amazon Web Services account that contains the template that you're updating.</p>
pub fn aws_account_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.aws_account_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The ID of the Amazon Web Services account that contains the template that you're updating.</p>
pub fn set_aws_account_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.aws_account_id = input;
self
}
/// <p>The ID of the Amazon Web Services account that contains the template that you're updating.</p>
pub fn get_aws_account_id(&self) -> &::std::option::Option<::std::string::String> {
&self.aws_account_id
}
/// <p>The ID for the template.</p>
pub fn template_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.template_id = ::std::option::Option::Some(input.into());
self
}
/// <p>The ID for the template.</p>
pub fn set_template_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.template_id = input;
self
}
/// <p>The ID for the template.</p>
pub fn get_template_id(&self) -> &::std::option::Option<::std::string::String> {
&self.template_id
}
/// <p>The entity that you are using as a source when you update the template. In <code>SourceEntity</code>, you specify the type of object you're using as source: <code>SourceTemplate</code> for a template or <code>SourceAnalysis</code> for an analysis. Both of these require an Amazon Resource Name (ARN). For <code>SourceTemplate</code>, specify the ARN of the source template. For <code>SourceAnalysis</code>, specify the ARN of the source analysis. The <code>SourceTemplate</code> ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region;. </p>
/// <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> or <code>SourceAnalysis</code> to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder. </p>
pub fn source_entity(mut self, input: crate::types::TemplateSourceEntity) -> Self {
self.source_entity = ::std::option::Option::Some(input);
self
}
/// <p>The entity that you are using as a source when you update the template. In <code>SourceEntity</code>, you specify the type of object you're using as source: <code>SourceTemplate</code> for a template or <code>SourceAnalysis</code> for an analysis. Both of these require an Amazon Resource Name (ARN). For <code>SourceTemplate</code>, specify the ARN of the source template. For <code>SourceAnalysis</code>, specify the ARN of the source analysis. The <code>SourceTemplate</code> ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region;. </p>
/// <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> or <code>SourceAnalysis</code> to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder. </p>
pub fn set_source_entity(mut self, input: ::std::option::Option<crate::types::TemplateSourceEntity>) -> Self {
self.source_entity = input;
self
}
/// <p>The entity that you are using as a source when you update the template. In <code>SourceEntity</code>, you specify the type of object you're using as source: <code>SourceTemplate</code> for a template or <code>SourceAnalysis</code> for an analysis. Both of these require an Amazon Resource Name (ARN). For <code>SourceTemplate</code>, specify the ARN of the source template. For <code>SourceAnalysis</code>, specify the ARN of the source analysis. The <code>SourceTemplate</code> ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region;. </p>
/// <p>Use the <code>DataSetReferences</code> entity within <code>SourceTemplate</code> or <code>SourceAnalysis</code> to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder. </p>
pub fn get_source_entity(&self) -> &::std::option::Option<crate::types::TemplateSourceEntity> {
&self.source_entity
}
/// <p>A description of the current template version that is being updated. Every time you call <code>UpdateTemplate</code>, you create a new version of the template. Each version of the template maintains a description of the version in the <code>VersionDescription</code> field.</p>
pub fn version_description(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.version_description = ::std::option::Option::Some(input.into());
self
}
/// <p>A description of the current template version that is being updated. Every time you call <code>UpdateTemplate</code>, you create a new version of the template. Each version of the template maintains a description of the version in the <code>VersionDescription</code> field.</p>
pub fn set_version_description(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.version_description = input;
self
}
/// <p>A description of the current template version that is being updated. Every time you call <code>UpdateTemplate</code>, you create a new version of the template. Each version of the template maintains a description of the version in the <code>VersionDescription</code> field.</p>
pub fn get_version_description(&self) -> &::std::option::Option<::std::string::String> {
&self.version_description
}
/// <p>The name for the template.</p>
pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.name = ::std::option::Option::Some(input.into());
self
}
/// <p>The name for the template.</p>
pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
self.name = input;
self
}
/// <p>The name for the template.</p>
pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
&self.name
}
/// <p>The definition of a template.</p>
/// <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
pub fn definition(mut self, input: crate::types::TemplateVersionDefinition) -> Self {
self.definition = ::std::option::Option::Some(input);
self
}
/// <p>The definition of a template.</p>
/// <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
pub fn set_definition(mut self, input: ::std::option::Option<crate::types::TemplateVersionDefinition>) -> Self {
self.definition = input;
self
}
/// <p>The definition of a template.</p>
/// <p>A definition is the data model of all features in a Dashboard, Template, or Analysis.</p>
pub fn get_definition(&self) -> &::std::option::Option<crate::types::TemplateVersionDefinition> {
&self.definition
}
/// Consumes the builder and constructs a [`UpdateTemplateInput`](crate::operation::update_template::UpdateTemplateInput).
pub fn build(
self,
) -> ::std::result::Result<crate::operation::update_template::UpdateTemplateInput, ::aws_smithy_http::operation::error::BuildError> {
::std::result::Result::Ok(crate::operation::update_template::UpdateTemplateInput {
aws_account_id: self.aws_account_id,
template_id: self.template_id,
source_entity: self.source_entity,
version_description: self.version_description,
name: self.name,
definition: self.definition,
})
}
}