Class ListFindingAggregationsRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<ListFindingAggregationsRequest.Builder,ListFindingAggregationsRequest>

@Generated("software.amazon.awssdk:codegen") public final class ListFindingAggregationsRequest extends Inspector2Request implements ToCopyableBuilder<ListFindingAggregationsRequest.Builder,ListFindingAggregationsRequest>
  • Method Details

    • hasAccountIds

      public final boolean hasAccountIds()
      For responses, this returns true if the service returned a value for the AccountIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
    • accountIds

      public final List<StringFilter> accountIds()

      The Amazon Web Services account IDs to retrieve finding aggregation data for.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAccountIds() method.

      Returns:
      The Amazon Web Services account IDs to retrieve finding aggregation data for.
    • aggregationRequest

      public final AggregationRequest aggregationRequest()

      Details of the aggregation request that is used to filter your aggregation results.

      Returns:
      Details of the aggregation request that is used to filter your aggregation results.
    • aggregationType

      public final AggregationType aggregationType()

      The type of the aggregation request.

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

      Returns:
      The type of the aggregation request.
      See Also:
    • aggregationTypeAsString

      public final String aggregationTypeAsString()

      The type of the aggregation request.

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

      Returns:
      The type of the aggregation request.
      See Also:
    • maxResults

      public final Integer maxResults()

      The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results.

      Returns:
      The maximum number of results the response can return. If your request would return more than the maximum the response will return a nextToken value, use this value when you call the action again to get the remaining results.
    • nextToken

      public final String nextToken()

      A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.

      Returns:
      A token to use for paginating results that are returned in the response. Set the value of this parameter to null for the first request to a list action. If your response returns more than the maxResults maximum value it will also return a nextToken value. For subsequent calls, use the nextToken value returned from the previous request to continue listing results after the first page.
    • 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<ListFindingAggregationsRequest.Builder,ListFindingAggregationsRequest>
      Specified by:
      toBuilder in class Inspector2Request
      Returns:
      a builder for type T
    • builder

      public static ListFindingAggregationsRequest.Builder builder()
    • serializableBuilderClass

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