Class MobileDeviceAccessRule

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

A rule that controls access to mobile devices for an WorkMail group.

See Also:

  • Method Details

    • mobileDeviceAccessRuleId

      public final String mobileDeviceAccessRuleId()

      The ID assigned to a mobile access rule.

      Returns:
      The ID assigned to a mobile access rule.

    • name

      public final String name()

      The name of a mobile access rule.

      Returns:
      The name of a mobile access rule.

    • description

      public final String description()

      The description of a mobile access rule.

      Returns:
      The description of a mobile access rule.

    • effect

      public final MobileDeviceAccessRuleEffect effect()

      The effect of the rule when it matches. Allowed values are ALLOW or DENY.

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

      Returns:
      The effect of the rule when it matches. Allowed values are ALLOW or DENY.
      See Also:

    • effectAsString

      public final String effectAsString()

      The effect of the rule when it matches. Allowed values are ALLOW or DENY.

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

      Returns:
      The effect of the rule when it matches. Allowed values are ALLOW or DENY.
      See Also:

    • hasDeviceTypes

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

    • deviceTypes

      public final List<String> deviceTypes()

      Device types that a rule will match.

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

      Returns:
      Device types that a rule will match.

    • hasNotDeviceTypes

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

    • notDeviceTypes

      public final List<String> notDeviceTypes()

      Device types that a rule will not match. All other device types will match.

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

      Returns:
      Device types that a rule will not match. All other device types will match.

    • hasDeviceModels

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

    • deviceModels

      public final List<String> deviceModels()

      Device models that a rule will match.

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

      Returns:
      Device models that a rule will match.

    • hasNotDeviceModels

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

    • notDeviceModels

      public final List<String> notDeviceModels()

      Device models that a rule will not match. All other device models will match.

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

      Returns:
      Device models that a rule will not match. All other device models will match.

    • hasDeviceOperatingSystems

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

    • deviceOperatingSystems

      public final List<String> deviceOperatingSystems()

      Device operating systems that a rule will match.

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

      Returns:
      Device operating systems that a rule will match.

    • hasNotDeviceOperatingSystems

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

    • notDeviceOperatingSystems

      public final List<String> notDeviceOperatingSystems()

      Device operating systems that a rule will not match. All other device types will match.

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

      Returns:
      Device operating systems that a rule will not match. All other device types will match.

    • hasDeviceUserAgents

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

    • deviceUserAgents

      public final List<String> deviceUserAgents()

      Device user agents that a rule will match.

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

      Returns:
      Device user agents that a rule will match.

    • hasNotDeviceUserAgents

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

    • notDeviceUserAgents

      public final List<String> notDeviceUserAgents()

      Device user agents that a rule will not match. All other device user agents will match.

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

      Returns:
      Device user agents that a rule will not match. All other device user agents will match.

    • dateCreated

      public final Instant dateCreated()

      The date and time at which an access rule was created.

      Returns:
      The date and time at which an access rule was created.

    • dateModified

      public final Instant dateModified()

      The date and time at which an access rule was modified.

      Returns:
      The date and time at which an access rule was modified.

    • toBuilder

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

    • builder

      public static MobileDeviceAccessRule.Builder builder()

    • serializableBuilderClass

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