Class MobileDeviceAccessRule
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<MobileDeviceAccessRule.Builder,
MobileDeviceAccessRule>
A rule that controls access to mobile devices for an WorkMail group.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Instant
The date and time at which an access rule was created.final Instant
The date and time at which an access rule was modified.final String
The description of a mobile access rule.Device models that a rule will match.Device operating systems that a rule will match.Device types that a rule will match.Device user agents that a rule will match.effect()
The effect of the rule when it matches.final String
The effect of the rule when it matches.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the DeviceModels property.final boolean
For responses, this returns true if the service returned a value for the DeviceOperatingSystems property.final boolean
For responses, this returns true if the service returned a value for the DeviceTypes property.final boolean
For responses, this returns true if the service returned a value for the DeviceUserAgents property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the NotDeviceModels property.final boolean
For responses, this returns true if the service returned a value for the NotDeviceOperatingSystems property.final boolean
For responses, this returns true if the service returned a value for the NotDeviceTypes property.final boolean
For responses, this returns true if the service returned a value for the NotDeviceUserAgents property.final String
The ID assigned to a mobile access rule.final String
name()
The name of a mobile access rule.Device models that a rule will not match.Device operating systems that a rule will not match.Device types that a rule will not match.Device user agents that a rule will not match.static Class
<? extends MobileDeviceAccessRule.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
mobileDeviceAccessRuleId
The ID assigned to a mobile access rule.
- Returns:
- The ID assigned to a mobile access rule.
-
name
The name of a mobile access rule.
- Returns:
- The name of a mobile access rule.
-
description
The description of a mobile access rule.
- Returns:
- The description of a mobile access rule.
-
effect
The effect of the rule when it matches. Allowed values are
ALLOW
orDENY
.If the service returns an enum value that is not available in the current SDK version,
effect
will returnMobileDeviceAccessRuleEffect.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromeffectAsString()
.- Returns:
- The effect of the rule when it matches. Allowed values are
ALLOW
orDENY
. - See Also:
-
effectAsString
The effect of the rule when it matches. Allowed values are
ALLOW
orDENY
.If the service returns an enum value that is not available in the current SDK version,
effect
will returnMobileDeviceAccessRuleEffect.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromeffectAsString()
.- Returns:
- The effect of the rule when it matches. Allowed values are
ALLOW
orDENY
. - 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 theisEmpty()
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
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 theisEmpty()
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
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 theisEmpty()
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
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 theisEmpty()
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
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 theisEmpty()
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
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 theisEmpty()
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
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 theisEmpty()
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
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 theisEmpty()
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
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
The date and time at which an access rule was created.
- Returns:
- The date and time at which an access rule was created.
-
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
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 interfaceToCopyableBuilder<MobileDeviceAccessRule.Builder,
MobileDeviceAccessRule> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-