Class ListReportGroupsRequest

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.ListReportGroupsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListReportGroupsRequest.Builder,ListReportGroupsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListReportGroupsRequest extends CodeBuildRequest implements ToCopyableBuilder<ListReportGroupsRequest.Builder,ListReportGroupsRequest>

  • Method Details

    • sortOrder

      public final SortOrderType sortOrder()

      Used to specify the order to sort the list of returned report groups. Valid values are ASCENDING and DESCENDING.

      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:
      Used to specify the order to sort the list of returned report groups. Valid values are ASCENDING and DESCENDING.
      See Also:

    • sortOrderAsString

      public final String sortOrderAsString()

      Used to specify the order to sort the list of returned report groups. Valid values are ASCENDING and DESCENDING.

      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:
      Used to specify the order to sort the list of returned report groups. Valid values are ASCENDING and DESCENDING.
      See Also:

    • sortBy

      public final ReportGroupSortByType sortBy()

      The criterion to be used to list build report groups. Valid values include:

      • CREATED_TIME: List based on when each report group was created.

      • LAST_MODIFIED_TIME: List based on when each report group was last changed.

      • NAME: List based on each report group's name.

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

      Returns:
      The criterion to be used to list build report groups. Valid values include:

      • CREATED_TIME: List based on when each report group was created.

      • LAST_MODIFIED_TIME: List based on when each report group was last changed.

      • NAME: List based on each report group's name.

      See Also:

    • sortByAsString

      public final String sortByAsString()

      The criterion to be used to list build report groups. Valid values include:

      • CREATED_TIME: List based on when each report group was created.

      • LAST_MODIFIED_TIME: List based on when each report group was last changed.

      • NAME: List based on each report group's name.

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

      Returns:
      The criterion to be used to list build report groups. Valid values include:

      • CREATED_TIME: List based on when each report group was created.

      • LAST_MODIFIED_TIME: List based on when each report group was last changed.

      • NAME: List based on each report group's name.

      See Also:

    • nextToken

      public final String nextToken()

      During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

      Returns:
      During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

    • maxResults

      public final Integer maxResults()

      The maximum number of paginated report groups returned per response. Use nextToken to iterate pages in the list of returned ReportGroup objects. The default value is 100.

      Returns:
      The maximum number of paginated report groups returned per response. Use nextToken to iterate pages in the list of returned ReportGroup objects. The default value is 100.

    • toBuilder

      public ListReportGroupsRequest.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<ListReportGroupsRequest.Builder,ListReportGroupsRequest>
      Specified by:
      toBuilder in class CodeBuildRequest
      Returns:
      a builder for type T

    • builder

      public static ListReportGroupsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ListReportGroupsRequest.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.