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

Class AmazonQSettings

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.AmazonQSettings

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AmazonQSettings.Builder,AmazonQSettings>

@Generated("software.amazon.awssdk:codegen")
public final class AmazonQSettings
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AmazonQSettings.Builder,AmazonQSettings>

A collection of settings that configure the Amazon Q experience within the domain.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AmazonQSettings.Builder

Method Summary

Modifier and Type	Method	Description
static AmazonQSettings.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	qProfileArn()	The ARN of the Amazon Q profile used within the domain.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends AmazonQSettings.Builder>	serializableBuilderClass()
FeatureStatus	status()	Whether Amazon Q has been enabled within the domain.
String	statusAsString()	Whether Amazon Q has been enabled within the domain.
AmazonQSettings.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

status

public final FeatureStatus status()

Whether Amazon Q has been enabled within the domain.

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

Returns:

Whether Amazon Q has been enabled within the domain.

See Also:

FeatureStatus

statusAsString

public final String statusAsString()

Whether Amazon Q has been enabled within the domain.

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

Returns:

Whether Amazon Q has been enabled within the domain.

See Also:

FeatureStatus

qProfileArn

public final String qProfileArn()

The ARN of the Amazon Q profile used within the domain.

Returns:

The ARN of the Amazon Q profile used within the domain.

toBuilder

public AmazonQSettings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AmazonQSettings.Builder,AmazonQSettings>

builder

public static AmazonQSettings.Builder builder()

serializableBuilderClass

public static Class<? extends AmazonQSettings.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

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