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

Class ImpersonationRule

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

The rules for the given impersonation role.

See Also:

  • Method Details

    • impersonationRuleId

      public final String impersonationRuleId()

      The identifier of the rule.

      Returns:
      The identifier of the rule.

    • name

      public final String name()

      The rule name.

      Returns:
      The rule name.

    • description

      public final String description()

      The rule description.

      Returns:
      The rule description.

    • effect

      public final AccessEffect effect()

      The effect of the rule when it matches the input. Allowed effect values 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:
      The effect of the rule when it matches the input. Allowed effect values are ALLOW or DENY.
      See Also:

    • effectAsString

      public final String effectAsString()

      The effect of the rule when it matches the input. Allowed effect values 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:
      The effect of the rule when it matches the input. Allowed effect values are ALLOW or DENY.
      See Also:

    • hasTargetUsers

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

    • targetUsers

      public final List<String> targetUsers()

      A list of user IDs that match 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 hasTargetUsers() method.

      Returns:
      A list of user IDs that match the rule.

    • hasNotTargetUsers

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

    • notTargetUsers

      public final List<String> notTargetUsers()

      A list of user IDs that don't match 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 hasNotTargetUsers() method.

      Returns:
      A list of user IDs that don't match the rule.

    • toBuilder

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

    • builder

      public static ImpersonationRule.Builder builder()

    • serializableBuilderClass

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