231 lines
11 KiB
C++
231 lines
11 KiB
C++
/**
|
|
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
* SPDX-License-Identifier: Apache-2.0.
|
|
*/
|
|
|
|
#pragma once
|
|
#include <aws/gamelift/GameLift_EXPORTS.h>
|
|
#include <aws/gamelift/GameLiftRequest.h>
|
|
#include <aws/core/utils/memory/stl/AWSVector.h>
|
|
#include <aws/core/utils/memory/stl/AWSString.h>
|
|
#include <utility>
|
|
|
|
namespace Aws
|
|
{
|
|
namespace GameLift
|
|
{
|
|
namespace Model
|
|
{
|
|
|
|
/**
|
|
* <p>Represents the input for a request action.</p><p><h3>See Also:</h3> <a
|
|
* href="http://docs.aws.amazon.com/goto/WebAPI/gamelift-2015-10-01/DescribeFleetAttributesInput">AWS
|
|
* API Reference</a></p>
|
|
*/
|
|
class AWS_GAMELIFT_API DescribeFleetAttributesRequest : public GameLiftRequest
|
|
{
|
|
public:
|
|
DescribeFleetAttributesRequest();
|
|
|
|
// 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 "DescribeFleetAttributes"; }
|
|
|
|
Aws::String SerializePayload() const override;
|
|
|
|
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override;
|
|
|
|
|
|
/**
|
|
* <p>A list of unique fleet identifiers to retrieve attributes for. You can use
|
|
* either the fleet ID or ARN value. To retrieve attributes for all current fleets,
|
|
* do not include this parameter. If the list of fleet identifiers includes fleets
|
|
* that don't currently exist, the request succeeds but no attributes for that
|
|
* fleet are returned.</p>
|
|
*/
|
|
inline const Aws::Vector<Aws::String>& GetFleetIds() const{ return m_fleetIds; }
|
|
|
|
/**
|
|
* <p>A list of unique fleet identifiers to retrieve attributes for. You can use
|
|
* either the fleet ID or ARN value. To retrieve attributes for all current fleets,
|
|
* do not include this parameter. If the list of fleet identifiers includes fleets
|
|
* that don't currently exist, the request succeeds but no attributes for that
|
|
* fleet are returned.</p>
|
|
*/
|
|
inline bool FleetIdsHasBeenSet() const { return m_fleetIdsHasBeenSet; }
|
|
|
|
/**
|
|
* <p>A list of unique fleet identifiers to retrieve attributes for. You can use
|
|
* either the fleet ID or ARN value. To retrieve attributes for all current fleets,
|
|
* do not include this parameter. If the list of fleet identifiers includes fleets
|
|
* that don't currently exist, the request succeeds but no attributes for that
|
|
* fleet are returned.</p>
|
|
*/
|
|
inline void SetFleetIds(const Aws::Vector<Aws::String>& value) { m_fleetIdsHasBeenSet = true; m_fleetIds = value; }
|
|
|
|
/**
|
|
* <p>A list of unique fleet identifiers to retrieve attributes for. You can use
|
|
* either the fleet ID or ARN value. To retrieve attributes for all current fleets,
|
|
* do not include this parameter. If the list of fleet identifiers includes fleets
|
|
* that don't currently exist, the request succeeds but no attributes for that
|
|
* fleet are returned.</p>
|
|
*/
|
|
inline void SetFleetIds(Aws::Vector<Aws::String>&& value) { m_fleetIdsHasBeenSet = true; m_fleetIds = std::move(value); }
|
|
|
|
/**
|
|
* <p>A list of unique fleet identifiers to retrieve attributes for. You can use
|
|
* either the fleet ID or ARN value. To retrieve attributes for all current fleets,
|
|
* do not include this parameter. If the list of fleet identifiers includes fleets
|
|
* that don't currently exist, the request succeeds but no attributes for that
|
|
* fleet are returned.</p>
|
|
*/
|
|
inline DescribeFleetAttributesRequest& WithFleetIds(const Aws::Vector<Aws::String>& value) { SetFleetIds(value); return *this;}
|
|
|
|
/**
|
|
* <p>A list of unique fleet identifiers to retrieve attributes for. You can use
|
|
* either the fleet ID or ARN value. To retrieve attributes for all current fleets,
|
|
* do not include this parameter. If the list of fleet identifiers includes fleets
|
|
* that don't currently exist, the request succeeds but no attributes for that
|
|
* fleet are returned.</p>
|
|
*/
|
|
inline DescribeFleetAttributesRequest& WithFleetIds(Aws::Vector<Aws::String>&& value) { SetFleetIds(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>A list of unique fleet identifiers to retrieve attributes for. You can use
|
|
* either the fleet ID or ARN value. To retrieve attributes for all current fleets,
|
|
* do not include this parameter. If the list of fleet identifiers includes fleets
|
|
* that don't currently exist, the request succeeds but no attributes for that
|
|
* fleet are returned.</p>
|
|
*/
|
|
inline DescribeFleetAttributesRequest& AddFleetIds(const Aws::String& value) { m_fleetIdsHasBeenSet = true; m_fleetIds.push_back(value); return *this; }
|
|
|
|
/**
|
|
* <p>A list of unique fleet identifiers to retrieve attributes for. You can use
|
|
* either the fleet ID or ARN value. To retrieve attributes for all current fleets,
|
|
* do not include this parameter. If the list of fleet identifiers includes fleets
|
|
* that don't currently exist, the request succeeds but no attributes for that
|
|
* fleet are returned.</p>
|
|
*/
|
|
inline DescribeFleetAttributesRequest& AddFleetIds(Aws::String&& value) { m_fleetIdsHasBeenSet = true; m_fleetIds.push_back(std::move(value)); return *this; }
|
|
|
|
/**
|
|
* <p>A list of unique fleet identifiers to retrieve attributes for. You can use
|
|
* either the fleet ID or ARN value. To retrieve attributes for all current fleets,
|
|
* do not include this parameter. If the list of fleet identifiers includes fleets
|
|
* that don't currently exist, the request succeeds but no attributes for that
|
|
* fleet are returned.</p>
|
|
*/
|
|
inline DescribeFleetAttributesRequest& AddFleetIds(const char* value) { m_fleetIdsHasBeenSet = true; m_fleetIds.push_back(value); return *this; }
|
|
|
|
|
|
/**
|
|
* <p>The maximum number of results to return. Use this parameter with
|
|
* <code>NextToken</code> to get results as a set of sequential pages. This
|
|
* parameter is ignored when the request specifies one or a list of fleet IDs.</p>
|
|
*/
|
|
inline int GetLimit() const{ return m_limit; }
|
|
|
|
/**
|
|
* <p>The maximum number of results to return. Use this parameter with
|
|
* <code>NextToken</code> to get results as a set of sequential pages. This
|
|
* parameter is ignored when the request specifies one or a list of fleet IDs.</p>
|
|
*/
|
|
inline bool LimitHasBeenSet() const { return m_limitHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The maximum number of results to return. Use this parameter with
|
|
* <code>NextToken</code> to get results as a set of sequential pages. This
|
|
* parameter is ignored when the request specifies one or a list of fleet IDs.</p>
|
|
*/
|
|
inline void SetLimit(int value) { m_limitHasBeenSet = true; m_limit = value; }
|
|
|
|
/**
|
|
* <p>The maximum number of results to return. Use this parameter with
|
|
* <code>NextToken</code> to get results as a set of sequential pages. This
|
|
* parameter is ignored when the request specifies one or a list of fleet IDs.</p>
|
|
*/
|
|
inline DescribeFleetAttributesRequest& WithLimit(int value) { SetLimit(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>Token that indicates the start of the next sequential page of results. Use
|
|
* the token that is returned with a previous call to this action. To start at the
|
|
* beginning of the result set, do not specify a value. This parameter is ignored
|
|
* when the request specifies one or a list of fleet IDs.</p>
|
|
*/
|
|
inline const Aws::String& GetNextToken() const{ return m_nextToken; }
|
|
|
|
/**
|
|
* <p>Token that indicates the start of the next sequential page of results. Use
|
|
* the token that is returned with a previous call to this action. To start at the
|
|
* beginning of the result set, do not specify a value. This parameter is ignored
|
|
* when the request specifies one or a list of fleet IDs.</p>
|
|
*/
|
|
inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; }
|
|
|
|
/**
|
|
* <p>Token that indicates the start of the next sequential page of results. Use
|
|
* the token that is returned with a previous call to this action. To start at the
|
|
* beginning of the result set, do not specify a value. This parameter is ignored
|
|
* when the request specifies one or a list of fleet IDs.</p>
|
|
*/
|
|
inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; }
|
|
|
|
/**
|
|
* <p>Token that indicates the start of the next sequential page of results. Use
|
|
* the token that is returned with a previous call to this action. To start at the
|
|
* beginning of the result set, do not specify a value. This parameter is ignored
|
|
* when the request specifies one or a list of fleet IDs.</p>
|
|
*/
|
|
inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); }
|
|
|
|
/**
|
|
* <p>Token that indicates the start of the next sequential page of results. Use
|
|
* the token that is returned with a previous call to this action. To start at the
|
|
* beginning of the result set, do not specify a value. This parameter is ignored
|
|
* when the request specifies one or a list of fleet IDs.</p>
|
|
*/
|
|
inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); }
|
|
|
|
/**
|
|
* <p>Token that indicates the start of the next sequential page of results. Use
|
|
* the token that is returned with a previous call to this action. To start at the
|
|
* beginning of the result set, do not specify a value. This parameter is ignored
|
|
* when the request specifies one or a list of fleet IDs.</p>
|
|
*/
|
|
inline DescribeFleetAttributesRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;}
|
|
|
|
/**
|
|
* <p>Token that indicates the start of the next sequential page of results. Use
|
|
* the token that is returned with a previous call to this action. To start at the
|
|
* beginning of the result set, do not specify a value. This parameter is ignored
|
|
* when the request specifies one or a list of fleet IDs.</p>
|
|
*/
|
|
inline DescribeFleetAttributesRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>Token that indicates the start of the next sequential page of results. Use
|
|
* the token that is returned with a previous call to this action. To start at the
|
|
* beginning of the result set, do not specify a value. This parameter is ignored
|
|
* when the request specifies one or a list of fleet IDs.</p>
|
|
*/
|
|
inline DescribeFleetAttributesRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;}
|
|
|
|
private:
|
|
|
|
Aws::Vector<Aws::String> m_fleetIds;
|
|
bool m_fleetIdsHasBeenSet;
|
|
|
|
int m_limit;
|
|
bool m_limitHasBeenSet;
|
|
|
|
Aws::String m_nextToken;
|
|
bool m_nextTokenHasBeenSet;
|
|
};
|
|
|
|
} // namespace Model
|
|
} // namespace GameLift
|
|
} // namespace Aws
|