Package software.amazon.awssdk.services.sagemaker.model

Class CreateUserProfileRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.sagemaker.model.SageMakerRequest

software.amazon.awssdk.services.sagemaker.model.CreateUserProfileRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateUserProfileRequest.Builder,CreateUserProfileRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateUserProfileRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateUserProfileRequest.Builder	builder()
String	domainId()	The ID of the associated Domain.
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.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateUserProfileRequest.Builder>	serializableBuilderClass()
String	singleSignOnUserIdentifier()	A specifier for the type of value specified in SingleSignOnUserValue.
String	singleSignOnUserValue()	The username of the associated Amazon Web Services Single Sign-On User for this UserProfile.
List<Tag>	tags()	Each tag consists of a key and an optional value.
CreateUserProfileRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userProfileName()	A name for the UserProfile.
UserSettings	userSettings()	A collection of settings.

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

domainId

public final String domainId()

The ID of the associated Domain.

Returns:

The ID of the associated Domain.

userProfileName

public final String userProfileName()

A name for the UserProfile. This value is not case sensitive.

Returns:

A name for the UserProfile. This value is not case sensitive.

singleSignOnUserIdentifier

public final String singleSignOnUserIdentifier()

A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is "UserName". If the Domain's AuthMode is IAM Identity Center, this field is required. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.

Returns:

A specifier for the type of value specified in SingleSignOnUserValue. Currently, the only supported value is "UserName". If the Domain's AuthMode is IAM Identity Center, this field is required. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.

singleSignOnUserValue

public final String singleSignOnUserValue()

The username of the associated Amazon Web Services Single Sign-On User for this UserProfile. If the Domain's AuthMode is IAM Identity Center, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.

Returns:

The username of the associated Amazon Web Services Single Sign-On User for this UserProfile. If the Domain's AuthMode is IAM Identity Center, this field is required, and must match a valid username of a user in your directory. If the Domain's AuthMode is not IAM Identity Center, this field cannot be specified.

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 List<Tag> tags()

Each tag consists of a key and an optional value. Tag keys must be unique per resource.

Tags that you specify for the User Profile are also added to all Apps that the User Profile launches.

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:

Each tag consists of a key and an optional value. Tag keys must be unique per resource.

Tags that you specify for the User Profile are also added to all Apps that the User Profile launches.

userSettings

public final UserSettings userSettings()

A collection of settings.

Returns:

A collection of settings.

toBuilder

public CreateUserProfileRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateUserProfileRequest.Builder,CreateUserProfileRequest>

Specified by:

toBuilder in class SageMakerRequest

builder

public static CreateUserProfileRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo