Class DryRunResult

java.lang.Object
software.amazon.awssdk.services.cloudwatchlogs.model.DryRunResult
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DryRunResult.Builder,DryRunResult>
@Generated("software.amazon.awssdk:codegen") public final class DryRunResult extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DryRunResult.Builder,DryRunResult>

Contains the estimated impact of creating, updating, or deleting an account-level retention policy. The analysis compares the effective retention period of each log group, which accounts for all account-level retention policies that apply to it, before and after the change. Log groups in the Delivery class are not included.

See Also:

  • Method Details

    • totalMatchedLogGroups

      public final Integer totalMatchedLogGroups()

      The number of log groups in the scope of the policy that were analyzed. This value is the sum of increasedRetentionLogGroupCount, decreasedRetentionLogGroupCount, and unchangedRetentionLogGroupCount, and does not include log groups that could not be analyzed.

      Returns:
      The number of log groups in the scope of the policy that were analyzed. This value is the sum of increasedRetentionLogGroupCount, decreasedRetentionLogGroupCount, and unchangedRetentionLogGroupCount, and does not include log groups that could not be analyzed.

    • increasedRetentionLogGroupCount

      public final Integer increasedRetentionLogGroupCount()

      The number of log groups whose effective retention period would become longer.

      Returns:
      The number of log groups whose effective retention period would become longer.

    • decreasedRetentionLogGroupCount

      public final Integer decreasedRetentionLogGroupCount()

      The number of log groups whose effective retention period would become shorter.

      Returns:
      The number of log groups whose effective retention period would become shorter.

    • unchangedRetentionLogGroupCount

      public final Integer unchangedRetentionLogGroupCount()

      The number of log groups whose effective retention period would not change.

      Returns:
      The number of log groups whose effective retention period would not change.

    • failedAnalysisCount

      public final Integer failedAnalysisCount()

      The number of log groups in the scope of the policy that could not be analyzed. These log groups are not included in totalMatchedLogGroups.

      Returns:
      The number of log groups in the scope of the policy that could not be analyzed. These log groups are not included in totalMatchedLogGroups.

    • hasTopLogGroupsImpacted

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

    • topLogGroupsImpacted

      public final List<LogGroupImpact> topLogGroupsImpacted()

      Up to 20 log groups in the scope of the policy, sorted by stored bytes in descending order. This list can include log groups whose effective retention period would not change.

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

      Returns:
      Up to 20 log groups in the scope of the policy, sorted by stored bytes in descending order. This list can include log groups whose effective retention period would not change.

    • toBuilder

      public DryRunResult.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<DryRunResult.Builder,DryRunResult>
      Returns:
      a builder for type T

    • builder

      public static DryRunResult.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)

    • 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.