software.amazon.awssdk.services.finspace.model

Class CreateKxUserRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.finspace.model.FinspaceRequest

software.amazon.awssdk.services.finspace.model.CreateKxUserRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateKxUserRequest.Builder,CreateKxUserRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateKxUserRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateKxUserRequest.Builder	builder()
String	clientToken() A token that ensures idempotency.
String	environmentId() A unique identifier for the kdb environment where you want to create a user.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	iamRole() The IAM role ARN that will be associated with the user.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateKxUserRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags() A list of key-value pairs to label the user.
CreateKxUserRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	userName() A unique identifier for the user.

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

environmentId

public final String environmentId()

A unique identifier for the kdb environment where you want to create a user.

Returns:

A unique identifier for the kdb environment where you want to create a user.

userName

public final String userName()

A unique identifier for the user.

Returns:

A unique identifier for the user.

iamRole

public final String iamRole()

The IAM role ARN that will be associated with the user.

Returns:

The IAM role ARN that will be associated with the user.

hasTags

public final boolean hasTags()

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

tags

public final Map<String,String> tags()

A list of key-value pairs to label the user. You can add up to 50 tags to a user.

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

Returns:

A list of key-value pairs to label the user. You can add up to 50 tags to a user.

clientToken

public final String clientToken()

A token that ensures idempotency. This token expires in 10 minutes.

Returns:

A token that ensures idempotency. This token expires in 10 minutes.

toBuilder

public CreateKxUserRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateKxUserRequest.Builder,CreateKxUserRequest>

Specified by:

toBuilder in class FinspaceRequest

builder

public static CreateKxUserRequest.Builder builder()

serializableBuilderClass

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