software.amazon.awssdk.services.sagemaker.model

Class DescribeDomainResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.sagemaker.model.SageMakerResponse

software.amazon.awssdk.services.sagemaker.model.DescribeDomainResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeDomainResponse.Builder,DescribeDomainResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeDomainResponse.Builder

Method Summary

Modifier and Type	Method and Description
AppNetworkAccessType	appNetworkAccessType() Specifies the VPC used for non-EFS traffic.
String	appNetworkAccessTypeAsString() Specifies the VPC used for non-EFS traffic.
AuthMode	authMode() The domain's authentication mode.
String	authModeAsString() The domain's authentication mode.
static DescribeDomainResponse.Builder	builder()
Instant	creationTime() The creation time.
UserSettings	defaultUserSettings() Settings which are applied to all UserProfiles in this domain, if settings are not explicitly specified in a given UserProfile.
String	domainArn() The domain's Amazon Resource Name (ARN).
String	domainId() The domain ID.
String	domainName() The domain name.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	failureReason() The failure reason.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasSubnetIds() Returns true if the SubnetIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
String	homeEfsFileSystemId() The ID of the Amazon Elastic File System (EFS) managed by this Domain.
String	homeEfsFileSystemKmsKeyId() This member is deprecated and replaced with KmsKeyId.
String	kmsKeyId() The AWS KMS customer managed CMK used to encrypt the EFS volume attached to the domain.
Instant	lastModifiedTime() The last modified time.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeDomainResponse.Builder>	serializableBuilderClass()
String	singleSignOnManagedApplicationInstanceId() The SSO managed application instance ID.
DomainStatus	status() The status.
String	statusAsString() The status.
List<String>	subnetIds() The VPC subnets that Studio uses for communication.
DescribeDomainResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	url() The domain's URL.
String	vpcId() The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

Methods inherited from class software.amazon.awssdk.services.sagemaker.model.SageMakerResponse

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

domainArn

public String domainArn()

The domain's Amazon Resource Name (ARN).

Returns:

The domain's Amazon Resource Name (ARN).

domainId

public String domainId()

The domain ID.

Returns:

The domain ID.

domainName

public String domainName()

The domain name.

Returns:

The domain name.

homeEfsFileSystemId

public String homeEfsFileSystemId()

The ID of the Amazon Elastic File System (EFS) managed by this Domain.

Returns:

The ID of the Amazon Elastic File System (EFS) managed by this Domain.

singleSignOnManagedApplicationInstanceId

public String singleSignOnManagedApplicationInstanceId()

The SSO managed application instance ID.

Returns:

The SSO managed application instance ID.

status

public DomainStatus status()

The status.

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

Returns:

The status.

See Also:

DomainStatus

statusAsString

public String statusAsString()

The status.

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

Returns:

The status.

See Also:

DomainStatus

creationTime

public Instant creationTime()

The creation time.

Returns:

The creation time.

lastModifiedTime

public Instant lastModifiedTime()

The last modified time.

Returns:

The last modified time.

failureReason

public String failureReason()

The failure reason.

Returns:

The failure reason.

authMode

public AuthMode authMode()

The domain's authentication mode.

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

Returns:

The domain's authentication mode.

See Also:

AuthMode

authModeAsString

public String authModeAsString()

The domain's authentication mode.

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

Returns:

The domain's authentication mode.

See Also:

AuthMode

defaultUserSettings

public UserSettings defaultUserSettings()

Settings which are applied to all UserProfiles in this domain, if settings are not explicitly specified in a given UserProfile.

Returns:

Settings which are applied to all UserProfiles in this domain, if settings are not explicitly specified in a given UserProfile.

appNetworkAccessType

public AppNetworkAccessType appNetworkAccessType()

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.

• PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access

• VpcOnly - All Studio traffic is through the specified VPC and subnets

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

Returns:

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.

• PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access

• VpcOnly - All Studio traffic is through the specified VPC and subnets

See Also:

AppNetworkAccessType

appNetworkAccessTypeAsString

public String appNetworkAccessTypeAsString()

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.

• PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access

• VpcOnly - All Studio traffic is through the specified VPC and subnets

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

Returns:

Specifies the VPC used for non-EFS traffic. The default value is PublicInternetOnly.

• PublicInternetOnly - Non-EFS traffic is through a VPC managed by Amazon SageMaker, which allows direct internet access

• VpcOnly - All Studio traffic is through the specified VPC and subnets

See Also:

AppNetworkAccessType

homeEfsFileSystemKmsKeyId

public String homeEfsFileSystemKmsKeyId()

This member is deprecated and replaced with KmsKeyId.

Returns:

This member is deprecated and replaced with KmsKeyId.

hasSubnetIds

public boolean hasSubnetIds()

Returns true if the SubnetIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

subnetIds

public List<String> subnetIds()

The VPC subnets that Studio uses for communication.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasSubnetIds() to see if a value was sent in this field.

Returns:

The VPC subnets that Studio uses for communication.

url

public String url()

The domain's URL.

Returns:

The domain's URL.

vpcId

public String vpcId()

The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

Returns:

The ID of the Amazon Virtual Private Cloud (VPC) that Studio uses for communication.

kmsKeyId

public String kmsKeyId()

The AWS KMS customer managed CMK used to encrypt the EFS volume attached to the domain.

Returns:

The AWS KMS customer managed CMK used to encrypt the EFS volume attached to the domain.

toBuilder

public DescribeDomainResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeDomainResponse.Builder,DescribeDomainResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static DescribeDomainResponse.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo