/** * 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 CodeBuild { namespace Model { /** */ class DescribeCodeCoveragesRequest : public CodeBuildRequest { public: AWS_CODEBUILD_API DescribeCodeCoveragesRequest(); // 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 "DescribeCodeCoverages"; } AWS_CODEBUILD_API Aws::String SerializePayload() const override; AWS_CODEBUILD_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

The ARN of the report for which test cases are returned.

*/ inline const Aws::String& GetReportArn() const{ return m_reportArn; } /** *

The ARN of the report for which test cases are returned.

*/ inline bool ReportArnHasBeenSet() const { return m_reportArnHasBeenSet; } /** *

The ARN of the report for which test cases are returned.

*/ inline void SetReportArn(const Aws::String& value) { m_reportArnHasBeenSet = true; m_reportArn = value; } /** *

The ARN of the report for which test cases are returned.

*/ inline void SetReportArn(Aws::String&& value) { m_reportArnHasBeenSet = true; m_reportArn = std::move(value); } /** *

The ARN of the report for which test cases are returned.

*/ inline void SetReportArn(const char* value) { m_reportArnHasBeenSet = true; m_reportArn.assign(value); } /** *

The ARN of the report for which test cases are returned.

*/ inline DescribeCodeCoveragesRequest& WithReportArn(const Aws::String& value) { SetReportArn(value); return *this;} /** *

The ARN of the report for which test cases are returned.

*/ inline DescribeCodeCoveragesRequest& WithReportArn(Aws::String&& value) { SetReportArn(std::move(value)); return *this;} /** *

The ARN of the report for which test cases are returned.

*/ inline DescribeCodeCoveragesRequest& WithReportArn(const char* value) { SetReportArn(value); return *this;} /** *

The nextToken value returned from a previous call to * DescribeCodeCoverages. This specifies the next item to return. To * return the beginning of the list, exclude this parameter.

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

The nextToken value returned from a previous call to * DescribeCodeCoverages. This specifies the next item to return. To * return the beginning of the list, exclude this parameter.

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

The nextToken value returned from a previous call to * DescribeCodeCoverages. This specifies the next item to return. To * return the beginning of the list, exclude this parameter.

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

The nextToken value returned from a previous call to * DescribeCodeCoverages. This specifies the next item to return. To * return the beginning of the list, exclude this parameter.

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

The nextToken value returned from a previous call to * DescribeCodeCoverages. This specifies the next item to return. To * return the beginning of the list, exclude this parameter.

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

The nextToken value returned from a previous call to * DescribeCodeCoverages. This specifies the next item to return. To * return the beginning of the list, exclude this parameter.

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

The nextToken value returned from a previous call to * DescribeCodeCoverages. This specifies the next item to return. To * return the beginning of the list, exclude this parameter.

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

The nextToken value returned from a previous call to * DescribeCodeCoverages. This specifies the next item to return. To * return the beginning of the list, exclude this parameter.

*/ inline DescribeCodeCoveragesRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} /** *

The maximum number of results to return.

*/ inline int GetMaxResults() const{ return m_maxResults; } /** *

The maximum number of results to return.

*/ inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; } /** *

The maximum number of results to return.

*/ inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; } /** *

The maximum number of results to return.

*/ inline DescribeCodeCoveragesRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;} /** *

Specifies if the results are sorted in ascending or descending order.

*/ inline const SortOrderType& GetSortOrder() const{ return m_sortOrder; } /** *

Specifies if the results are sorted in ascending or descending order.

*/ inline bool SortOrderHasBeenSet() const { return m_sortOrderHasBeenSet; } /** *

Specifies if the results are sorted in ascending or descending order.

*/ inline void SetSortOrder(const SortOrderType& value) { m_sortOrderHasBeenSet = true; m_sortOrder = value; } /** *

Specifies if the results are sorted in ascending or descending order.

*/ inline void SetSortOrder(SortOrderType&& value) { m_sortOrderHasBeenSet = true; m_sortOrder = std::move(value); } /** *

Specifies if the results are sorted in ascending or descending order.

*/ inline DescribeCodeCoveragesRequest& WithSortOrder(const SortOrderType& value) { SetSortOrder(value); return *this;} /** *

Specifies if the results are sorted in ascending or descending order.

*/ inline DescribeCodeCoveragesRequest& WithSortOrder(SortOrderType&& value) { SetSortOrder(std::move(value)); return *this;} /** *

Specifies how the results are sorted. Possible values are:

*
FILE_PATH

The results are sorted by file path.

*
LINE_COVERAGE_PERCENTAGE

The results are sorted by the * percentage of lines that are covered.

*/ inline const ReportCodeCoverageSortByType& GetSortBy() const{ return m_sortBy; } /** *

Specifies how the results are sorted. Possible values are:

*
FILE_PATH

The results are sorted by file path.

*
LINE_COVERAGE_PERCENTAGE

The results are sorted by the * percentage of lines that are covered.

*/ inline bool SortByHasBeenSet() const { return m_sortByHasBeenSet; } /** *

Specifies how the results are sorted. Possible values are:

*
FILE_PATH

The results are sorted by file path.

*
LINE_COVERAGE_PERCENTAGE

The results are sorted by the * percentage of lines that are covered.

*/ inline void SetSortBy(const ReportCodeCoverageSortByType& value) { m_sortByHasBeenSet = true; m_sortBy = value; } /** *

Specifies how the results are sorted. Possible values are:

*
FILE_PATH

The results are sorted by file path.

*
LINE_COVERAGE_PERCENTAGE

The results are sorted by the * percentage of lines that are covered.

*/ inline void SetSortBy(ReportCodeCoverageSortByType&& value) { m_sortByHasBeenSet = true; m_sortBy = std::move(value); } /** *

Specifies how the results are sorted. Possible values are:

*
FILE_PATH

The results are sorted by file path.

*
LINE_COVERAGE_PERCENTAGE

The results are sorted by the * percentage of lines that are covered.

*/ inline DescribeCodeCoveragesRequest& WithSortBy(const ReportCodeCoverageSortByType& value) { SetSortBy(value); return *this;} /** *

Specifies how the results are sorted. Possible values are:

*
FILE_PATH

The results are sorted by file path.

*
LINE_COVERAGE_PERCENTAGE

The results are sorted by the * percentage of lines that are covered.

*/ inline DescribeCodeCoveragesRequest& WithSortBy(ReportCodeCoverageSortByType&& value) { SetSortBy(std::move(value)); return *this;} /** *

The minimum line coverage percentage to report.

*/ inline double GetMinLineCoveragePercentage() const{ return m_minLineCoveragePercentage; } /** *

The minimum line coverage percentage to report.

*/ inline bool MinLineCoveragePercentageHasBeenSet() const { return m_minLineCoveragePercentageHasBeenSet; } /** *

The minimum line coverage percentage to report.

*/ inline void SetMinLineCoveragePercentage(double value) { m_minLineCoveragePercentageHasBeenSet = true; m_minLineCoveragePercentage = value; } /** *

The minimum line coverage percentage to report.

*/ inline DescribeCodeCoveragesRequest& WithMinLineCoveragePercentage(double value) { SetMinLineCoveragePercentage(value); return *this;} /** *

The maximum line coverage percentage to report.

*/ inline double GetMaxLineCoveragePercentage() const{ return m_maxLineCoveragePercentage; } /** *

The maximum line coverage percentage to report.

*/ inline bool MaxLineCoveragePercentageHasBeenSet() const { return m_maxLineCoveragePercentageHasBeenSet; } /** *

The maximum line coverage percentage to report.

*/ inline void SetMaxLineCoveragePercentage(double value) { m_maxLineCoveragePercentageHasBeenSet = true; m_maxLineCoveragePercentage = value; } /** *

The maximum line coverage percentage to report.

*/ inline DescribeCodeCoveragesRequest& WithMaxLineCoveragePercentage(double value) { SetMaxLineCoveragePercentage(value); return *this;} private: Aws::String m_reportArn; bool m_reportArnHasBeenSet = false; Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; int m_maxResults; bool m_maxResultsHasBeenSet = false; SortOrderType m_sortOrder; bool m_sortOrderHasBeenSet = false; ReportCodeCoverageSortByType m_sortBy; bool m_sortByHasBeenSet = false; double m_minLineCoveragePercentage; bool m_minLineCoveragePercentageHasBeenSet = false; double m_maxLineCoveragePercentage; bool m_maxLineCoveragePercentageHasBeenSet = false; }; } // namespace Model } // namespace CodeBuild } // namespace Aws