aws_sdk_gamelift/operation/stop_matchmaking/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::stop_matchmaking::_stop_matchmaking_output::StopMatchmakingOutputBuilder;
3
4pub use crate::operation::stop_matchmaking::_stop_matchmaking_input::StopMatchmakingInputBuilder;
5
6impl crate::operation::stop_matchmaking::builders::StopMatchmakingInputBuilder {
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::stop_matchmaking::StopMatchmakingOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::stop_matchmaking::StopMatchmakingError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.stop_matchmaking();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `StopMatchmaking`.
24///
25/// <p><b>This API works with the following fleet types:</b> EC2, Anywhere, Container</p>
26/// <p>Cancels a matchmaking ticket or match backfill ticket that is currently being processed. To stop the matchmaking operation, specify the ticket ID. If successful, work on the ticket is stopped, and the ticket status is changed to <code>CANCELLED</code>.</p>
27/// <p>This call is also used to turn off automatic backfill for an individual game session. This is for game sessions that are created with a matchmaking configuration that has automatic backfill enabled. The ticket ID is included in the <code>MatchmakerData</code> of an updated game session object, which is provided to the game server.</p><note>
28/// <p>If the operation is successful, the service sends back an empty JSON struct with the HTTP 200 response (not an empty HTTP body).</p>
29/// </note>
30/// <p><b>Learn more</b></p>
31/// <p><a href="https://docs.aws.amazon.com/gamelift/latest/flexmatchguide/match-client.html"> Add FlexMatch to a game client</a></p>
32#[derive(::std::clone::Clone, ::std::fmt::Debug)]
33pub struct StopMatchmakingFluentBuilder {
34    handle: ::std::sync::Arc<crate::client::Handle>,
35    inner: crate::operation::stop_matchmaking::builders::StopMatchmakingInputBuilder,
36    config_override: ::std::option::Option<crate::config::Builder>,
37}
38impl
39    crate::client::customize::internal::CustomizableSend<
40        crate::operation::stop_matchmaking::StopMatchmakingOutput,
41        crate::operation::stop_matchmaking::StopMatchmakingError,
42    > for StopMatchmakingFluentBuilder
43{
44    fn send(
45        self,
46        config_override: crate::config::Builder,
47    ) -> crate::client::customize::internal::BoxFuture<
48        crate::client::customize::internal::SendResult<
49            crate::operation::stop_matchmaking::StopMatchmakingOutput,
50            crate::operation::stop_matchmaking::StopMatchmakingError,
51        >,
52    > {
53        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
54    }
55}
56impl StopMatchmakingFluentBuilder {
57    /// Creates a new `StopMatchmakingFluentBuilder`.
58    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
59        Self {
60            handle,
61            inner: ::std::default::Default::default(),
62            config_override: ::std::option::Option::None,
63        }
64    }
65    /// Access the StopMatchmaking as a reference.
66    pub fn as_input(&self) -> &crate::operation::stop_matchmaking::builders::StopMatchmakingInputBuilder {
67        &self.inner
68    }
69    /// Sends the request and returns the response.
70    ///
71    /// If an error occurs, an `SdkError` will be returned with additional details that
72    /// can be matched against.
73    ///
74    /// By default, any retryable failures will be retried twice. Retry behavior
75    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
76    /// set when configuring the client.
77    pub async fn send(
78        self,
79    ) -> ::std::result::Result<
80        crate::operation::stop_matchmaking::StopMatchmakingOutput,
81        ::aws_smithy_runtime_api::client::result::SdkError<
82            crate::operation::stop_matchmaking::StopMatchmakingError,
83            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
84        >,
85    > {
86        let input = self
87            .inner
88            .build()
89            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
90        let runtime_plugins = crate::operation::stop_matchmaking::StopMatchmaking::operation_runtime_plugins(
91            self.handle.runtime_plugins.clone(),
92            &self.handle.conf,
93            self.config_override,
94        );
95        crate::operation::stop_matchmaking::StopMatchmaking::orchestrate(&runtime_plugins, input).await
96    }
97
98    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
99    pub fn customize(
100        self,
101    ) -> crate::client::customize::CustomizableOperation<
102        crate::operation::stop_matchmaking::StopMatchmakingOutput,
103        crate::operation::stop_matchmaking::StopMatchmakingError,
104        Self,
105    > {
106        crate::client::customize::CustomizableOperation::new(self)
107    }
108    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
109        self.set_config_override(::std::option::Option::Some(config_override.into()));
110        self
111    }
112
113    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
114        self.config_override = config_override;
115        self
116    }
117    /// <p>A unique identifier for a matchmaking ticket.</p>
118    pub fn ticket_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
119        self.inner = self.inner.ticket_id(input.into());
120        self
121    }
122    /// <p>A unique identifier for a matchmaking ticket.</p>
123    pub fn set_ticket_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
124        self.inner = self.inner.set_ticket_id(input);
125        self
126    }
127    /// <p>A unique identifier for a matchmaking ticket.</p>
128    pub fn get_ticket_id(&self) -> &::std::option::Option<::std::string::String> {
129        self.inner.get_ticket_id()
130    }
131}
aws_sdk_gamelift/operation/stop_matchmaking/builders.rs

aws_sdk_gamelift/operation/stop_matchmaking/
builders.rs
