Package software.amazon.awssdk.services.macie2.model

Class GetFindingStatisticsRequest

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

  • Method Details

    • findingCriteria

      public final FindingCriteria findingCriteria()

      The criteria to use to filter the query results.

      Returns:
      The criteria to use to filter the query results.

    • groupBy

      public final GroupBy groupBy()

      The finding property to use to group the query results. Valid values are:

      • classificationDetails.jobId - The unique identifier for the classification job that produced the finding.

      • resourcesAffected.s3Bucket.name - The name of the S3 bucket that the finding applies to.

      • severity.description - The severity level of the finding, such as High or Medium.

      • type - The type of finding, such as Policy:IAMUser/S3BucketPublic and SensitiveData:S3Object/Personal.

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

      Returns:
      The finding property to use to group the query results. Valid values are:

      • classificationDetails.jobId - The unique identifier for the classification job that produced the finding.

      • resourcesAffected.s3Bucket.name - The name of the S3 bucket that the finding applies to.

      • severity.description - The severity level of the finding, such as High or Medium.

      • type - The type of finding, such as Policy:IAMUser/S3BucketPublic and SensitiveData:S3Object/Personal.

      See Also:

    • groupByAsString

      public final String groupByAsString()

      The finding property to use to group the query results. Valid values are:

      • classificationDetails.jobId - The unique identifier for the classification job that produced the finding.

      • resourcesAffected.s3Bucket.name - The name of the S3 bucket that the finding applies to.

      • severity.description - The severity level of the finding, such as High or Medium.

      • type - The type of finding, such as Policy:IAMUser/S3BucketPublic and SensitiveData:S3Object/Personal.

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

      Returns:
      The finding property to use to group the query results. Valid values are:

      • classificationDetails.jobId - The unique identifier for the classification job that produced the finding.

      • resourcesAffected.s3Bucket.name - The name of the S3 bucket that the finding applies to.

      • severity.description - The severity level of the finding, such as High or Medium.

      • type - The type of finding, such as Policy:IAMUser/S3BucketPublic and SensitiveData:S3Object/Personal.

      See Also:

    • size

      public final Integer size()

      The maximum number of items to include in each page of the response.

      Returns:
      The maximum number of items to include in each page of the response.

    • sortCriteria

      public final FindingStatisticsSortCriteria sortCriteria()

      The criteria to use to sort the query results.

      Returns:
      The criteria to use to sort the query results.

    • toBuilder

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

    • builder

      public static GetFindingStatisticsRequest.Builder builder()

    • serializableBuilderClass

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