Package software.amazon.awssdk.services.workmail.model

Class CreateImpersonationRoleRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateImpersonationRoleRequest.Builder,CreateImpersonationRoleRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateImpersonationRoleRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateImpersonationRoleRequest.Builder	builder()
String	clientToken()	The idempotency token for the client request.
String	description()	The description of the new impersonation role.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasRules()	For responses, this returns true if the service returned a value for the Rules property.
String	name()	The name of the new impersonation role.
String	organizationId()	The WorkMail organization to create the new impersonation role within.
List<ImpersonationRule>	rules()	The list of rules for the impersonation role.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateImpersonationRoleRequest.Builder>	serializableBuilderClass()
CreateImpersonationRoleRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
ImpersonationRoleType	type()	The impersonation role's type.
String	typeAsString()	The impersonation role's type.

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

clientToken

public final String clientToken()

The idempotency token for the client request.

Returns:

The idempotency token for the client request.

organizationId

public final String organizationId()

The WorkMail organization to create the new impersonation role within.

Returns:

The WorkMail organization to create the new impersonation role within.

name

public final String name()

The name of the new impersonation role.

Returns:

The name of the new impersonation role.

type

public final ImpersonationRoleType type()

The impersonation role's type. The available impersonation role types are READ_ONLY or FULL_ACCESS.

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's type. The available impersonation role types are READ_ONLY or FULL_ACCESS.

See Also:

ImpersonationRoleType

typeAsString

public final String typeAsString()

The impersonation role's type. The available impersonation role types are READ_ONLY or FULL_ACCESS.

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's type. The available impersonation role types are READ_ONLY or FULL_ACCESS.

See Also:

ImpersonationRoleType

description

public final String description()

The description of the new impersonation role.

Returns:

The description of the new impersonation role.

hasRules

public final boolean hasRules()

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

rules

public final List<ImpersonationRule> rules()

The list of rules for the impersonation role.

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

Returns:

The list of rules for the impersonation role.

toBuilder

public CreateImpersonationRoleRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateImpersonationRoleRequest.Builder,CreateImpersonationRoleRequest>

Specified by:

toBuilder in class WorkMailRequest

builder

public static CreateImpersonationRoleRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateImpersonationRoleRequest.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