Class UpdateAutomationRuleRequest

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

  • Method Details

    • ruleArn

      public final String ruleArn()

      The ARN of the rule to update.

      Returns:
      The ARN of the rule to update.

    • ruleRevision

      public final Long ruleRevision()

      The revision number of the rule to update.

      Returns:
      The revision number of the rule to update.

    • name

      public final String name()

      The updated name of the automation rule. Must be 1-128 characters long and contain only alphanumeric characters, underscores, and hyphens.

      Returns:
      The updated name of the automation rule. Must be 1-128 characters long and contain only alphanumeric characters, underscores, and hyphens.

    • description

      public final String description()

      The updated description of the automation rule. Can be up to 1024 characters long and contain alphanumeric characters, underscores, hyphens, spaces, and certain special characters.

      Returns:
      The updated description of the automation rule. Can be up to 1024 characters long and contain alphanumeric characters, underscores, hyphens, spaces, and certain special characters.

    • ruleType

      public final RuleType ruleType()

      The updated type of automation rule. Can be either OrganizationRule for organization-wide rules or AccountRule for account-specific rules.

      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 updated type of automation rule. Can be either OrganizationRule for organization-wide rules or AccountRule for account-specific rules.
      See Also:

    • ruleTypeAsString

      public final String ruleTypeAsString()

      The updated type of automation rule. Can be either OrganizationRule for organization-wide rules or AccountRule for account-specific rules.

      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 updated type of automation rule. Can be either OrganizationRule for organization-wide rules or AccountRule for account-specific rules.
      See Also:

    • organizationConfiguration

      public final OrganizationConfiguration organizationConfiguration()

      Updated configuration settings for organization-wide rules, including rule application order and target account IDs.

      Returns:
      Updated configuration settings for organization-wide rules, including rule application order and target account IDs.

    • priority

      public final String priority()

      The updated priority level of the automation rule, used to determine execution order when multiple rules apply to the same resource.

      Returns:
      The updated priority level of the automation rule, used to determine execution order when multiple rules apply to the same resource.

    • recommendedActionTypes

      public final List<RecommendedActionType> recommendedActionTypes()

      Updated list of recommended action types that this rule can execute, such as SnapshotAndDeleteUnattachedEbsVolume or UpgradeEbsVolumeType.

      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:
      Updated list of recommended action types that this rule can execute, such as SnapshotAndDeleteUnattachedEbsVolume or UpgradeEbsVolumeType.

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

      Updated list of recommended action types that this rule can execute, such as SnapshotAndDeleteUnattachedEbsVolume or UpgradeEbsVolumeType.

      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:
      Updated list of recommended action types that this rule can execute, such as SnapshotAndDeleteUnattachedEbsVolume or UpgradeEbsVolumeType.

    • criteria

      public final Criteria criteria()
      Returns the value of the Criteria property for this object.
      Returns:
      The value of the Criteria property for this object.

    • schedule

      public final Schedule schedule()

      The updated schedule configuration for when the automation rule should execute, including cron expression, timezone, and execution window.

      Returns:
      The updated schedule configuration for when the automation rule should execute, including cron expression, timezone, and execution window.

    • status

      public final RuleStatus status()

      The updated status of the automation rule. Can be 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 updated status of the automation rule. Can be Active or Inactive.
      See Also:

    • statusAsString

      public final String statusAsString()

      The updated status of the automation rule. Can be 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 updated status of the automation rule. Can be Active or Inactive.
      See Also:

    • clientToken

      public final String clientToken()

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Must be 1-64 characters long and contain only alphanumeric characters, underscores, and hyphens.

      Returns:
      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Must be 1-64 characters long and contain only alphanumeric characters, underscores, and hyphens.

    • toBuilder

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

    • builder

      public static UpdateAutomationRuleRequest.Builder builder()

    • serializableBuilderClass

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