/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include namespace Aws { namespace XRay { namespace Model { /** */ class GetTraceSummariesRequest : public XRayRequest { public: AWS_XRAY_API GetTraceSummariesRequest(); // 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 "GetTraceSummaries"; } AWS_XRAY_API Aws::String SerializePayload() const override; /** *

The start of the time frame for which to retrieve traces.

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

The start of the time frame for which to retrieve traces.

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

The start of the time frame for which to retrieve traces.

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

The start of the time frame for which to retrieve traces.

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

The start of the time frame for which to retrieve traces.

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

The start of the time frame for which to retrieve traces.

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

The end of the time frame for which to retrieve traces.

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

The end of the time frame for which to retrieve traces.

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

The end of the time frame for which to retrieve traces.

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

The end of the time frame for which to retrieve traces.

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

The end of the time frame for which to retrieve traces.

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

The end of the time frame for which to retrieve traces.

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

A parameter to indicate whether to query trace summaries by TraceId or Event * time.

*/ inline const TimeRangeType& GetTimeRangeType() const{ return m_timeRangeType; } /** *

A parameter to indicate whether to query trace summaries by TraceId or Event * time.

*/ inline bool TimeRangeTypeHasBeenSet() const { return m_timeRangeTypeHasBeenSet; } /** *

A parameter to indicate whether to query trace summaries by TraceId or Event * time.

*/ inline void SetTimeRangeType(const TimeRangeType& value) { m_timeRangeTypeHasBeenSet = true; m_timeRangeType = value; } /** *

A parameter to indicate whether to query trace summaries by TraceId or Event * time.

*/ inline void SetTimeRangeType(TimeRangeType&& value) { m_timeRangeTypeHasBeenSet = true; m_timeRangeType = std::move(value); } /** *

A parameter to indicate whether to query trace summaries by TraceId or Event * time.

*/ inline GetTraceSummariesRequest& WithTimeRangeType(const TimeRangeType& value) { SetTimeRangeType(value); return *this;} /** *

A parameter to indicate whether to query trace summaries by TraceId or Event * time.

*/ inline GetTraceSummariesRequest& WithTimeRangeType(TimeRangeType&& value) { SetTimeRangeType(std::move(value)); return *this;} /** *

Set to true to get summaries for only a subset of available * traces.

*/ inline bool GetSampling() const{ return m_sampling; } /** *

Set to true to get summaries for only a subset of available * traces.

*/ inline bool SamplingHasBeenSet() const { return m_samplingHasBeenSet; } /** *

Set to true to get summaries for only a subset of available * traces.

*/ inline void SetSampling(bool value) { m_samplingHasBeenSet = true; m_sampling = value; } /** *

Set to true to get summaries for only a subset of available * traces.

*/ inline GetTraceSummariesRequest& WithSampling(bool value) { SetSampling(value); return *this;} /** *

A parameter to indicate whether to enable sampling on trace summaries. Input * parameters are Name and Value.

*/ inline const SamplingStrategy& GetSamplingStrategy() const{ return m_samplingStrategy; } /** *

A parameter to indicate whether to enable sampling on trace summaries. Input * parameters are Name and Value.

*/ inline bool SamplingStrategyHasBeenSet() const { return m_samplingStrategyHasBeenSet; } /** *

A parameter to indicate whether to enable sampling on trace summaries. Input * parameters are Name and Value.

*/ inline void SetSamplingStrategy(const SamplingStrategy& value) { m_samplingStrategyHasBeenSet = true; m_samplingStrategy = value; } /** *

A parameter to indicate whether to enable sampling on trace summaries. Input * parameters are Name and Value.

*/ inline void SetSamplingStrategy(SamplingStrategy&& value) { m_samplingStrategyHasBeenSet = true; m_samplingStrategy = std::move(value); } /** *

A parameter to indicate whether to enable sampling on trace summaries. Input * parameters are Name and Value.

*/ inline GetTraceSummariesRequest& WithSamplingStrategy(const SamplingStrategy& value) { SetSamplingStrategy(value); return *this;} /** *

A parameter to indicate whether to enable sampling on trace summaries. Input * parameters are Name and Value.

*/ inline GetTraceSummariesRequest& WithSamplingStrategy(SamplingStrategy&& value) { SetSamplingStrategy(std::move(value)); return *this;} /** *

Specify a filter expression to retrieve trace summaries for services or * requests that meet certain requirements.

*/ inline const Aws::String& GetFilterExpression() const{ return m_filterExpression; } /** *

Specify a filter expression to retrieve trace summaries for services or * requests that meet certain requirements.

*/ inline bool FilterExpressionHasBeenSet() const { return m_filterExpressionHasBeenSet; } /** *

Specify a filter expression to retrieve trace summaries for services or * requests that meet certain requirements.

*/ inline void SetFilterExpression(const Aws::String& value) { m_filterExpressionHasBeenSet = true; m_filterExpression = value; } /** *

Specify a filter expression to retrieve trace summaries for services or * requests that meet certain requirements.

*/ inline void SetFilterExpression(Aws::String&& value) { m_filterExpressionHasBeenSet = true; m_filterExpression = std::move(value); } /** *

Specify a filter expression to retrieve trace summaries for services or * requests that meet certain requirements.

*/ inline void SetFilterExpression(const char* value) { m_filterExpressionHasBeenSet = true; m_filterExpression.assign(value); } /** *

Specify a filter expression to retrieve trace summaries for services or * requests that meet certain requirements.

*/ inline GetTraceSummariesRequest& WithFilterExpression(const Aws::String& value) { SetFilterExpression(value); return *this;} /** *

Specify a filter expression to retrieve trace summaries for services or * requests that meet certain requirements.

*/ inline GetTraceSummariesRequest& WithFilterExpression(Aws::String&& value) { SetFilterExpression(std::move(value)); return *this;} /** *

Specify a filter expression to retrieve trace summaries for services or * requests that meet certain requirements.

*/ inline GetTraceSummariesRequest& WithFilterExpression(const char* value) { SetFilterExpression(value); return *this;} /** *

Specify the pagination token returned by a previous request to retrieve the * next page of results.

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

Specify the pagination token returned by a previous request to retrieve the * next page of results.

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

Specify the pagination token returned by a previous request to retrieve the * next page of results.

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

Specify the pagination token returned by a previous request to retrieve the * next page of results.

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

Specify the pagination token returned by a previous request to retrieve the * next page of results.

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

Specify the pagination token returned by a previous request to retrieve the * next page of results.

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

Specify the pagination token returned by a previous request to retrieve the * next page of results.

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

Specify the pagination token returned by a previous request to retrieve the * next page of results.

*/ inline GetTraceSummariesRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} private: Aws::Utils::DateTime m_startTime; bool m_startTimeHasBeenSet = false; Aws::Utils::DateTime m_endTime; bool m_endTimeHasBeenSet = false; TimeRangeType m_timeRangeType; bool m_timeRangeTypeHasBeenSet = false; bool m_sampling; bool m_samplingHasBeenSet = false; SamplingStrategy m_samplingStrategy; bool m_samplingStrategyHasBeenSet = false; Aws::String m_filterExpression; bool m_filterExpressionHasBeenSet = false; Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; }; } // namespace Model } // namespace XRay } // namespace Aws