Class RuleExecutionInput

    • Method Detail

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

        Configuration data for a rule execution, such as the resolved values for that run.

        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:
        Configuration data for a rule execution, such as the resolved values for that run.
      • hasResolvedConfiguration

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

        public final Map<String,​String> resolvedConfiguration()

        Configuration data for a rule execution with all variable references replaced with their real values for the execution.

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

        Returns:
        Configuration data for a rule execution with all variable references replaced with their real values for the execution.
      • roleArn

        public final String roleArn()

        The ARN of the IAM service role that performs the declared rule. This is assumed through the roleArn for the pipeline.

        Returns:
        The ARN of the IAM service role that performs the declared rule. This is assumed through the roleArn for the pipeline.
      • region

        public final String region()

        The Amazon Web Services Region for the rule, such as us-east-1.

        Returns:
        The Amazon Web Services Region for the rule, such as us-east-1.
      • 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<ArtifactDetail> inputArtifacts()

        Details of input artifacts of the rule that correspond to the rule execution.

        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:
        Details of input artifacts of the rule that correspond to the rule execution.
      • hashCode

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

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)