Class AutomationRule

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

Represents a complete automation rule configuration including criteria, schedule, and execution settings.

See Also:

  • Method Details

    • ruleArn

      public final String ruleArn()

      The Amazon Resource Name (ARN) of the automation rule.

      Returns:
      The Amazon Resource Name (ARN) of the automation rule.

    • ruleId

      public final String ruleId()

      The unique identifier of the automation rule.

      Returns:
      The unique identifier of the automation rule.

    • name

      public final String name()

      The name of the automation rule.

      Returns:
      The name of the automation rule.

    • description

      public final String description()

      A description of the automation rule.

      Returns:
      A description of the automation rule.

    • ruleType

      public final RuleType ruleType()

      The type of automation rule (OrganizationRule or AccountRule).

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

      Returns:
      The type of automation rule (OrganizationRule or AccountRule).
      See Also:

    • ruleTypeAsString

      public final String ruleTypeAsString()

      The type of automation rule (OrganizationRule or AccountRule).

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

      Returns:
      The type of automation rule (OrganizationRule or AccountRule).
      See Also:

    • ruleRevision

      public final Long ruleRevision()

      The revision number of the automation rule.

      Returns:
      The revision number of the automation rule.

    • accountId

      public final String accountId()

      The 12-digit Amazon Web Services account ID that owns this automation rule.

      Returns:
      The 12-digit Amazon Web Services account ID that owns this automation rule.

    • organizationConfiguration

      public final OrganizationConfiguration organizationConfiguration()

      Configuration settings for organization-wide rules.

      Returns:
      Configuration settings for organization-wide rules.

    • priority

      public final String priority()

      A string representation of a decimal number between 0 and 1 (having up to 30 digits after the decimal point) that determines the priority of the rule. When multiple rules match the same recommended action, Compute Optimizer assigns the action to the rule with the lowest priority value (highest priority), even if that rule is scheduled to run later than other matching rules.

      Returns:
      A string representation of a decimal number between 0 and 1 (having up to 30 digits after the decimal point) that determines the priority of the rule. When multiple rules match the same recommended action, Compute Optimizer assigns the action to the rule with the lowest priority value (highest priority), even if that rule is scheduled to run later than other matching rules.

    • recommendedActionTypes

      public final List<RecommendedActionType> recommendedActionTypes()

      List of recommended action types that this rule can execute.

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

      Returns:
      List of recommended action types that this rule can execute.

    • hasRecommendedActionTypes

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

    • recommendedActionTypesAsStrings

      public final List<String> recommendedActionTypesAsStrings()

      List of recommended action types that this rule can execute.

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

      Returns:
      List of recommended action types that this rule can execute.

    • schedule

      public final Schedule schedule()

      The schedule configuration for when the automation rule should execute.

      Returns:
      The schedule configuration for when the automation rule should execute.

    • status

      public final RuleStatus status()

      The current status of the automation rule (Active or Inactive).

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

      Returns:
      The current status of the automation rule (Active or Inactive).
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the automation rule (Active or Inactive).

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

      Returns:
      The current status of the automation rule (Active or Inactive).
      See Also:

    • createdTimestamp

      public final Instant createdTimestamp()

      The timestamp when the automation rule was created.

      Returns:
      The timestamp when the automation rule was created.

    • lastUpdatedTimestamp

      public final Instant lastUpdatedTimestamp()

      The timestamp when the automation rule was last updated.

      Returns:
      The timestamp when the automation rule was last updated.

    • toBuilder

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

    • builder

      public static AutomationRule.Builder builder()

    • serializableBuilderClass

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