aws_sdk_gamelift/operation/update_script/builders.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::update_script::_update_script_output::UpdateScriptOutputBuilder;
3
4pub use crate::operation::update_script::_update_script_input::UpdateScriptInputBuilder;
5
6impl crate::operation::update_script::builders::UpdateScriptInputBuilder {
7 /// Sends a request with this input using the given client.
8 pub async fn send_with(
9 self,
10 client: &crate::Client,
11 ) -> ::std::result::Result<
12 crate::operation::update_script::UpdateScriptOutput,
13 ::aws_smithy_runtime_api::client::result::SdkError<
14 crate::operation::update_script::UpdateScriptError,
15 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16 >,
17 > {
18 let mut fluent_builder = client.update_script();
19 fluent_builder.inner = self;
20 fluent_builder.send().await
21 }
22}
23/// Fluent builder constructing a request to `UpdateScript`.
24///
25/// <p>Updates Realtime script metadata and content.</p>
26/// <p>To update script metadata, specify the script ID and provide updated name and/or version values.</p>
27/// <p>To update script content, provide an updated zip file by pointing to either a local file or an Amazon S3 bucket location. You can use either method regardless of how the original script was uploaded. Use the <i>Version</i> parameter to track updates to the script.</p>
28/// <p>If the call is successful, the updated metadata is stored in the script record and a revised script is uploaded to the Amazon GameLift Servers service. Once the script is updated and acquired by a fleet instance, the new version is used for all new game sessions.</p>
29/// <p><b>Learn more</b></p>
30/// <p><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/realtime-intro.html">Amazon GameLift Servers Amazon GameLift Servers Realtime</a></p>
31/// <p><b>Related actions</b></p>
32/// <p><a href="https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-awssdk.html#reference-awssdk-resources-fleets">All APIs by task</a></p>
33#[derive(::std::clone::Clone, ::std::fmt::Debug)]
34pub struct UpdateScriptFluentBuilder {
35 handle: ::std::sync::Arc<crate::client::Handle>,
36 inner: crate::operation::update_script::builders::UpdateScriptInputBuilder,
37 config_override: ::std::option::Option<crate::config::Builder>,
38}
39impl
40 crate::client::customize::internal::CustomizableSend<
41 crate::operation::update_script::UpdateScriptOutput,
42 crate::operation::update_script::UpdateScriptError,
43 > for UpdateScriptFluentBuilder
44{
45 fn send(
46 self,
47 config_override: crate::config::Builder,
48 ) -> crate::client::customize::internal::BoxFuture<
49 crate::client::customize::internal::SendResult<
50 crate::operation::update_script::UpdateScriptOutput,
51 crate::operation::update_script::UpdateScriptError,
52 >,
53 > {
54 ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
55 }
56}
57impl UpdateScriptFluentBuilder {
58 /// Creates a new `UpdateScriptFluentBuilder`.
59 pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
60 Self {
61 handle,
62 inner: ::std::default::Default::default(),
63 config_override: ::std::option::Option::None,
64 }
65 }
66 /// Access the UpdateScript as a reference.
67 pub fn as_input(&self) -> &crate::operation::update_script::builders::UpdateScriptInputBuilder {
68 &self.inner
69 }
70 /// Sends the request and returns the response.
71 ///
72 /// If an error occurs, an `SdkError` will be returned with additional details that
73 /// can be matched against.
74 ///
75 /// By default, any retryable failures will be retried twice. Retry behavior
76 /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
77 /// set when configuring the client.
78 pub async fn send(
79 self,
80 ) -> ::std::result::Result<
81 crate::operation::update_script::UpdateScriptOutput,
82 ::aws_smithy_runtime_api::client::result::SdkError<
83 crate::operation::update_script::UpdateScriptError,
84 ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
85 >,
86 > {
87 let input = self
88 .inner
89 .build()
90 .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
91 let runtime_plugins = crate::operation::update_script::UpdateScript::operation_runtime_plugins(
92 self.handle.runtime_plugins.clone(),
93 &self.handle.conf,
94 self.config_override,
95 );
96 crate::operation::update_script::UpdateScript::orchestrate(&runtime_plugins, input).await
97 }
98
99 /// Consumes this builder, creating a customizable operation that can be modified before being sent.
100 pub fn customize(
101 self,
102 ) -> crate::client::customize::CustomizableOperation<
103 crate::operation::update_script::UpdateScriptOutput,
104 crate::operation::update_script::UpdateScriptError,
105 Self,
106 > {
107 crate::client::customize::CustomizableOperation::new(self)
108 }
109 pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
110 self.set_config_override(::std::option::Option::Some(config_override.into()));
111 self
112 }
113
114 pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
115 self.config_override = config_override;
116 self
117 }
118 /// <p>A unique identifier for the Realtime script to update. You can use either the script ID or ARN value.</p>
119 pub fn script_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
120 self.inner = self.inner.script_id(input.into());
121 self
122 }
123 /// <p>A unique identifier for the Realtime script to update. You can use either the script ID or ARN value.</p>
124 pub fn set_script_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
125 self.inner = self.inner.set_script_id(input);
126 self
127 }
128 /// <p>A unique identifier for the Realtime script to update. You can use either the script ID or ARN value.</p>
129 pub fn get_script_id(&self) -> &::std::option::Option<::std::string::String> {
130 self.inner.get_script_id()
131 }
132 /// <p>A descriptive label that is associated with a script. Script names do not need to be unique.</p>
133 pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
134 self.inner = self.inner.name(input.into());
135 self
136 }
137 /// <p>A descriptive label that is associated with a script. Script names do not need to be unique.</p>
138 pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
139 self.inner = self.inner.set_name(input);
140 self
141 }
142 /// <p>A descriptive label that is associated with a script. Script names do not need to be unique.</p>
143 pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
144 self.inner.get_name()
145 }
146 /// <p>Version information that is associated with a build or script. Version strings do not need to be unique.</p>
147 pub fn version(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
148 self.inner = self.inner.version(input.into());
149 self
150 }
151 /// <p>Version information that is associated with a build or script. Version strings do not need to be unique.</p>
152 pub fn set_version(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
153 self.inner = self.inner.set_version(input);
154 self
155 }
156 /// <p>Version information that is associated with a build or script. Version strings do not need to be unique.</p>
157 pub fn get_version(&self) -> &::std::option::Option<::std::string::String> {
158 self.inner.get_version()
159 }
160 /// <p>The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon GameLift Servers to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift Servers uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the <code>ObjectVersion</code> parameter to specify an earlier version.</p>
161 pub fn storage_location(mut self, input: crate::types::S3Location) -> Self {
162 self.inner = self.inner.storage_location(input);
163 self
164 }
165 /// <p>The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon GameLift Servers to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift Servers uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the <code>ObjectVersion</code> parameter to specify an earlier version.</p>
166 pub fn set_storage_location(mut self, input: ::std::option::Option<crate::types::S3Location>) -> Self {
167 self.inner = self.inner.set_storage_location(input);
168 self
169 }
170 /// <p>The location of the Amazon S3 bucket where a zipped file containing your Realtime scripts is stored. The storage location must specify the Amazon S3 bucket name, the zip file name (the "key"), and a role ARN that allows Amazon GameLift Servers to access the Amazon S3 storage location. The S3 bucket must be in the same Region where you want to create a new script. By default, Amazon GameLift Servers uploads the latest version of the zip file; if you have S3 object versioning turned on, you can use the <code>ObjectVersion</code> parameter to specify an earlier version.</p>
171 pub fn get_storage_location(&self) -> &::std::option::Option<crate::types::S3Location> {
172 self.inner.get_storage_location()
173 }
174 /// <p>A data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one or multiple files. Maximum size of a zip file is 5 MB.</p>
175 /// <p>When using the Amazon Web Services CLI tool to create a script, this parameter is set to the zip file name. It must be prepended with the string "fileb://" to indicate that the file data is a binary object. For example: <code>--zip-file fileb://myRealtimeScript.zip</code>.</p>
176 pub fn zip_file(mut self, input: ::aws_smithy_types::Blob) -> Self {
177 self.inner = self.inner.zip_file(input);
178 self
179 }
180 /// <p>A data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one or multiple files. Maximum size of a zip file is 5 MB.</p>
181 /// <p>When using the Amazon Web Services CLI tool to create a script, this parameter is set to the zip file name. It must be prepended with the string "fileb://" to indicate that the file data is a binary object. For example: <code>--zip-file fileb://myRealtimeScript.zip</code>.</p>
182 pub fn set_zip_file(mut self, input: ::std::option::Option<::aws_smithy_types::Blob>) -> Self {
183 self.inner = self.inner.set_zip_file(input);
184 self
185 }
186 /// <p>A data object containing your Realtime scripts and dependencies as a zip file. The zip file can have one or multiple files. Maximum size of a zip file is 5 MB.</p>
187 /// <p>When using the Amazon Web Services CLI tool to create a script, this parameter is set to the zip file name. It must be prepended with the string "fileb://" to indicate that the file data is a binary object. For example: <code>--zip-file fileb://myRealtimeScript.zip</code>.</p>
188 pub fn get_zip_file(&self) -> &::std::option::Option<::aws_smithy_types::Blob> {
189 self.inner.get_zip_file()
190 }
191}