You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CodeBuild::Types::DescribeCodeCoveragesInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing DescribeCodeCoveragesInput as input to an Aws::Client method, you can use a vanilla Hash:

{
  report_arn: "NonEmptyString", # required
  next_token: "String",
  max_results: 1,
  sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  sort_by: "LINE_COVERAGE_PERCENTAGE", # accepts LINE_COVERAGE_PERCENTAGE, FILE_PATH
  min_line_coverage_percentage: 1.0,
  max_line_coverage_percentage: 1.0,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#max_line_coverage_percentage ⇒ Float

The maximum line coverage percentage to report.

Returns:

  • (Float) —

    The maximum line coverage percentage to report.

#max_results ⇒ Integer

The maximum number of results to return.

Returns:

  • (Integer) —

    The maximum number of results to return.

#min_line_coverage_percentage ⇒ Float

The minimum line coverage percentage to report.

Returns:

  • (Float) —

    The minimum line coverage percentage to report.

#next_token ⇒ String

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.

Returns:

  • (String) —

    The nextToken value returned from a previous call to DescribeCodeCoverages.

#report_arn ⇒ String

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

Returns:

  • (String) —

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

#sort_by ⇒ String

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.

Possible values:

  • LINE_COVERAGE_PERCENTAGE
  • FILE_PATH

Returns:

  • (String) —

    Specifies how the results are sorted.

#sort_order ⇒ String

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

Possible values:

  • ASCENDING
  • DESCENDING

Returns:

  • (String) —

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