Package software.amazon.awssdk.services.finspacedata.model

Class GetUserResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.finspacedata.model.FinspaceDataResponse

software.amazon.awssdk.services.finspacedata.model.GetUserResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetUserResponse.Builder,GetUserResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetUserResponse.Builder

Method Summary

Modifier and Type	Method	Description
ApiAccess	apiAccess()	Indicates whether the user can use the GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access other FinSpace Data API operations.
String	apiAccessAsString()	Indicates whether the user can use the GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access other FinSpace Data API operations.
String	apiAccessPrincipalArn()	The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials API to obtain a credentials token for a specific FinSpace user.
static GetUserResponse.Builder	builder()
Long	createTime()	The timestamp at which the user was created in FinSpace.
String	emailAddress()	The email address that is associated with the user.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	firstName()	The first name of the user.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Long	lastDisabledTime()	Describes the last time the user was deactivated.
Long	lastEnabledTime()	Describes the last time the user was activated.
Long	lastLoginTime()	Describes the last time that the user logged into their account.
Long	lastModifiedTime()	Describes the last time the user details were updated.
String	lastName()	The last name of the user.
List<SdkField<?>>	sdkFields()
static Class<? extends GetUserResponse.Builder>	serializableBuilderClass()
UserStatus	status()	The current status of the user.
String	statusAsString()	The current status of the user.
GetUserResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
UserType	type()	Indicates the type of user.
String	typeAsString()	Indicates the type of user.
String	userId()	The unique identifier for the user that is retrieved.

Methods inherited from class software.amazon.awssdk.services.finspacedata.model.FinspaceDataResponse

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

userId

public final String userId()

The unique identifier for the user that is retrieved.

Returns:

The unique identifier for the user that is retrieved.

status

public final UserStatus status()

The current status of the user.

• CREATING – The creation is in progress.

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

• DISABLED – The user is currently inactive.

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

Returns:

The current status of the user.

• CREATING – The creation is in progress.

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

• DISABLED – The user is currently inactive.

See Also:

UserStatus

statusAsString

public final String statusAsString()

The current status of the user.

• CREATING – The creation is in progress.

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

• DISABLED – The user is currently inactive.

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

Returns:

The current status of the user.

• CREATING – The creation is in progress.

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

• DISABLED – The user is currently inactive.

See Also:

UserStatus

firstName

public final String firstName()

The first name of the user.

Returns:

The first name of the user.

lastName

public final String lastName()

The last name of the user.

Returns:

The last name of the user.

emailAddress

public final String emailAddress()

The email address that is associated with the user.

Returns:

The email address that is associated with the user.

type

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

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

Returns:

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.

See Also:

UserType

typeAsString

public final String typeAsString()

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.

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

Returns:

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.

See Also:

UserType

apiAccess

public final ApiAccess apiAccess()

Indicates whether the user can use the GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access other FinSpace Data API operations.

• ENABLED – The user has permissions to use the APIs.

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

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

Returns:

Indicates whether the user can use the GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access other FinSpace Data API operations.

• ENABLED – The user has permissions to use the APIs.

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

See Also:

ApiAccess

apiAccessAsString

public final String apiAccessAsString()

Indicates whether the user can use the GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access other FinSpace Data API operations.

• ENABLED – The user has permissions to use the APIs.

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

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

Returns:

Indicates whether the user can use the GetProgrammaticAccessCredentials API to obtain credentials that can then be used to access other FinSpace Data API operations.

• ENABLED – The user has permissions to use the APIs.

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

See Also:

ApiAccess

apiAccessPrincipalArn

public final String apiAccessPrincipalArn()

The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.

Returns:

The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.

createTime

public final Long createTime()

The timestamp at which the user was created in FinSpace. The value is determined as epoch time in milliseconds.

Returns:

The timestamp at which the user was created in FinSpace. The value is determined as epoch time in milliseconds.

lastEnabledTime

public final Long lastEnabledTime()

Describes the last time the user was activated. The value is determined as epoch time in milliseconds.

Returns:

Describes the last time the user was activated. The value is determined as epoch time in milliseconds.

lastDisabledTime

public final Long lastDisabledTime()

Describes the last time the user was deactivated. The value is determined as epoch time in milliseconds.

Returns:

Describes the last time the user was deactivated. The value is determined as epoch time in milliseconds.

lastModifiedTime

public final Long lastModifiedTime()

Describes the last time the user details were updated. The value is determined as epoch time in milliseconds.

Returns:

Describes the last time the user details were updated. The value is determined as epoch time in milliseconds.

lastLoginTime

public final Long lastLoginTime()

Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.

Returns:

Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.

toBuilder

public GetUserResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetUserResponse.Builder,GetUserResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetUserResponse.Builder builder()

serializableBuilderClass

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