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

Request to retrieve a list of events for an environment.

See * Also:

AWS * API Reference

*/ class DescribeEventsRequest : public ElasticBeanstalkRequest { public: AWS_ELASTICBEANSTALK_API 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_ELASTICBEANSTALK_API Aws::String SerializePayload() const override; protected: AWS_ELASTICBEANSTALK_API void DumpBodyToUrl(Aws::Http::URI& uri ) const override; public: /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * include only those associated with this application.

*/ inline const Aws::String& GetApplicationName() const{ return m_applicationName; } /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * include only those associated with this application.

*/ inline bool ApplicationNameHasBeenSet() const { return m_applicationNameHasBeenSet; } /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * include only those associated with this application.

*/ inline void SetApplicationName(const Aws::String& value) { m_applicationNameHasBeenSet = true; m_applicationName = value; } /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * include only those associated with this application.

*/ inline void SetApplicationName(Aws::String&& value) { m_applicationNameHasBeenSet = true; m_applicationName = std::move(value); } /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * include only those associated with this application.

*/ inline void SetApplicationName(const char* value) { m_applicationNameHasBeenSet = true; m_applicationName.assign(value); } /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * include only those associated with this application.

*/ inline DescribeEventsRequest& WithApplicationName(const Aws::String& value) { SetApplicationName(value); return *this;} /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * include only those associated with this application.

*/ inline DescribeEventsRequest& WithApplicationName(Aws::String&& value) { SetApplicationName(std::move(value)); return *this;} /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * include only those associated with this application.

*/ inline DescribeEventsRequest& WithApplicationName(const char* value) { SetApplicationName(value); return *this;} /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * those associated with this application version.

*/ inline const Aws::String& GetVersionLabel() const{ return m_versionLabel; } /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * those associated with this application version.

*/ inline bool VersionLabelHasBeenSet() const { return m_versionLabelHasBeenSet; } /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * those associated with this application version.

*/ inline void SetVersionLabel(const Aws::String& value) { m_versionLabelHasBeenSet = true; m_versionLabel = value; } /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * those associated with this application version.

*/ inline void SetVersionLabel(Aws::String&& value) { m_versionLabelHasBeenSet = true; m_versionLabel = std::move(value); } /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * those associated with this application version.

*/ inline void SetVersionLabel(const char* value) { m_versionLabelHasBeenSet = true; m_versionLabel.assign(value); } /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * those associated with this application version.

*/ inline DescribeEventsRequest& WithVersionLabel(const Aws::String& value) { SetVersionLabel(value); return *this;} /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * those associated with this application version.

*/ inline DescribeEventsRequest& WithVersionLabel(Aws::String&& value) { SetVersionLabel(std::move(value)); return *this;} /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * those associated with this application version.

*/ inline DescribeEventsRequest& WithVersionLabel(const char* value) { SetVersionLabel(value); return *this;} /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * those that are associated with this environment configuration.

*/ inline const Aws::String& GetTemplateName() const{ return m_templateName; } /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * those that are associated with this environment configuration.

*/ inline bool TemplateNameHasBeenSet() const { return m_templateNameHasBeenSet; } /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * those that are associated with this environment configuration.

*/ inline void SetTemplateName(const Aws::String& value) { m_templateNameHasBeenSet = true; m_templateName = value; } /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * those that are associated with this environment configuration.

*/ inline void SetTemplateName(Aws::String&& value) { m_templateNameHasBeenSet = true; m_templateName = std::move(value); } /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * those that are associated with this environment configuration.

*/ inline void SetTemplateName(const char* value) { m_templateNameHasBeenSet = true; m_templateName.assign(value); } /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * those that are associated with this environment configuration.

*/ inline DescribeEventsRequest& WithTemplateName(const Aws::String& value) { SetTemplateName(value); return *this;} /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * those that are associated with this environment configuration.

*/ inline DescribeEventsRequest& WithTemplateName(Aws::String&& value) { SetTemplateName(std::move(value)); return *this;} /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * those that are associated with this environment configuration.

*/ inline DescribeEventsRequest& WithTemplateName(const char* value) { SetTemplateName(value); return *this;} /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * those associated with this environment.

*/ inline const Aws::String& GetEnvironmentId() const{ return m_environmentId; } /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * those associated with this environment.

*/ inline bool EnvironmentIdHasBeenSet() const { return m_environmentIdHasBeenSet; } /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * those associated with this environment.

*/ inline void SetEnvironmentId(const Aws::String& value) { m_environmentIdHasBeenSet = true; m_environmentId = value; } /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * those associated with this environment.

*/ inline void SetEnvironmentId(Aws::String&& value) { m_environmentIdHasBeenSet = true; m_environmentId = std::move(value); } /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * those associated with this environment.

*/ inline void SetEnvironmentId(const char* value) { m_environmentIdHasBeenSet = true; m_environmentId.assign(value); } /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * those associated with this environment.

*/ inline DescribeEventsRequest& WithEnvironmentId(const Aws::String& value) { SetEnvironmentId(value); return *this;} /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * those associated with this environment.

*/ inline DescribeEventsRequest& WithEnvironmentId(Aws::String&& value) { SetEnvironmentId(std::move(value)); return *this;} /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * those associated with this environment.

*/ inline DescribeEventsRequest& WithEnvironmentId(const char* value) { SetEnvironmentId(value); return *this;} /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * those associated with this environment.

*/ inline const Aws::String& GetEnvironmentName() const{ return m_environmentName; } /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * those associated with this environment.

*/ inline bool EnvironmentNameHasBeenSet() const { return m_environmentNameHasBeenSet; } /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * those associated with this environment.

*/ inline void SetEnvironmentName(const Aws::String& value) { m_environmentNameHasBeenSet = true; m_environmentName = value; } /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * those associated with this environment.

*/ inline void SetEnvironmentName(Aws::String&& value) { m_environmentNameHasBeenSet = true; m_environmentName = std::move(value); } /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * those associated with this environment.

*/ inline void SetEnvironmentName(const char* value) { m_environmentNameHasBeenSet = true; m_environmentName.assign(value); } /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * those associated with this environment.

*/ inline DescribeEventsRequest& WithEnvironmentName(const Aws::String& value) { SetEnvironmentName(value); return *this;} /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * those associated with this environment.

*/ inline DescribeEventsRequest& WithEnvironmentName(Aws::String&& value) { SetEnvironmentName(std::move(value)); return *this;} /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * those associated with this environment.

*/ inline DescribeEventsRequest& WithEnvironmentName(const char* value) { SetEnvironmentName(value); return *this;} /** *

The ARN of a custom platform version. If specified, AWS Elastic Beanstalk * restricts the returned descriptions to those associated with this custom * platform version.

*/ inline const Aws::String& GetPlatformArn() const{ return m_platformArn; } /** *

The ARN of a custom platform version. If specified, AWS Elastic Beanstalk * restricts the returned descriptions to those associated with this custom * platform version.

*/ inline bool PlatformArnHasBeenSet() const { return m_platformArnHasBeenSet; } /** *

The ARN of a custom platform version. If specified, AWS Elastic Beanstalk * restricts the returned descriptions to those associated with this custom * platform version.

*/ inline void SetPlatformArn(const Aws::String& value) { m_platformArnHasBeenSet = true; m_platformArn = value; } /** *

The ARN of a custom platform version. If specified, AWS Elastic Beanstalk * restricts the returned descriptions to those associated with this custom * platform version.

*/ inline void SetPlatformArn(Aws::String&& value) { m_platformArnHasBeenSet = true; m_platformArn = std::move(value); } /** *

The ARN of a custom platform version. If specified, AWS Elastic Beanstalk * restricts the returned descriptions to those associated with this custom * platform version.

*/ inline void SetPlatformArn(const char* value) { m_platformArnHasBeenSet = true; m_platformArn.assign(value); } /** *

The ARN of a custom platform version. If specified, AWS Elastic Beanstalk * restricts the returned descriptions to those associated with this custom * platform version.

*/ inline DescribeEventsRequest& WithPlatformArn(const Aws::String& value) { SetPlatformArn(value); return *this;} /** *

The ARN of a custom platform version. If specified, AWS Elastic Beanstalk * restricts the returned descriptions to those associated with this custom * platform version.

*/ inline DescribeEventsRequest& WithPlatformArn(Aws::String&& value) { SetPlatformArn(std::move(value)); return *this;} /** *

The ARN of a custom platform version. If specified, AWS Elastic Beanstalk * restricts the returned descriptions to those associated with this custom * platform version.

*/ inline DescribeEventsRequest& WithPlatformArn(const char* value) { SetPlatformArn(value); return *this;} /** *

If specified, AWS Elastic Beanstalk restricts the described events to include * only those associated with this request ID.

*/ inline const Aws::String& GetRequestId() const{ return m_requestId; } /** *

If specified, AWS Elastic Beanstalk restricts the described events to include * only those associated with this request ID.

*/ inline bool RequestIdHasBeenSet() const { return m_requestIdHasBeenSet; } /** *

If specified, AWS Elastic Beanstalk restricts the described events to include * only those associated with this request ID.

*/ inline void SetRequestId(const Aws::String& value) { m_requestIdHasBeenSet = true; m_requestId = value; } /** *

If specified, AWS Elastic Beanstalk restricts the described events to include * only those associated with this request ID.

*/ inline void SetRequestId(Aws::String&& value) { m_requestIdHasBeenSet = true; m_requestId = std::move(value); } /** *

If specified, AWS Elastic Beanstalk restricts the described events to include * only those associated with this request ID.

*/ inline void SetRequestId(const char* value) { m_requestIdHasBeenSet = true; m_requestId.assign(value); } /** *

If specified, AWS Elastic Beanstalk restricts the described events to include * only those associated with this request ID.

*/ inline DescribeEventsRequest& WithRequestId(const Aws::String& value) { SetRequestId(value); return *this;} /** *

If specified, AWS Elastic Beanstalk restricts the described events to include * only those associated with this request ID.

*/ inline DescribeEventsRequest& WithRequestId(Aws::String&& value) { SetRequestId(std::move(value)); return *this;} /** *

If specified, AWS Elastic Beanstalk restricts the described events to include * only those associated with this request ID.

*/ inline DescribeEventsRequest& WithRequestId(const char* value) { SetRequestId(value); return *this;} /** *

If specified, limits the events returned from this call to include only those * with the specified severity or higher.

*/ inline const EventSeverity& GetSeverity() const{ return m_severity; } /** *

If specified, limits the events returned from this call to include only those * with the specified severity or higher.

*/ inline bool SeverityHasBeenSet() const { return m_severityHasBeenSet; } /** *

If specified, limits the events returned from this call to include only those * with the specified severity or higher.

*/ inline void SetSeverity(const EventSeverity& value) { m_severityHasBeenSet = true; m_severity = value; } /** *

If specified, limits the events returned from this call to include only those * with the specified severity or higher.

*/ inline void SetSeverity(EventSeverity&& value) { m_severityHasBeenSet = true; m_severity = std::move(value); } /** *

If specified, limits the events returned from this call to include only those * with the specified severity or higher.

*/ inline DescribeEventsRequest& WithSeverity(const EventSeverity& value) { SetSeverity(value); return *this;} /** *

If specified, limits the events returned from this call to include only those * with the specified severity or higher.

*/ inline DescribeEventsRequest& WithSeverity(EventSeverity&& value) { SetSeverity(std::move(value)); return *this;} /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * those that occur on or after this time.

*/ inline const Aws::Utils::DateTime& GetStartTime() const{ return m_startTime; } /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * those that occur on or after this time.

*/ inline bool StartTimeHasBeenSet() const { return m_startTimeHasBeenSet; } /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * those that occur on or after this time.

*/ inline void SetStartTime(const Aws::Utils::DateTime& value) { m_startTimeHasBeenSet = true; m_startTime = value; } /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * those that occur on or after this time.

*/ inline void SetStartTime(Aws::Utils::DateTime&& value) { m_startTimeHasBeenSet = true; m_startTime = std::move(value); } /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * those that occur on or after this time.

*/ inline DescribeEventsRequest& WithStartTime(const Aws::Utils::DateTime& value) { SetStartTime(value); return *this;} /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * those that occur on or after this time.

*/ inline DescribeEventsRequest& WithStartTime(Aws::Utils::DateTime&& value) { SetStartTime(std::move(value)); return *this;} /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * those that occur up to, but not including, the EndTime.

*/ inline const Aws::Utils::DateTime& GetEndTime() const{ return m_endTime; } /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * those that occur up to, but not including, the EndTime.

*/ inline bool EndTimeHasBeenSet() const { return m_endTimeHasBeenSet; } /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * those that occur up to, but not including, the EndTime.

*/ inline void SetEndTime(const Aws::Utils::DateTime& value) { m_endTimeHasBeenSet = true; m_endTime = value; } /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * those that occur up to, but not including, the EndTime.

*/ inline void SetEndTime(Aws::Utils::DateTime&& value) { m_endTimeHasBeenSet = true; m_endTime = std::move(value); } /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * those that occur up to, but not including, the EndTime.

*/ inline DescribeEventsRequest& WithEndTime(const Aws::Utils::DateTime& value) { SetEndTime(value); return *this;} /** *

If specified, AWS Elastic Beanstalk restricts the returned descriptions to * those that occur up to, but not including, the EndTime.

*/ inline DescribeEventsRequest& WithEndTime(Aws::Utils::DateTime&& value) { SetEndTime(std::move(value)); return *this;} /** *

Specifies the maximum number of events that can be returned, beginning with * the most recent event.

*/ inline int GetMaxRecords() const{ return m_maxRecords; } /** *

Specifies the maximum number of events that can be returned, beginning with * the most recent event.

*/ inline bool MaxRecordsHasBeenSet() const { return m_maxRecordsHasBeenSet; } /** *

Specifies the maximum number of events that can be returned, beginning with * the most recent event.

*/ inline void SetMaxRecords(int value) { m_maxRecordsHasBeenSet = true; m_maxRecords = value; } /** *

Specifies the maximum number of events that can be returned, beginning with * the most recent event.

*/ inline DescribeEventsRequest& WithMaxRecords(int value) { SetMaxRecords(value); return *this;} /** *

Pagination token. If specified, the events return the next batch of * results.

*/ inline const Aws::String& GetNextToken() const{ return m_nextToken; } /** *

Pagination token. If specified, the events return the next batch of * results.

*/ inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } /** *

Pagination token. If specified, the events return the next batch of * results.

*/ inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; } /** *

Pagination token. If specified, the events return the next batch of * results.

*/ inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); } /** *

Pagination token. If specified, the events return the next batch of * results.

*/ inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); } /** *

Pagination token. If specified, the events return the next batch of * results.

*/ inline DescribeEventsRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} /** *

Pagination token. If specified, the events return the next batch of * results.

*/ inline DescribeEventsRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} /** *

Pagination token. If specified, the events return the next batch of * results.

*/ inline DescribeEventsRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} private: Aws::String m_applicationName; bool m_applicationNameHasBeenSet = false; Aws::String m_versionLabel; bool m_versionLabelHasBeenSet = false; Aws::String m_templateName; bool m_templateNameHasBeenSet = false; Aws::String m_environmentId; bool m_environmentIdHasBeenSet = false; Aws::String m_environmentName; bool m_environmentNameHasBeenSet = false; Aws::String m_platformArn; bool m_platformArnHasBeenSet = false; Aws::String m_requestId; bool m_requestIdHasBeenSet = false; EventSeverity m_severity; bool m_severityHasBeenSet = false; Aws::Utils::DateTime m_startTime; bool m_startTimeHasBeenSet = false; Aws::Utils::DateTime m_endTime; bool m_endTimeHasBeenSet = false; int m_maxRecords; bool m_maxRecordsHasBeenSet = false; Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; }; } // namespace Model } // namespace ElasticBeanstalk } // namespace Aws