software.amazon.awssdk.services.workmail.model

Class MobileDeviceAccessRule

java.lang.Object

software.amazon.awssdk.services.workmail.model.MobileDeviceAccessRule

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<MobileDeviceAccessRule.Builder,MobileDeviceAccessRule>

@Generated(value="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 Amazon WorkMail group.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MobileDeviceAccessRule.Builder

Method Summary

Modifier and Type	Method and Description
static MobileDeviceAccessRule.Builder	builder()
Instant	dateCreated() The date and time at which an access rule was created.
Instant	dateModified() The date and time at which an access rule was modified.
String	description() The description of a mobile access rule.
List<String>	deviceModels() Device models that a rule will match.
List<String>	deviceOperatingSystems() Device operating systems that a rule will match.
List<String>	deviceTypes() Device types that a rule will match.
List<String>	deviceUserAgents() Device user agents that a rule will match.
MobileDeviceAccessRuleEffect	effect() The effect of the rule when it matches.
String	effectAsString() The effect of the rule when it matches.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasDeviceModels() For responses, this returns true if the service returned a value for the DeviceModels property.
boolean	hasDeviceOperatingSystems() For responses, this returns true if the service returned a value for the DeviceOperatingSystems property.
boolean	hasDeviceTypes() For responses, this returns true if the service returned a value for the DeviceTypes property.
boolean	hasDeviceUserAgents() For responses, this returns true if the service returned a value for the DeviceUserAgents property.
int	hashCode()
boolean	hasNotDeviceModels() For responses, this returns true if the service returned a value for the NotDeviceModels property.
boolean	hasNotDeviceOperatingSystems() For responses, this returns true if the service returned a value for the NotDeviceOperatingSystems property.
boolean	hasNotDeviceTypes() For responses, this returns true if the service returned a value for the NotDeviceTypes property.
boolean	hasNotDeviceUserAgents() For responses, this returns true if the service returned a value for the NotDeviceUserAgents property.
String	mobileDeviceAccessRuleId() The ID assigned to a mobile access rule.
String	name() The name of a mobile access rule.
List<String>	notDeviceModels() Device models that a rule will not match.
List<String>	notDeviceOperatingSystems() Device operating systems that a rule will not match.
List<String>	notDeviceTypes() Device types that a rule will not match.
List<String>	notDeviceUserAgents() Device user agents that a rule will not match.
List<SdkField<?>>	sdkFields()
static Class<? extends MobileDeviceAccessRule.Builder>	serializableBuilderClass()
MobileDeviceAccessRule.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

MobileDeviceAccessRuleEffect

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:

MobileDeviceAccessRuleEffect

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()

Specified by:

toBuilder in interface ToCopyableBuilder<MobileDeviceAccessRule.Builder,MobileDeviceAccessRule>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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