This repository has been archived on 2025-09-14. You can view files and clone it, but cannot push or open issues or pull requests.
Files
pxz-hos-client-cpp-module/support/aws-sdk-cpp-master/aws-cpp-sdk-dax/include/aws/dax/model/DescribeEventsRequest.h

344 lines
13 KiB
C++

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/dax/DAX_EXPORTS.h>
#include <aws/dax/DAXRequest.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <aws/dax/model/SourceType.h>
#include <aws/core/utils/DateTime.h>
#include <utility>
namespace Aws
{
namespace DAX
{
namespace Model
{
/**
*/
class AWS_DAX_API DescribeEventsRequest : public DAXRequest
{
public:
DescribeEventsRequest();
// 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 "DescribeEvents"; }
Aws::String SerializePayload() const override;
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override;
/**
* <p>The identifier of the event source for which events will be returned. If not
* specified, then all sources are included in the response.</p>
*/
inline const Aws::String& GetSourceName() const{ return m_sourceName; }
/**
* <p>The identifier of the event source for which events will be returned. If not
* specified, then all sources are included in the response.</p>
*/
inline bool SourceNameHasBeenSet() const { return m_sourceNameHasBeenSet; }
/**
* <p>The identifier of the event source for which events will be returned. If not
* specified, then all sources are included in the response.</p>
*/
inline void SetSourceName(const Aws::String& value) { m_sourceNameHasBeenSet = true; m_sourceName = value; }
/**
* <p>The identifier of the event source for which events will be returned. If not
* specified, then all sources are included in the response.</p>
*/
inline void SetSourceName(Aws::String&& value) { m_sourceNameHasBeenSet = true; m_sourceName = std::move(value); }
/**
* <p>The identifier of the event source for which events will be returned. If not
* specified, then all sources are included in the response.</p>
*/
inline void SetSourceName(const char* value) { m_sourceNameHasBeenSet = true; m_sourceName.assign(value); }
/**
* <p>The identifier of the event source for which events will be returned. If not
* specified, then all sources are included in the response.</p>
*/
inline DescribeEventsRequest& WithSourceName(const Aws::String& value) { SetSourceName(value); return *this;}
/**
* <p>The identifier of the event source for which events will be returned. If not
* specified, then all sources are included in the response.</p>
*/
inline DescribeEventsRequest& WithSourceName(Aws::String&& value) { SetSourceName(std::move(value)); return *this;}
/**
* <p>The identifier of the event source for which events will be returned. If not
* specified, then all sources are included in the response.</p>
*/
inline DescribeEventsRequest& WithSourceName(const char* value) { SetSourceName(value); return *this;}
/**
* <p>The event source to retrieve events for. If no value is specified, all events
* are returned.</p>
*/
inline const SourceType& GetSourceType() const{ return m_sourceType; }
/**
* <p>The event source to retrieve events for. If no value is specified, all events
* are returned.</p>
*/
inline bool SourceTypeHasBeenSet() const { return m_sourceTypeHasBeenSet; }
/**
* <p>The event source to retrieve events for. If no value is specified, all events
* are returned.</p>
*/
inline void SetSourceType(const SourceType& value) { m_sourceTypeHasBeenSet = true; m_sourceType = value; }
/**
* <p>The event source to retrieve events for. If no value is specified, all events
* are returned.</p>
*/
inline void SetSourceType(SourceType&& value) { m_sourceTypeHasBeenSet = true; m_sourceType = std::move(value); }
/**
* <p>The event source to retrieve events for. If no value is specified, all events
* are returned.</p>
*/
inline DescribeEventsRequest& WithSourceType(const SourceType& value) { SetSourceType(value); return *this;}
/**
* <p>The event source to retrieve events for. If no value is specified, all events
* are returned.</p>
*/
inline DescribeEventsRequest& WithSourceType(SourceType&& value) { SetSourceType(std::move(value)); return *this;}
/**
* <p>The beginning of the time interval to retrieve events for, specified in ISO
* 8601 format.</p>
*/
inline const Aws::Utils::DateTime& GetStartTime() const{ return m_startTime; }
/**
* <p>The beginning of the time interval to retrieve events for, specified in ISO
* 8601 format.</p>
*/
inline bool StartTimeHasBeenSet() const { return m_startTimeHasBeenSet; }
/**
* <p>The beginning of the time interval to retrieve events for, specified in ISO
* 8601 format.</p>
*/
inline void SetStartTime(const Aws::Utils::DateTime& value) { m_startTimeHasBeenSet = true; m_startTime = value; }
/**
* <p>The beginning of the time interval to retrieve events for, specified in ISO
* 8601 format.</p>
*/
inline void SetStartTime(Aws::Utils::DateTime&& value) { m_startTimeHasBeenSet = true; m_startTime = std::move(value); }
/**
* <p>The beginning of the time interval to retrieve events for, specified in ISO
* 8601 format.</p>
*/
inline DescribeEventsRequest& WithStartTime(const Aws::Utils::DateTime& value) { SetStartTime(value); return *this;}
/**
* <p>The beginning of the time interval to retrieve events for, specified in ISO
* 8601 format.</p>
*/
inline DescribeEventsRequest& WithStartTime(Aws::Utils::DateTime&& value) { SetStartTime(std::move(value)); return *this;}
/**
* <p>The end of the time interval for which to retrieve events, specified in ISO
* 8601 format.</p>
*/
inline const Aws::Utils::DateTime& GetEndTime() const{ return m_endTime; }
/**
* <p>The end of the time interval for which to retrieve events, specified in ISO
* 8601 format.</p>
*/
inline bool EndTimeHasBeenSet() const { return m_endTimeHasBeenSet; }
/**
* <p>The end of the time interval for which to retrieve events, specified in ISO
* 8601 format.</p>
*/
inline void SetEndTime(const Aws::Utils::DateTime& value) { m_endTimeHasBeenSet = true; m_endTime = value; }
/**
* <p>The end of the time interval for which to retrieve events, specified in ISO
* 8601 format.</p>
*/
inline void SetEndTime(Aws::Utils::DateTime&& value) { m_endTimeHasBeenSet = true; m_endTime = std::move(value); }
/**
* <p>The end of the time interval for which to retrieve events, specified in ISO
* 8601 format.</p>
*/
inline DescribeEventsRequest& WithEndTime(const Aws::Utils::DateTime& value) { SetEndTime(value); return *this;}
/**
* <p>The end of the time interval for which to retrieve events, specified in ISO
* 8601 format.</p>
*/
inline DescribeEventsRequest& WithEndTime(Aws::Utils::DateTime&& value) { SetEndTime(std::move(value)); return *this;}
/**
* <p>The number of minutes' worth of events to retrieve.</p>
*/
inline int GetDuration() const{ return m_duration; }
/**
* <p>The number of minutes' worth of events to retrieve.</p>
*/
inline bool DurationHasBeenSet() const { return m_durationHasBeenSet; }
/**
* <p>The number of minutes' worth of events to retrieve.</p>
*/
inline void SetDuration(int value) { m_durationHasBeenSet = true; m_duration = value; }
/**
* <p>The number of minutes' worth of events to retrieve.</p>
*/
inline DescribeEventsRequest& WithDuration(int value) { SetDuration(value); return *this;}
/**
* <p>The maximum number of results to include in the response. If more results
* exist than the specified <code>MaxResults</code> value, a token is included in
* the response so that the remaining results can be retrieved.</p> <p>The value
* for <code>MaxResults</code> must be between 20 and 100.</p>
*/
inline int GetMaxResults() const{ return m_maxResults; }
/**
* <p>The maximum number of results to include in the response. If more results
* exist than the specified <code>MaxResults</code> value, a token is included in
* the response so that the remaining results can be retrieved.</p> <p>The value
* for <code>MaxResults</code> must be between 20 and 100.</p>
*/
inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; }
/**
* <p>The maximum number of results to include in the response. If more results
* exist than the specified <code>MaxResults</code> value, a token is included in
* the response so that the remaining results can be retrieved.</p> <p>The value
* for <code>MaxResults</code> must be between 20 and 100.</p>
*/
inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; }
/**
* <p>The maximum number of results to include in the response. If more results
* exist than the specified <code>MaxResults</code> value, a token is included in
* the response so that the remaining results can be retrieved.</p> <p>The value
* for <code>MaxResults</code> must be between 20 and 100.</p>
*/
inline DescribeEventsRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;}
/**
* <p>An optional token returned from a prior request. Use this token for
* pagination of results from this action. If this parameter is specified, the
* response includes only results beyond the token, up to the value specified by
* <code>MaxResults</code>.</p>
*/
inline const Aws::String& GetNextToken() const{ return m_nextToken; }
/**
* <p>An optional token returned from a prior request. Use this token for
* pagination of results from this action. If this parameter is specified, the
* response includes only results beyond the token, up to the value specified by
* <code>MaxResults</code>.</p>
*/
inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; }
/**
* <p>An optional token returned from a prior request. Use this token for
* pagination of results from this action. If this parameter is specified, the
* response includes only results beyond the token, up to the value specified by
* <code>MaxResults</code>.</p>
*/
inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; }
/**
* <p>An optional token returned from a prior request. Use this token for
* pagination of results from this action. If this parameter is specified, the
* response includes only results beyond the token, up to the value specified by
* <code>MaxResults</code>.</p>
*/
inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); }
/**
* <p>An optional token returned from a prior request. Use this token for
* pagination of results from this action. If this parameter is specified, the
* response includes only results beyond the token, up to the value specified by
* <code>MaxResults</code>.</p>
*/
inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); }
/**
* <p>An optional token returned from a prior request. Use this token for
* pagination of results from this action. If this parameter is specified, the
* response includes only results beyond the token, up to the value specified by
* <code>MaxResults</code>.</p>
*/
inline DescribeEventsRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;}
/**
* <p>An optional token returned from a prior request. Use this token for
* pagination of results from this action. If this parameter is specified, the
* response includes only results beyond the token, up to the value specified by
* <code>MaxResults</code>.</p>
*/
inline DescribeEventsRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;}
/**
* <p>An optional token returned from a prior request. Use this token for
* pagination of results from this action. If this parameter is specified, the
* response includes only results beyond the token, up to the value specified by
* <code>MaxResults</code>.</p>
*/
inline DescribeEventsRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;}
private:
Aws::String m_sourceName;
bool m_sourceNameHasBeenSet;
SourceType m_sourceType;
bool m_sourceTypeHasBeenSet;
Aws::Utils::DateTime m_startTime;
bool m_startTimeHasBeenSet;
Aws::Utils::DateTime m_endTime;
bool m_endTimeHasBeenSet;
int m_duration;
bool m_durationHasBeenSet;
int m_maxResults;
bool m_maxResultsHasBeenSet;
Aws::String m_nextToken;
bool m_nextTokenHasBeenSet;
};
} // namespace Model
} // namespace DAX
} // namespace Aws