software.amazon.awssdk.services.workmail.model

Class GetImpersonationRoleEffectResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.workmail.model.WorkMailResponse

software.amazon.awssdk.services.workmail.model.GetImpersonationRoleEffectResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetImpersonationRoleEffectResponse.Builder,GetImpersonationRoleEffectResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetImpersonationRoleEffectResponse.Builder

Method Summary

Modifier and Type	Method and Description
static GetImpersonationRoleEffectResponse.Builder	builder()
AccessEffect	effect() Effect of the impersonation role on the target user based on its rules.
String	effectAsString() Effect of the impersonation role on the target user based on its rules.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMatchedRules() For responses, this returns true if the service returned a value for the MatchedRules property.
List<ImpersonationMatchedRule>	matchedRules() A list of the rules that match the input and produce the configured effect.
List<SdkField<?>>	sdkFields()
static Class<? extends GetImpersonationRoleEffectResponse.Builder>	serializableBuilderClass()
GetImpersonationRoleEffectResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
ImpersonationRoleType	type() The impersonation role type.
String	typeAsString() The impersonation role type.

Methods inherited from class software.amazon.awssdk.services.workmail.model.WorkMailResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

type

public final ImpersonationRoleType type()

The impersonation role type.

If the service returns an enum value that is not available in the current SDK version, type will return ImpersonationRoleType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The impersonation role type.

See Also:

ImpersonationRoleType

typeAsString

public final String typeAsString()

The impersonation role type.

If the service returns an enum value that is not available in the current SDK version, type will return ImpersonationRoleType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The impersonation role type.

See Also:

ImpersonationRoleType

effect

public final AccessEffect effect()

Effect of the impersonation role on the target user based on its rules. Available effects are ALLOW or DENY.

If the service returns an enum value that is not available in the current SDK version, effect will return AccessEffect.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from effectAsString().

Returns:

Effect of the impersonation role on the target user based on its rules. Available effects are ALLOW or DENY.

See Also:

AccessEffect

effectAsString

public final String effectAsString()

Effect of the impersonation role on the target user based on its rules. Available effects are ALLOW or DENY.

If the service returns an enum value that is not available in the current SDK version, effect will return AccessEffect.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from effectAsString().

Returns:

Effect of the impersonation role on the target user based on its rules. Available effects are ALLOW or DENY.

See Also:

AccessEffect

hasMatchedRules

public final boolean hasMatchedRules()

For responses, this returns true if the service returned a value for the MatchedRules 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.

matchedRules

public final List<ImpersonationMatchedRule> matchedRules()

A list of the rules that match the input and produce the configured effect.

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 hasMatchedRules() method.

Returns:

A list of the rules that match the input and produce the configured effect.

toBuilder

public GetImpersonationRoleEffectResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetImpersonationRoleEffectResponse.Builder,GetImpersonationRoleEffectResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static GetImpersonationRoleEffectResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetImpersonationRoleEffectResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo