Class CreateAutomationRuleRequest

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

  • Method Details

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

      Only the management account or a delegated administrator can set the ruleType to be OrganizationRule.

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

      Only the management account or a delegated administrator can set the ruleType to be OrganizationRule.

      See Also:

    • ruleTypeAsString

      public final String ruleTypeAsString()

      The type of rule.

      Only the management account or a delegated administrator can set the ruleType to be OrganizationRule.

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

      Only the management account or a delegated administrator can set the ruleType to be OrganizationRule.

      See Also:

    • organizationConfiguration

      public final OrganizationConfiguration organizationConfiguration()

      Configuration for organization-level rules. Required for OrganizationRule type.

      Returns:
      Configuration for organization-level rules. Required for OrganizationRule type.

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

      The types of recommended actions this rule will automate.

      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:
      The types of recommended actions this rule will automate.

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

      The types of recommended actions this rule will automate.

      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:
      The types of recommended actions this rule will automate.

    • criteria

      public final Criteria criteria()

      A set of conditions that specify which recommended action qualify for implementation. When a rule is active and a recommended action matches these criteria, Compute Optimizer implements the action at the scheduled run time.

      Returns:
      A set of conditions that specify which recommended action qualify for implementation. When a rule is active and a recommended action matches these criteria, Compute Optimizer implements the action at the scheduled run time.

    • schedule

      public final Schedule schedule()

      The schedule for when the rule should run.

      Returns:
      The schedule for when the rule should run.

    • status

      public final RuleStatus status()

      The status of the rule

      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 status of the rule
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the rule

      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 status of the rule
      See Also:

    • hasTags

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

    • tags

      public final List<Tag> tags()

      The tags to associate with the rule.

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

      Returns:
      The tags to associate with the rule.

    • clientToken

      public final String clientToken()

      A unique identifier to ensure idempotency of the request.

      Returns:
      A unique identifier to ensure idempotency of the request.

    • toBuilder

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

    • builder

      public static CreateAutomationRuleRequest.Builder builder()

    • serializableBuilderClass

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