Class AccessControlRule
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AccessControlRule.Builder,
AccessControlRule>
A rule that controls access to an WorkMail organization.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionactions()
Access protocol actions to include in the rule.static AccessControlRule.Builder
builder()
final Instant
The date that the rule was created.final Instant
The date that the rule was modified.final String
The rule description.final AccessControlRuleEffect
effect()
The rule effect.final String
The rule effect.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 Actions property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the ImpersonationRoleIds property.final boolean
For responses, this returns true if the service returned a value for the IpRanges property.final boolean
For responses, this returns true if the service returned a value for the NotActions property.final boolean
For responses, this returns true if the service returned a value for the NotImpersonationRoleIds property.final boolean
For responses, this returns true if the service returned a value for the NotIpRanges property.final boolean
For responses, this returns true if the service returned a value for the NotUserIds property.final boolean
For responses, this returns true if the service returned a value for the UserIds property.Impersonation role IDs to include in the rule.ipRanges()
IPv4 CIDR ranges to include in the rule.final String
name()
The rule name.Access protocol actions to exclude from the rule.Impersonation role IDs to exclude from the rule.IPv4 CIDR ranges to exclude from the rule.User IDs to exclude from the rule.static Class
<? extends AccessControlRule.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.userIds()
User IDs to include in the rule.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The rule name.
- Returns:
- The rule name.
-
effect
The rule effect.
If the service returns an enum value that is not available in the current SDK version,
effect
will returnAccessControlRuleEffect.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromeffectAsString()
.- Returns:
- The rule effect.
- See Also:
-
effectAsString
The rule effect.
If the service returns an enum value that is not available in the current SDK version,
effect
will returnAccessControlRuleEffect.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromeffectAsString()
.- Returns:
- The rule effect.
- See Also:
-
description
The rule description.
- Returns:
- The rule description.
-
hasIpRanges
public final boolean hasIpRanges()For responses, this returns true if the service returned a value for the IpRanges 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. -
ipRanges
IPv4 CIDR ranges to include in 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
hasIpRanges()
method.- Returns:
- IPv4 CIDR ranges to include in the rule.
-
hasNotIpRanges
public final boolean hasNotIpRanges()For responses, this returns true if the service returned a value for the NotIpRanges 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. -
notIpRanges
IPv4 CIDR ranges to exclude from 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
hasNotIpRanges()
method.- Returns:
- IPv4 CIDR ranges to exclude from the rule.
-
hasActions
public final boolean hasActions()For responses, this returns true if the service returned a value for the Actions 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. -
actions
Access protocol actions to include in the rule. Valid values include
ActiveSync
,AutoDiscover
,EWS
,IMAP
,SMTP
,WindowsOutlook
, andWebMail
.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
hasActions()
method.- Returns:
- Access protocol actions to include in the rule. Valid values include
ActiveSync
,AutoDiscover
,EWS
,IMAP
,SMTP
,WindowsOutlook
, andWebMail
.
-
hasNotActions
public final boolean hasNotActions()For responses, this returns true if the service returned a value for the NotActions 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. -
notActions
Access protocol actions to exclude from the rule. Valid values include
ActiveSync
,AutoDiscover
,EWS
,IMAP
,SMTP
,WindowsOutlook
, andWebMail
.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
hasNotActions()
method.- Returns:
- Access protocol actions to exclude from the rule. Valid values include
ActiveSync
,AutoDiscover
,EWS
,IMAP
,SMTP
,WindowsOutlook
, andWebMail
.
-
hasUserIds
public final boolean hasUserIds()For responses, this returns true if the service returned a value for the UserIds 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. -
userIds
User IDs to include in 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
hasUserIds()
method.- Returns:
- User IDs to include in the rule.
-
hasNotUserIds
public final boolean hasNotUserIds()For responses, this returns true if the service returned a value for the NotUserIds 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. -
notUserIds
User IDs to exclude from 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
hasNotUserIds()
method.- Returns:
- User IDs to exclude from the rule.
-
dateCreated
The date that the rule was created.
- Returns:
- The date that the rule was created.
-
dateModified
The date that the rule was modified.
- Returns:
- The date that the rule was modified.
-
hasImpersonationRoleIds
public final boolean hasImpersonationRoleIds()For responses, this returns true if the service returned a value for the ImpersonationRoleIds 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. -
impersonationRoleIds
Impersonation role IDs to include in 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
hasImpersonationRoleIds()
method.- Returns:
- Impersonation role IDs to include in the rule.
-
hasNotImpersonationRoleIds
public final boolean hasNotImpersonationRoleIds()For responses, this returns true if the service returned a value for the NotImpersonationRoleIds 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. -
notImpersonationRoleIds
Impersonation role IDs to exclude from 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
hasNotImpersonationRoleIds()
method.- Returns:
- Impersonation role IDs to exclude from the rule.
-
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<AccessControlRule.Builder,
AccessControlRule> - 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
-