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

Class GetUsageStatisticsRequest

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

  • Method Details

    • hasFilterBy

      public final boolean hasFilterBy()
      For responses, this returns true if the service returned a value for the FilterBy 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.

    • filterBy

      public final List<UsageStatisticsFilter> filterBy()

      An array of objects, one for each condition to use to filter the query results. If you specify more than one condition, Amazon Macie uses an AND operator to join the conditions.

      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 hasFilterBy() method.

      Returns:
      An array of objects, one for each condition to use to filter the query results. If you specify more than one condition, Amazon Macie uses an AND operator to join the conditions.

    • maxResults

      public final Integer maxResults()

      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.

    • nextToken

      public final String nextToken()

      The nextToken string that specifies which page of results to return in a paginated response.

      Returns:
      The nextToken string that specifies which page of results to return in a paginated response.

    • sortBy

      public final UsageStatisticsSortBy sortBy()

      The criteria to use to sort the query results.

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

    • timeRange

      public final TimeRange timeRange()

      The inclusive time period to query usage data for. Valid values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days. If you don't specify a value, Amazon Macie provides usage data for the preceding 30 days.

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

      Returns:
      The inclusive time period to query usage data for. Valid values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days. If you don't specify a value, Amazon Macie provides usage data for the preceding 30 days.
      See Also:

    • timeRangeAsString

      public final String timeRangeAsString()

      The inclusive time period to query usage data for. Valid values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days. If you don't specify a value, Amazon Macie provides usage data for the preceding 30 days.

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

      Returns:
      The inclusive time period to query usage data for. Valid values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days. If you don't specify a value, Amazon Macie provides usage data for the preceding 30 days.
      See Also:

    • toBuilder

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

    • builder

      public static GetUsageStatisticsRequest.Builder builder()

    • serializableBuilderClass

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