/** * 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 Redshift { namespace Model { /** *

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

The identifier of the event source for which events will be returned. If this * parameter is not specified, then all sources are included in the response.

Constraints:

If SourceIdentifier is supplied, SourceType * must also be provided.

Specify a cluster identifier when * SourceType is cluster.
Specify a cluster * security group name when SourceType is * cluster-security-group.
Specify a cluster * parameter group name when SourceType is * cluster-parameter-group.
Specify a cluster * snapshot identifier when SourceType is cluster-snapshot.
*

*/ inline const Aws::String& GetSourceIdentifier() const{ return m_sourceIdentifier; } /** *

The identifier of the event source for which events will be returned. If this * parameter is not specified, then all sources are included in the response.

Constraints:

If SourceIdentifier is supplied, SourceType * must also be provided.

Specify a cluster identifier when * SourceType is cluster.
Specify a cluster * security group name when SourceType is * cluster-security-group.
Specify a cluster * parameter group name when SourceType is * cluster-parameter-group.
Specify a cluster * snapshot identifier when SourceType is cluster-snapshot.
*

*/ inline bool SourceIdentifierHasBeenSet() const { return m_sourceIdentifierHasBeenSet; } /** *

The identifier of the event source for which events will be returned. If this * parameter is not specified, then all sources are included in the response.

Constraints:

If SourceIdentifier is supplied, SourceType * must also be provided.

Specify a cluster identifier when * SourceType is cluster.
Specify a cluster * security group name when SourceType is * cluster-security-group.
Specify a cluster * parameter group name when SourceType is * cluster-parameter-group.
Specify a cluster * snapshot identifier when SourceType is cluster-snapshot.
*

*/ inline void SetSourceIdentifier(const Aws::String& value) { m_sourceIdentifierHasBeenSet = true; m_sourceIdentifier = value; } /** *

The identifier of the event source for which events will be returned. If this * parameter is not specified, then all sources are included in the response.

Constraints:

If SourceIdentifier is supplied, SourceType * must also be provided.

Specify a cluster identifier when * SourceType is cluster.
Specify a cluster * security group name when SourceType is * cluster-security-group.
Specify a cluster * parameter group name when SourceType is * cluster-parameter-group.
Specify a cluster * snapshot identifier when SourceType is cluster-snapshot.
*

*/ inline void SetSourceIdentifier(Aws::String&& value) { m_sourceIdentifierHasBeenSet = true; m_sourceIdentifier = std::move(value); } /** *

The identifier of the event source for which events will be returned. If this * parameter is not specified, then all sources are included in the response.

Constraints:

If SourceIdentifier is supplied, SourceType * must also be provided.

Specify a cluster identifier when * SourceType is cluster.
Specify a cluster * security group name when SourceType is * cluster-security-group.
Specify a cluster * parameter group name when SourceType is * cluster-parameter-group.
Specify a cluster * snapshot identifier when SourceType is cluster-snapshot.
*

*/ inline void SetSourceIdentifier(const char* value) { m_sourceIdentifierHasBeenSet = true; m_sourceIdentifier.assign(value); } /** *

The identifier of the event source for which events will be returned. If this * parameter is not specified, then all sources are included in the response.

Constraints:

If SourceIdentifier is supplied, SourceType * must also be provided.

Specify a cluster identifier when * SourceType is cluster.
Specify a cluster * security group name when SourceType is * cluster-security-group.
Specify a cluster * parameter group name when SourceType is * cluster-parameter-group.
Specify a cluster * snapshot identifier when SourceType is cluster-snapshot.
*

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

The identifier of the event source for which events will be returned. If this * parameter is not specified, then all sources are included in the response.

Constraints:

If SourceIdentifier is supplied, SourceType * must also be provided.

Specify a cluster identifier when * SourceType is cluster.
Specify a cluster * security group name when SourceType is * cluster-security-group.
Specify a cluster * parameter group name when SourceType is * cluster-parameter-group.
Specify a cluster * snapshot identifier when SourceType is cluster-snapshot.
*

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

The identifier of the event source for which events will be returned. If this * parameter is not specified, then all sources are included in the response.

Constraints:

If SourceIdentifier is supplied, SourceType * must also be provided.

Specify a cluster identifier when * SourceType is cluster.
Specify a cluster * security group name when SourceType is * cluster-security-group.
Specify a cluster * parameter group name when SourceType is * cluster-parameter-group.
Specify a cluster * snapshot identifier when SourceType is cluster-snapshot.
*

*/ inline DescribeEventsRequest& WithSourceIdentifier(const char* value) { SetSourceIdentifier(value); return *this;} /** *

The event source to retrieve events for. If no value is specified, all events * are returned.

Constraints:

If SourceType is supplied, * SourceIdentifier must also be provided.

Specify * cluster when SourceIdentifier is a cluster identifier.
*
Specify cluster-security-group when * SourceIdentifier is a cluster security group name.
*
Specify cluster-parameter-group when SourceIdentifier is * a cluster parameter group name.
Specify * cluster-snapshot when SourceIdentifier is a cluster snapshot * identifier.

*/ inline const SourceType& GetSourceType() const{ return m_sourceType; } /** *

The event source to retrieve events for. If no value is specified, all events * are returned.

Constraints:

If SourceType is supplied, * SourceIdentifier must also be provided.

Specify * cluster when SourceIdentifier is a cluster identifier.
*
Specify cluster-security-group when * SourceIdentifier is a cluster security group name.
*
Specify cluster-parameter-group when SourceIdentifier is * a cluster parameter group name.
Specify * cluster-snapshot when SourceIdentifier is a cluster snapshot * identifier.

*/ inline bool SourceTypeHasBeenSet() const { return m_sourceTypeHasBeenSet; } /** *

The event source to retrieve events for. If no value is specified, all events * are returned.

Constraints:

If SourceType is supplied, * SourceIdentifier must also be provided.

Specify * cluster when SourceIdentifier is a cluster identifier.
*
Specify cluster-security-group when * SourceIdentifier is a cluster security group name.
*
Specify cluster-parameter-group when SourceIdentifier is * a cluster parameter group name.
Specify * cluster-snapshot when SourceIdentifier is a cluster snapshot * identifier.

*/ inline void SetSourceType(const SourceType& value) { m_sourceTypeHasBeenSet = true; m_sourceType = value; } /** *

The event source to retrieve events for. If no value is specified, all events * are returned.

Constraints:

If SourceType is supplied, * SourceIdentifier must also be provided.

Specify * cluster when SourceIdentifier is a cluster identifier.
*
Specify cluster-security-group when * SourceIdentifier is a cluster security group name.
*
Specify cluster-parameter-group when SourceIdentifier is * a cluster parameter group name.
Specify * cluster-snapshot when SourceIdentifier is a cluster snapshot * identifier.

*/ inline void SetSourceType(SourceType&& value) { m_sourceTypeHasBeenSet = true; m_sourceType = std::move(value); } /** *

The event source to retrieve events for. If no value is specified, all events * are returned.

Constraints:

If SourceType is supplied, * SourceIdentifier must also be provided.

Specify * cluster when SourceIdentifier is a cluster identifier.
*
Specify cluster-security-group when * SourceIdentifier is a cluster security group name.
*
Specify cluster-parameter-group when SourceIdentifier is * a cluster parameter group name.
Specify * cluster-snapshot when SourceIdentifier is a cluster snapshot * identifier.

*/ inline DescribeEventsRequest& WithSourceType(const SourceType& value) { SetSourceType(value); return *this;} /** *

The event source to retrieve events for. If no value is specified, all events * are returned.

Constraints:

If SourceType is supplied, * SourceIdentifier must also be provided.

Specify * cluster when SourceIdentifier is a cluster identifier.
*
Specify cluster-security-group when * SourceIdentifier is a cluster security group name.
*
Specify cluster-parameter-group when SourceIdentifier is * a cluster parameter group name.
Specify * cluster-snapshot when SourceIdentifier is a cluster snapshot * identifier.

*/ inline DescribeEventsRequest& WithSourceType(SourceType&& value) { SetSourceType(std::move(value)); return *this;} /** *

The beginning of the time interval to retrieve events for, specified in ISO * 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

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

The beginning of the time interval to retrieve events for, specified in ISO * 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

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

The beginning of the time interval to retrieve events for, specified in ISO * 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

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

The beginning of the time interval to retrieve events for, specified in ISO * 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

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

The beginning of the time interval to retrieve events for, specified in ISO * 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

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

The beginning of the time interval to retrieve events for, specified in ISO * 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

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

The end of the time interval for which to retrieve events, specified in ISO * 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

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

The end of the time interval for which to retrieve events, specified in ISO * 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

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

The end of the time interval for which to retrieve events, specified in ISO * 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

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

The end of the time interval for which to retrieve events, specified in ISO * 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

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

The end of the time interval for which to retrieve events, specified in ISO * 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

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

The end of the time interval for which to retrieve events, specified in ISO * 8601 format. For more information about ISO 8601, go to the ISO8601 Wikipedia page.

Example: 2009-07-08T18:00Z

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

The number of minutes prior to the time of the request for which to retrieve * events. For example, if the request is sent at 18:00 and you specify a duration * of 60, then only events which have occurred after 17:00 will be returned.

Default: 60

*/ inline int GetDuration() const{ return m_duration; } /** *

Default: 60

*/ inline bool DurationHasBeenSet() const { return m_durationHasBeenSet; } /** *

Default: 60

*/ inline void SetDuration(int value) { m_durationHasBeenSet = true; m_duration = value; } /** *

Default: 60

*/ inline DescribeEventsRequest& WithDuration(int value) { SetDuration(value); return *this;} /** *

The maximum number of response records to return in each call. If the number * of remaining response records exceeds the specified MaxRecords * value, a value is returned in a marker field of the response. You * can retrieve the next set of records by retrying the command with the returned * marker value.

Default: 100

Constraints: minimum 20, * maximum 100.

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

Default: 100

Constraints: minimum 20, * maximum 100.

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

Default: 100

Constraints: minimum 20, * maximum 100.

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

Default: 100

Constraints: minimum 20, * maximum 100.

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

An optional parameter that specifies the starting point to return a set of * response records. When the results of a DescribeEvents request exceed the * value specified in MaxRecords, Amazon Web Services returns a value * in the Marker field of the response. You can retrieve the next set * of response records by providing the returned marker value in the * Marker parameter and retrying the request.

*/ inline const Aws::String& GetMarker() const{ return m_marker; } /** *

*/ inline bool MarkerHasBeenSet() const { return m_markerHasBeenSet; } /** *

*/ inline void SetMarker(const Aws::String& value) { m_markerHasBeenSet = true; m_marker = value; } /** *

*/ inline void SetMarker(Aws::String&& value) { m_markerHasBeenSet = true; m_marker = std::move(value); } /** *

*/ inline void SetMarker(const char* value) { m_markerHasBeenSet = true; m_marker.assign(value); } /** *

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

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

*/ inline DescribeEventsRequest& WithMarker(const char* value) { SetMarker(value); return *this;} private: Aws::String m_sourceIdentifier; bool m_sourceIdentifierHasBeenSet = false; SourceType m_sourceType; bool m_sourceTypeHasBeenSet = false; Aws::Utils::DateTime m_startTime; bool m_startTimeHasBeenSet = false; Aws::Utils::DateTime m_endTime; bool m_endTimeHasBeenSet = false; int m_duration; bool m_durationHasBeenSet = false; int m_maxRecords; bool m_maxRecordsHasBeenSet = false; Aws::String m_marker; bool m_markerHasBeenSet = false; }; } // namespace Model } // namespace Redshift } // namespace Aws

See Also: