PutAccessControlRuleRequest (AWS Java SDK :: Services

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.PutAccessControlRuleRequest

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface PutAccessControlRuleRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`PutAccessControlRuleRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<String>`	`actions()` Access protocol actions to include in the rule.
`static PutAccessControlRuleRequest.Builder`	`builder()`
`String`	`description()` The rule description.
`AccessControlRuleEffect`	`effect()` The rule effect.
`String`	`effectAsString()` The rule effect.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasActions()` Returns true if the Actions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasIpRanges()` Returns true if the IpRanges property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasNotActions()` Returns true if the NotActions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasNotIpRanges()` Returns true if the NotIpRanges property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasNotUserIds()` Returns true if the NotUserIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasUserIds()` Returns true if the UserIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`List<String>`	`ipRanges()` IPv4 CIDR ranges to include in the rule.
`String`	`name()` The rule name.
`List<String>`	`notActions()` Access protocol actions to exclude from the rule.
`List<String>`	`notIpRanges()` IPv4 CIDR ranges to exclude from the rule.
`List<String>`	`notUserIds()` User IDs to exclude from the rule.
`String`	`organizationId()` The identifier of the organization.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends PutAccessControlRuleRequest.Builder>`	`serializableBuilderClass()`
`PutAccessControlRuleRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`List<String>`	`userIds()` User IDs to include in the rule.

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
  - name
```
public final String name()
```
    The rule name.
    
    Returns:
    
    The rule name.
  - effect
```
public final AccessControlRuleEffect effect()
```
    The rule effect.
    
    If the service returns an enum value that is not available in the current SDK version, effect will return AccessControlRuleEffect.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from effectAsString().
    
    Returns:
    
    The rule effect.
    
    See Also:
    
    AccessControlRuleEffect
  - effectAsString
```
public final String effectAsString()
```
    The rule effect.
    
    If the service returns an enum value that is not available in the current SDK version, effect will return AccessControlRuleEffect.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from effectAsString().
    
    Returns:
    
    The rule effect.
    
    See Also:
    
    AccessControlRuleEffect
  - description
```
public final String description()
```
    The rule description.
    
    Returns:
    
    The rule description.
  - hasIpRanges
```
public final boolean hasIpRanges()
```
    Returns true if the IpRanges property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - ipRanges
```
public final List<String> ipRanges()
```
    IPv4 CIDR ranges to include in the rule.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasIpRanges() to see if a value was sent in this field.
    
    Returns:
    
    IPv4 CIDR ranges to include in the rule.
  - hasNotIpRanges
```
public final boolean hasNotIpRanges()
```
    Returns true if the NotIpRanges property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - notIpRanges
```
public final List<String> notIpRanges()
```
    IPv4 CIDR ranges to exclude from the rule.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasNotIpRanges() to see if a value was sent in this field.
    
    Returns:
    
    IPv4 CIDR ranges to exclude from the rule.
  - hasActions
```
public final boolean hasActions()
```
    Returns true if the Actions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - actions
```
public final List<String> actions()
```
    Access protocol actions to include in the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasActions() to see if a value was sent in this field.
    
    Returns:
    
    Access protocol actions to include in the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
  - hasNotActions
```
public final boolean hasNotActions()
```
    Returns true if the NotActions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - notActions
```
public final List<String> notActions()
```
    Access protocol actions to exclude from the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasNotActions() to see if a value was sent in this field.
    
    Returns:
    
    Access protocol actions to exclude from the rule. Valid values include ActiveSync, AutoDiscover, EWS, IMAP, SMTP, WindowsOutlook, and WebMail.
  - hasUserIds
```
public final boolean hasUserIds()
```
    Returns true if the UserIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - userIds
```
public final List<String> userIds()
```
    User IDs to include in the rule.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasUserIds() to see if a value was sent in this field.
    
    Returns:
    
    User IDs to include in the rule.
  - hasNotUserIds
```
public final boolean hasNotUserIds()
```
    Returns true if the NotUserIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - notUserIds
```
public final List<String> notUserIds()
```
    User IDs to exclude from the rule.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasNotUserIds() to see if a value was sent in this field.
    
    Returns:
    
    User IDs to exclude from the rule.
  - organizationId
```
public final String organizationId()
```
    The identifier of the organization.
    
    Returns:
    
    The identifier of the organization.
  - toBuilder
```
public PutAccessControlRuleRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<PutAccessControlRuleRequest.Builder,PutAccessControlRuleRequest>
    
    Specified by:
    
    toBuilder in class WorkMailRequest
  - builder
```
public static PutAccessControlRuleRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends PutAccessControlRuleRequest.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 PutAccessControlRuleRequest

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

name

effect

effectAsString

description

hasIpRanges

ipRanges

hasNotIpRanges

notIpRanges

hasActions

actions

hasNotActions

notActions

hasUserIds

userIds

hasNotUserIds

notUserIds

organizationId

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields