Class EffectivePolicyValidationError

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

Contains details about the validation errors that occurred when generating or enforcing an effective policy, such as which policies contributed to the error and location of the error.

See Also:

  • Method Details

    • errorCode

      public final String errorCode()

      The error code for the validation error. For example, ELEMENTS_TOO_MANY.

      Returns:
      The error code for the validation error. For example, ELEMENTS_TOO_MANY.

    • errorMessage

      public final String errorMessage()

      The error message for the validation error.

      Returns:
      The error message for the validation error.

    • pathToError

      public final String pathToError()

      The path within the effective policy where the validation error occurred.

      Returns:
      The path within the effective policy where the validation error occurred.

    • hasContributingPolicies

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

    • contributingPolicies

      public final List<String> contributingPolicies()

      The individual policies inherited and attached to the account which contributed to the validation error.

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

      Returns:
      The individual policies inherited and attached to the account which contributed to the validation error.

    • toBuilder

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

    • builder

      public static EffectivePolicyValidationError.Builder builder()

    • serializableBuilderClass

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