software.amazon.awssdk.services.finspacedata.model

Interface UserByPermissionGroup.Builder

All Superinterfaces:

Buildable, CopyableBuilder<UserByPermissionGroup.Builder,UserByPermissionGroup>, SdkBuilder<UserByPermissionGroup.Builder,UserByPermissionGroup>, SdkPojo

Enclosing class:

UserByPermissionGroup

public static interface UserByPermissionGroup.Builder
extends SdkPojo, CopyableBuilder<UserByPermissionGroup.Builder,UserByPermissionGroup>

Method Summary

Modifier and Type	Method and Description
UserByPermissionGroup.Builder	apiAccess(ApiAccess apiAccess) Indicates whether the user can access FinSpace API operations.
UserByPermissionGroup.Builder	apiAccess(String apiAccess) Indicates whether the user can access FinSpace API operations.
UserByPermissionGroup.Builder	apiAccessPrincipalArn(String apiAccessPrincipalArn) The IAM ARN identifier that is attached to FinSpace API calls.
UserByPermissionGroup.Builder	emailAddress(String emailAddress) The email address of the user.
UserByPermissionGroup.Builder	firstName(String firstName) The first name of the user.
UserByPermissionGroup.Builder	lastName(String lastName) The last name of the user.
UserByPermissionGroup.Builder	membershipStatus(PermissionGroupMembershipStatus membershipStatus) Indicates the status of the user account within a permission group.
UserByPermissionGroup.Builder	membershipStatus(String membershipStatus) Indicates the status of the user account within a permission group.
UserByPermissionGroup.Builder	status(String status) The current status of the user account.
UserByPermissionGroup.Builder	status(UserStatus status) The current status of the user account.
UserByPermissionGroup.Builder	type(String type) Indicates the type of user.
UserByPermissionGroup.Builder	type(UserType type) Indicates the type of user.
UserByPermissionGroup.Builder	userId(String userId) The unique identifier for the user.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

userId

UserByPermissionGroup.Builder userId(String userId)

The unique identifier for the user.

Parameters:

userId - The unique identifier for the user.

Returns:

Returns a reference to this object so that method calls can be chained together.

status

UserByPermissionGroup.Builder status(String status)

The current status of the user account.

• CREATING – The user account creation is in progress.

• ENABLED – The user account is created and is currently active.

• DISABLED – The user account is currently inactive.

Parameters:

status - The current status of the user account.

• CREATING – The user account creation is in progress.

• ENABLED – The user account is created and is currently active.

• DISABLED – The user account is currently inactive.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

UserStatus, UserStatus

status

UserByPermissionGroup.Builder status(UserStatus status)

The current status of the user account.

• CREATING – The user account creation is in progress.

• ENABLED – The user account is created and is currently active.

• DISABLED – The user account is currently inactive.

Parameters:

status - The current status of the user account.

• CREATING – The user account creation is in progress.

• ENABLED – The user account is created and is currently active.

• DISABLED – The user account is currently inactive.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

UserStatus, UserStatus

firstName

UserByPermissionGroup.Builder firstName(String firstName)

The first name of the user.

Parameters:

firstName - The first name of the user.

Returns:

Returns a reference to this object so that method calls can be chained together.

lastName

UserByPermissionGroup.Builder lastName(String lastName)

The last name of the user.

Parameters:

lastName - The last name of the user.

Returns:

Returns a reference to this object so that method calls can be chained together.

emailAddress

UserByPermissionGroup.Builder emailAddress(String emailAddress)

The email address of the user. The email address serves as a unique identifier for each user and cannot be changed after it's created.

Parameters:

emailAddress - The email address of the user. The email address serves as a unique identifier for each user and cannot be changed after it's created.

Returns:

Returns a reference to this object so that method calls can be chained together.

type

UserByPermissionGroup.Builder type(String type)

Indicates the type of user.

• SUPER_USER – A user with permission to all the functionality and data in FinSpace.

• APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.

Parameters:

type - Indicates the type of user.

• SUPER_USER – A user with permission to all the functionality and data in FinSpace.

• APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

UserType, UserType

type

UserByPermissionGroup.Builder type(UserType type)

Indicates the type of user.

• SUPER_USER – A user with permission to all the functionality and data in FinSpace.

• APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.

Parameters:

type - Indicates the type of user.

• SUPER_USER – A user with permission to all the functionality and data in FinSpace.

• APP_USER – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

UserType, UserType

apiAccess

UserByPermissionGroup.Builder apiAccess(String apiAccess)

Indicates whether the user can access FinSpace API operations.

• ENABLED – The user has permissions to use the API operations.

• DISABLED – The user does not have permissions to use any API operations.

Parameters:

apiAccess - Indicates whether the user can access FinSpace API operations.

• ENABLED – The user has permissions to use the API operations.

• DISABLED – The user does not have permissions to use any API operations.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ApiAccess, ApiAccess

apiAccess

UserByPermissionGroup.Builder apiAccess(ApiAccess apiAccess)

Indicates whether the user can access FinSpace API operations.

• ENABLED – The user has permissions to use the API operations.

• DISABLED – The user does not have permissions to use any API operations.

Parameters:

apiAccess - Indicates whether the user can access FinSpace API operations.

• ENABLED – The user has permissions to use the API operations.

• DISABLED – The user does not have permissions to use any API operations.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ApiAccess, ApiAccess

apiAccessPrincipalArn

UserByPermissionGroup.Builder apiAccessPrincipalArn(String apiAccessPrincipalArn)

The IAM ARN identifier that is attached to FinSpace API calls.

Parameters:

apiAccessPrincipalArn - The IAM ARN identifier that is attached to FinSpace API calls.

Returns:

Returns a reference to this object so that method calls can be chained together.

membershipStatus

UserByPermissionGroup.Builder membershipStatus(String membershipStatus)

Indicates the status of the user account within a permission group.

• ADDITION_IN_PROGRESS – The user account is currently being added to the permission group.

• ADDITION_SUCCESS – The user account is successfully added to the permission group.

• REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.

Parameters:

membershipStatus - Indicates the status of the user account within a permission group.

• ADDITION_IN_PROGRESS – The user account is currently being added to the permission group.

• ADDITION_SUCCESS – The user account is successfully added to the permission group.

• REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PermissionGroupMembershipStatus, PermissionGroupMembershipStatus

membershipStatus

UserByPermissionGroup.Builder membershipStatus(PermissionGroupMembershipStatus membershipStatus)

Indicates the status of the user account within a permission group.

• ADDITION_IN_PROGRESS – The user account is currently being added to the permission group.

• ADDITION_SUCCESS – The user account is successfully added to the permission group.

• REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.

Parameters:

membershipStatus - Indicates the status of the user account within a permission group.

• ADDITION_IN_PROGRESS – The user account is currently being added to the permission group.

• ADDITION_SUCCESS – The user account is successfully added to the permission group.

• REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

PermissionGroupMembershipStatus, PermissionGroupMembershipStatus