Package software.amazon.awssdk.services.workmail.model

Class GetImpersonationRoleEffectResponse

    • Method Detail

      • effect

        public final AccessEffect effect()

        Effect of the impersonation role on the target user based on its rules. Available effects are ALLOW or DENY.

        If the service returns an enum value that is not available in the current SDK version, effect will return AccessEffect.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from effectAsString().

        Returns:
        Effect of the impersonation role on the target user based on its rules. Available effects are ALLOW or DENY.
        See Also:
        AccessEffect

      • effectAsString

        public final String effectAsString()

        Effect of the impersonation role on the target user based on its rules. Available effects are ALLOW or DENY.

        If the service returns an enum value that is not available in the current SDK version, effect will return AccessEffect.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from effectAsString().

        Returns:
        Effect of the impersonation role on the target user based on its rules. Available effects are ALLOW or DENY.
        See Also:
        AccessEffect

      • hasMatchedRules

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

      • matchedRules

        public final List<ImpersonationMatchedRule> matchedRules()

        A list of the rules that match the input and produce the configured effect.

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

        Returns:
        A list of the rules that match the input and produce the configured effect.

      • 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