Class DescribeCodeCoveragesRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.codebuild.model.CodeBuildRequest
software.amazon.awssdk.services.codebuild.model.DescribeCodeCoveragesRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeCodeCoveragesRequest.Builder,DescribeCodeCoveragesRequest>
@Generated("software.amazon.awssdk:codegen") public final class DescribeCodeCoveragesRequest extends CodeBuildRequest implements ToCopyableBuilder<DescribeCodeCoveragesRequest.Builder,DescribeCodeCoveragesRequest>

  • Method Details

    • reportArn

      public final String reportArn()

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

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

    • nextToken

      public final String 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.

      Returns:
      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.

    • maxResults

      public final Integer maxResults()

      The maximum number of results to return.

      Returns:
      The maximum number of results to return.

    • sortOrder

      public final SortOrderType sortOrder()

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

      If the service returns an enum value that is not available in the current SDK version, sortOrder will return SortOrderType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortOrderAsString().

      Returns:
      Specifies if the results are sorted in ascending or descending order.
      See Also:

    • sortOrderAsString

      public final String sortOrderAsString()

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

      If the service returns an enum value that is not available in the current SDK version, sortOrder will return SortOrderType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortOrderAsString().

      Returns:
      Specifies if the results are sorted in ascending or descending order.
      See Also:

    • sortBy

      public final ReportCodeCoverageSortByType 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.

      If the service returns an enum value that is not available in the current SDK version, sortBy will return ReportCodeCoverageSortByType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortByAsString().

      Returns:
      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.

      See Also:

    • sortByAsString

      public final String sortByAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, sortBy will return ReportCodeCoverageSortByType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortByAsString().

      Returns:
      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.

      See Also:

    • minLineCoveragePercentage

      public final Double minLineCoveragePercentage()

      The minimum line coverage percentage to report.

      Returns:
      The minimum line coverage percentage to report.

    • maxLineCoveragePercentage

      public final Double maxLineCoveragePercentage()

      The maximum line coverage percentage to report.

      Returns:
      The maximum line coverage percentage to report.

    • toBuilder

      public DescribeCodeCoveragesRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DescribeCodeCoveragesRequest.Builder,DescribeCodeCoveragesRequest>
      Specified by:
      toBuilder in class CodeBuildRequest
      Returns:
      a builder for type T

    • builder

      public static DescribeCodeCoveragesRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends DescribeCodeCoveragesRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.