/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include namespace Aws { namespace GameLift { namespace Model { /** *

Represents the input for a request action.

See Also:

AWS * API Reference

*/ class AWS_GAMELIFT_API UpdateGameSessionQueueRequest : public GameLiftRequest { public: UpdateGameSessionQueueRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "UpdateGameSessionQueue"; } Aws::String SerializePayload() const override; Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

A descriptive label that is associated with game session queue. Queue names * must be unique within each Region. You can use either the queue ID or ARN value. *

*/ inline const Aws::String& GetName() const{ return m_name; } /** *

A descriptive label that is associated with game session queue. Queue names * must be unique within each Region. You can use either the queue ID or ARN value. *

*/ inline bool NameHasBeenSet() const { return m_nameHasBeenSet; } /** *

A descriptive label that is associated with game session queue. Queue names * must be unique within each Region. You can use either the queue ID or ARN value. *

*/ inline void SetName(const Aws::String& value) { m_nameHasBeenSet = true; m_name = value; } /** *

A descriptive label that is associated with game session queue. Queue names * must be unique within each Region. You can use either the queue ID or ARN value. *

*/ inline void SetName(Aws::String&& value) { m_nameHasBeenSet = true; m_name = std::move(value); } /** *

A descriptive label that is associated with game session queue. Queue names * must be unique within each Region. You can use either the queue ID or ARN value. *

*/ inline void SetName(const char* value) { m_nameHasBeenSet = true; m_name.assign(value); } /** *

A descriptive label that is associated with game session queue. Queue names * must be unique within each Region. You can use either the queue ID or ARN value. *

*/ inline UpdateGameSessionQueueRequest& WithName(const Aws::String& value) { SetName(value); return *this;} /** *

A descriptive label that is associated with game session queue. Queue names * must be unique within each Region. You can use either the queue ID or ARN value. *

*/ inline UpdateGameSessionQueueRequest& WithName(Aws::String&& value) { SetName(std::move(value)); return *this;} /** *

A descriptive label that is associated with game session queue. Queue names * must be unique within each Region. You can use either the queue ID or ARN value. *

*/ inline UpdateGameSessionQueueRequest& WithName(const char* value) { SetName(value); return *this;} /** *

The maximum time, in seconds, that a new game session placement request * remains in the queue. When a request exceeds this time, the game session * placement changes to a TIMED_OUT status.

*/ inline int GetTimeoutInSeconds() const{ return m_timeoutInSeconds; } /** *

The maximum time, in seconds, that a new game session placement request * remains in the queue. When a request exceeds this time, the game session * placement changes to a TIMED_OUT status.

*/ inline bool TimeoutInSecondsHasBeenSet() const { return m_timeoutInSecondsHasBeenSet; } /** *

The maximum time, in seconds, that a new game session placement request * remains in the queue. When a request exceeds this time, the game session * placement changes to a TIMED_OUT status.

*/ inline void SetTimeoutInSeconds(int value) { m_timeoutInSecondsHasBeenSet = true; m_timeoutInSeconds = value; } /** *

The maximum time, in seconds, that a new game session placement request * remains in the queue. When a request exceeds this time, the game session * placement changes to a TIMED_OUT status.

*/ inline UpdateGameSessionQueueRequest& WithTimeoutInSeconds(int value) { SetTimeoutInSeconds(value); return *this;} /** *

A collection of latency policies to apply when processing game sessions * placement requests with player latency information. Multiple policies are * evaluated in order of the maximum latency value, starting with the lowest * latency values. With just one policy, the policy is enforced at the start of the * game session placement for the duration period. With multiple policies, each * policy is enforced consecutively for its duration period. For example, a queue * might enforce a 60-second policy followed by a 120-second policy, and then no * policy for the remainder of the placement. When updating policies, provide a * complete collection of policies.

*/ inline const Aws::Vector& GetPlayerLatencyPolicies() const{ return m_playerLatencyPolicies; } /** *

A collection of latency policies to apply when processing game sessions * placement requests with player latency information. Multiple policies are * evaluated in order of the maximum latency value, starting with the lowest * latency values. With just one policy, the policy is enforced at the start of the * game session placement for the duration period. With multiple policies, each * policy is enforced consecutively for its duration period. For example, a queue * might enforce a 60-second policy followed by a 120-second policy, and then no * policy for the remainder of the placement. When updating policies, provide a * complete collection of policies.

*/ inline bool PlayerLatencyPoliciesHasBeenSet() const { return m_playerLatencyPoliciesHasBeenSet; } /** *

A collection of latency policies to apply when processing game sessions * placement requests with player latency information. Multiple policies are * evaluated in order of the maximum latency value, starting with the lowest * latency values. With just one policy, the policy is enforced at the start of the * game session placement for the duration period. With multiple policies, each * policy is enforced consecutively for its duration period. For example, a queue * might enforce a 60-second policy followed by a 120-second policy, and then no * policy for the remainder of the placement. When updating policies, provide a * complete collection of policies.

*/ inline void SetPlayerLatencyPolicies(const Aws::Vector& value) { m_playerLatencyPoliciesHasBeenSet = true; m_playerLatencyPolicies = value; } /** *

A collection of latency policies to apply when processing game sessions * placement requests with player latency information. Multiple policies are * evaluated in order of the maximum latency value, starting with the lowest * latency values. With just one policy, the policy is enforced at the start of the * game session placement for the duration period. With multiple policies, each * policy is enforced consecutively for its duration period. For example, a queue * might enforce a 60-second policy followed by a 120-second policy, and then no * policy for the remainder of the placement. When updating policies, provide a * complete collection of policies.

*/ inline void SetPlayerLatencyPolicies(Aws::Vector&& value) { m_playerLatencyPoliciesHasBeenSet = true; m_playerLatencyPolicies = std::move(value); } /** *

A collection of latency policies to apply when processing game sessions * placement requests with player latency information. Multiple policies are * evaluated in order of the maximum latency value, starting with the lowest * latency values. With just one policy, the policy is enforced at the start of the * game session placement for the duration period. With multiple policies, each * policy is enforced consecutively for its duration period. For example, a queue * might enforce a 60-second policy followed by a 120-second policy, and then no * policy for the remainder of the placement. When updating policies, provide a * complete collection of policies.

*/ inline UpdateGameSessionQueueRequest& WithPlayerLatencyPolicies(const Aws::Vector& value) { SetPlayerLatencyPolicies(value); return *this;} /** *

A collection of latency policies to apply when processing game sessions * placement requests with player latency information. Multiple policies are * evaluated in order of the maximum latency value, starting with the lowest * latency values. With just one policy, the policy is enforced at the start of the * game session placement for the duration period. With multiple policies, each * policy is enforced consecutively for its duration period. For example, a queue * might enforce a 60-second policy followed by a 120-second policy, and then no * policy for the remainder of the placement. When updating policies, provide a * complete collection of policies.

*/ inline UpdateGameSessionQueueRequest& WithPlayerLatencyPolicies(Aws::Vector&& value) { SetPlayerLatencyPolicies(std::move(value)); return *this;} /** *

A collection of latency policies to apply when processing game sessions * placement requests with player latency information. Multiple policies are * evaluated in order of the maximum latency value, starting with the lowest * latency values. With just one policy, the policy is enforced at the start of the * game session placement for the duration period. With multiple policies, each * policy is enforced consecutively for its duration period. For example, a queue * might enforce a 60-second policy followed by a 120-second policy, and then no * policy for the remainder of the placement. When updating policies, provide a * complete collection of policies.

*/ inline UpdateGameSessionQueueRequest& AddPlayerLatencyPolicies(const PlayerLatencyPolicy& value) { m_playerLatencyPoliciesHasBeenSet = true; m_playerLatencyPolicies.push_back(value); return *this; } /** *

A collection of latency policies to apply when processing game sessions * placement requests with player latency information. Multiple policies are * evaluated in order of the maximum latency value, starting with the lowest * latency values. With just one policy, the policy is enforced at the start of the * game session placement for the duration period. With multiple policies, each * policy is enforced consecutively for its duration period. For example, a queue * might enforce a 60-second policy followed by a 120-second policy, and then no * policy for the remainder of the placement. When updating policies, provide a * complete collection of policies.

*/ inline UpdateGameSessionQueueRequest& AddPlayerLatencyPolicies(PlayerLatencyPolicy&& value) { m_playerLatencyPoliciesHasBeenSet = true; m_playerLatencyPolicies.push_back(std::move(value)); return *this; } /** *

A list of fleets that can be used to fulfill game session placement requests * in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. * Destinations are listed in default preference order. When updating this list, * provide a complete list of destinations.

*/ inline const Aws::Vector& GetDestinations() const{ return m_destinations; } /** *

A list of fleets that can be used to fulfill game session placement requests * in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. * Destinations are listed in default preference order. When updating this list, * provide a complete list of destinations.

*/ inline bool DestinationsHasBeenSet() const { return m_destinationsHasBeenSet; } /** *

A list of fleets that can be used to fulfill game session placement requests * in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. * Destinations are listed in default preference order. When updating this list, * provide a complete list of destinations.

*/ inline void SetDestinations(const Aws::Vector& value) { m_destinationsHasBeenSet = true; m_destinations = value; } /** *

A list of fleets that can be used to fulfill game session placement requests * in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. * Destinations are listed in default preference order. When updating this list, * provide a complete list of destinations.

*/ inline void SetDestinations(Aws::Vector&& value) { m_destinationsHasBeenSet = true; m_destinations = std::move(value); } /** *

A list of fleets that can be used to fulfill game session placement requests * in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. * Destinations are listed in default preference order. When updating this list, * provide a complete list of destinations.

*/ inline UpdateGameSessionQueueRequest& WithDestinations(const Aws::Vector& value) { SetDestinations(value); return *this;} /** *

A list of fleets that can be used to fulfill game session placement requests * in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. * Destinations are listed in default preference order. When updating this list, * provide a complete list of destinations.

*/ inline UpdateGameSessionQueueRequest& WithDestinations(Aws::Vector&& value) { SetDestinations(std::move(value)); return *this;} /** *

A list of fleets that can be used to fulfill game session placement requests * in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. * Destinations are listed in default preference order. When updating this list, * provide a complete list of destinations.

*/ inline UpdateGameSessionQueueRequest& AddDestinations(const GameSessionQueueDestination& value) { m_destinationsHasBeenSet = true; m_destinations.push_back(value); return *this; } /** *

A list of fleets that can be used to fulfill game session placement requests * in the queue. Fleets are identified by either a fleet ARN or a fleet alias ARN. * Destinations are listed in default preference order. When updating this list, * provide a complete list of destinations.

*/ inline UpdateGameSessionQueueRequest& AddDestinations(GameSessionQueueDestination&& value) { m_destinationsHasBeenSet = true; m_destinations.push_back(std::move(value)); return *this; } private: Aws::String m_name; bool m_nameHasBeenSet; int m_timeoutInSeconds; bool m_timeoutInSecondsHasBeenSet; Aws::Vector m_playerLatencyPolicies; bool m_playerLatencyPoliciesHasBeenSet; Aws::Vector m_destinations; bool m_destinationsHasBeenSet; }; } // namespace Model } // namespace GameLift } // namespace Aws