java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.workmail.model.WorkMailRequest
    - - software.amazon.awssdk.services.workmail.model.CreateMobileDeviceAccessRuleRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateMobileDeviceAccessRuleRequest.Builder,CreateMobileDeviceAccessRuleRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateMobileDeviceAccessRuleRequest
extends WorkMailRequest
implements ToCopyableBuilder<CreateMobileDeviceAccessRuleRequest.Builder,CreateMobileDeviceAccessRuleRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreateMobileDeviceAccessRuleRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static CreateMobileDeviceAccessRuleRequest.Builder`	`builder()`
`String`	`clientToken()`	The idempotency token for the client request.
`String`	`description()`	The rule description.
`List<String>`	`deviceModels()`	Device models that the rule will match.
`List<String>`	`deviceOperatingSystems()`	Device operating systems that the rule will match.
`List<String>`	`deviceTypes()`	Device types that the rule will match.
`List<String>`	`deviceUserAgents()`	Device user agents that the 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`	`name()`	The rule name.
`List<String>`	`notDeviceModels()`	Device models that the rule will not match.
`List<String>`	`notDeviceOperatingSystems()`	Device operating systems that the rule will not match.
`List<String>`	`notDeviceTypes()`	Device types that the rule will not match.
`List<String>`	`notDeviceUserAgents()`	Device user agents that the rule will not match.
`String`	`organizationId()`	The WorkMail organization under which the rule will be created.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateMobileDeviceAccessRuleRequest.Builder>`	`serializableBuilderClass()`
`CreateMobileDeviceAccessRuleRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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
  - organizationId
```
public final String organizationId()
```
    The WorkMail organization under which the rule will be created.
    
    Returns:
    
    The WorkMail organization under which the rule will be created.
  - clientToken
```
public final String clientToken()
```
    The idempotency token for the client request.
    
    Returns:
    
    The idempotency token for the client request.
  - 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 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 the 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 the 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 the 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 the 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 the 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 the 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 the 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 the 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 the 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 the 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 the rule will not match. All other device operating systems 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 the rule will not match. All other device operating systems 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 the 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 the 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 the 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 the rule will not match. All other device user agents will match.
  - toBuilder
```
public CreateMobileDeviceAccessRuleRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateMobileDeviceAccessRuleRequest.Builder,CreateMobileDeviceAccessRuleRequest>
    
    Specified by:
    
    toBuilder in class WorkMailRequest
  - builder
```
public static CreateMobileDeviceAccessRuleRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateMobileDeviceAccessRuleRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateMobileDeviceAccessRuleRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

organizationId

clientToken

name

description

effect

effectAsString

hasDeviceTypes

deviceTypes

hasNotDeviceTypes

notDeviceTypes

hasDeviceModels

deviceModels

hasNotDeviceModels

notDeviceModels

hasDeviceOperatingSystems

deviceOperatingSystems

hasNotDeviceOperatingSystems

notDeviceOperatingSystems

hasDeviceUserAgents

deviceUserAgents

hasNotDeviceUserAgents

notDeviceUserAgents

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields