Class RuleDeclaration

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

Represents information about the rule to be created for an associated condition. An example would be creating a new rule for an entry condition, such as a rule that checks for a test result before allowing the run to enter the deployment stage. For more information about conditions, see Stage conditions and How do stage conditions work?. For more information about rules, see the CodePipeline rule reference.

See Also:

  • Method Details

    • name

      public final String name()

      The name of the rule that is created for the condition, such as VariableCheck.

      Returns:
      The name of the rule that is created for the condition, such as VariableCheck.

    • ruleTypeId

      public final RuleTypeId ruleTypeId()

      The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.

      Returns:
      The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.

    • hasConfiguration

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

    • configuration

      public final Map<String,String> configuration()

      The action configuration fields for 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 hasConfiguration() method.

      Returns:
      The action configuration fields for the rule.

    • hasCommands

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

    • commands

      public final List<String> commands()

      The shell commands to run with your commands rule in CodePipeline. All commands are supported except multi-line formats. While CodeBuild logs and permissions are used, you do not need to create any resources in CodeBuild.

      Using compute time for this action will incur separate charges in CodeBuild.

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

      Returns:
      The shell commands to run with your commands rule in CodePipeline. All commands are supported except multi-line formats. While CodeBuild logs and permissions are used, you do not need to create any resources in CodeBuild.

      Using compute time for this action will incur separate charges in CodeBuild.

    • hasInputArtifacts

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

    • inputArtifacts

      public final List<InputArtifact> inputArtifacts()

      The input artifacts fields for the rule, such as specifying an input file for 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 hasInputArtifacts() method.

      Returns:
      The input artifacts fields for the rule, such as specifying an input file for the rule.

    • roleArn

      public final String roleArn()

      The pipeline role ARN associated with the rule.

      Returns:
      The pipeline role ARN associated with the rule.

    • region

      public final String region()

      The Region for the condition associated with the rule.

      Returns:
      The Region for the condition associated with the rule.

    • timeoutInMinutes

      public final Integer timeoutInMinutes()

      The action timeout for the rule.

      Returns:
      The action timeout for the rule.

    • toBuilder

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

    • builder

      public static RuleDeclaration.Builder builder()

    • serializableBuilderClass

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