129 lines
6.0 KiB
C++
129 lines
6.0 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/AWSString.h>
|
|
#include <utility>
|
|
|
|
namespace Aws
|
|
{
|
|
namespace GameLift
|
|
{
|
|
namespace Model
|
|
{
|
|
|
|
/**
|
|
*/
|
|
class DescribeInstancesRequest : public GameLiftRequest
|
|
{
|
|
public:
|
|
AWS_GAMELIFT_API DescribeInstancesRequest();
|
|
|
|
// 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 "DescribeInstances"; }
|
|
|
|
AWS_GAMELIFT_API Aws::String SerializePayload() const override;
|
|
|
|
AWS_GAMELIFT_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override;
|
|
|
|
|
|
///@{
|
|
/**
|
|
* <p>A unique identifier for the fleet to retrieve instance information for. You
|
|
* can use either the fleet ID or ARN value.</p>
|
|
*/
|
|
inline const Aws::String& GetFleetId() const{ return m_fleetId; }
|
|
inline bool FleetIdHasBeenSet() const { return m_fleetIdHasBeenSet; }
|
|
inline void SetFleetId(const Aws::String& value) { m_fleetIdHasBeenSet = true; m_fleetId = value; }
|
|
inline void SetFleetId(Aws::String&& value) { m_fleetIdHasBeenSet = true; m_fleetId = std::move(value); }
|
|
inline void SetFleetId(const char* value) { m_fleetIdHasBeenSet = true; m_fleetId.assign(value); }
|
|
inline DescribeInstancesRequest& WithFleetId(const Aws::String& value) { SetFleetId(value); return *this;}
|
|
inline DescribeInstancesRequest& WithFleetId(Aws::String&& value) { SetFleetId(std::move(value)); return *this;}
|
|
inline DescribeInstancesRequest& WithFleetId(const char* value) { SetFleetId(value); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>A unique identifier for an instance to retrieve. Specify an instance ID or
|
|
* leave blank to retrieve all instances in the fleet.</p>
|
|
*/
|
|
inline const Aws::String& GetInstanceId() const{ return m_instanceId; }
|
|
inline bool InstanceIdHasBeenSet() const { return m_instanceIdHasBeenSet; }
|
|
inline void SetInstanceId(const Aws::String& value) { m_instanceIdHasBeenSet = true; m_instanceId = value; }
|
|
inline void SetInstanceId(Aws::String&& value) { m_instanceIdHasBeenSet = true; m_instanceId = std::move(value); }
|
|
inline void SetInstanceId(const char* value) { m_instanceIdHasBeenSet = true; m_instanceId.assign(value); }
|
|
inline DescribeInstancesRequest& WithInstanceId(const Aws::String& value) { SetInstanceId(value); return *this;}
|
|
inline DescribeInstancesRequest& WithInstanceId(Aws::String&& value) { SetInstanceId(std::move(value)); return *this;}
|
|
inline DescribeInstancesRequest& WithInstanceId(const char* value) { SetInstanceId(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.</p>
|
|
*/
|
|
inline int GetLimit() const{ return m_limit; }
|
|
inline bool LimitHasBeenSet() const { return m_limitHasBeenSet; }
|
|
inline void SetLimit(int value) { m_limitHasBeenSet = true; m_limit = value; }
|
|
inline DescribeInstancesRequest& WithLimit(int value) { SetLimit(value); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>A token that indicates the start of the next sequential page of results. Use
|
|
* the token that is returned with a previous call to this operation. To start at
|
|
* the beginning of the result set, do not specify a value.</p>
|
|
*/
|
|
inline const Aws::String& GetNextToken() const{ return m_nextToken; }
|
|
inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; }
|
|
inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; }
|
|
inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); }
|
|
inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); }
|
|
inline DescribeInstancesRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;}
|
|
inline DescribeInstancesRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;}
|
|
inline DescribeInstancesRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;}
|
|
///@}
|
|
|
|
///@{
|
|
/**
|
|
* <p>The name of a location to retrieve instance information for, in the form of
|
|
* an Amazon Web Services Region code such as <code>us-west-2</code>. </p>
|
|
*/
|
|
inline const Aws::String& GetLocation() const{ return m_location; }
|
|
inline bool LocationHasBeenSet() const { return m_locationHasBeenSet; }
|
|
inline void SetLocation(const Aws::String& value) { m_locationHasBeenSet = true; m_location = value; }
|
|
inline void SetLocation(Aws::String&& value) { m_locationHasBeenSet = true; m_location = std::move(value); }
|
|
inline void SetLocation(const char* value) { m_locationHasBeenSet = true; m_location.assign(value); }
|
|
inline DescribeInstancesRequest& WithLocation(const Aws::String& value) { SetLocation(value); return *this;}
|
|
inline DescribeInstancesRequest& WithLocation(Aws::String&& value) { SetLocation(std::move(value)); return *this;}
|
|
inline DescribeInstancesRequest& WithLocation(const char* value) { SetLocation(value); return *this;}
|
|
///@}
|
|
private:
|
|
|
|
Aws::String m_fleetId;
|
|
bool m_fleetIdHasBeenSet = false;
|
|
|
|
Aws::String m_instanceId;
|
|
bool m_instanceIdHasBeenSet = false;
|
|
|
|
int m_limit;
|
|
bool m_limitHasBeenSet = false;
|
|
|
|
Aws::String m_nextToken;
|
|
bool m_nextTokenHasBeenSet = false;
|
|
|
|
Aws::String m_location;
|
|
bool m_locationHasBeenSet = false;
|
|
};
|
|
|
|
} // namespace Model
|
|
} // namespace GameLift
|
|
} // namespace Aws
|