software.amazon.awssdk.services.workmail.model

Class PutAccessControlRuleRequest

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

Method Summary

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() For responses, this returns true if the service returned a value for the Actions property.
int	hashCode()
boolean	hasImpersonationRoleIds() For responses, this returns true if the service returned a value for the ImpersonationRoleIds property.
boolean	hasIpRanges() For responses, this returns true if the service returned a value for the IpRanges property.
boolean	hasNotActions() For responses, this returns true if the service returned a value for the NotActions property.
boolean	hasNotImpersonationRoleIds() For responses, this returns true if the service returned a value for the NotImpersonationRoleIds property.
boolean	hasNotIpRanges() For responses, this returns true if the service returned a value for the NotIpRanges property.
boolean	hasNotUserIds() For responses, this returns true if the service returned a value for the NotUserIds property.
boolean	hasUserIds() For responses, this returns true if the service returned a value for the UserIds property.
List<String>	impersonationRoleIds() Impersonation role IDs to include in the rule.
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>	notImpersonationRoleIds() Impersonation role IDs 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()

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

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.

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

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.

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

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.

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, and WebMail.

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

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.

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, and WebMail.

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

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.

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

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.

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.

organizationId

public final String organizationId()

The identifier of the organization.

Returns:

The identifier of the organization.

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

impersonationRoleIds

public final List<String> 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 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.

notImpersonationRoleIds

public final List<String> 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

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