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

Class CreatePresignedDomainUrlRequest

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.CreatePresignedDomainUrlRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreatePresignedDomainUrlRequest.Builder,CreatePresignedDomainUrlRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreatePresignedDomainUrlRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreatePresignedDomainUrlRequest.Builder	builder()
String	domainId()	The domain ID.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Integer	expiresInSeconds()	The number of seconds until the pre-signed URL expires.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	landingUri()	The landing page that the user is directed to when accessing the presigned URL.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreatePresignedDomainUrlRequest.Builder>	serializableBuilderClass()
Integer	sessionExpirationDurationInSeconds()	The session expiration duration in seconds.
String	spaceName()	The name of the space.
CreatePresignedDomainUrlRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userProfileName()	The name of the UserProfile to sign-in as.

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 domain ID.

Returns:

The domain ID.

userProfileName

public final String userProfileName()

The name of the UserProfile to sign-in as.

Returns:

The name of the UserProfile to sign-in as.

sessionExpirationDurationInSeconds

public final Integer sessionExpirationDurationInSeconds()

The session expiration duration in seconds. This value defaults to 43200.

Returns:

The session expiration duration in seconds. This value defaults to 43200.

expiresInSeconds

public final Integer expiresInSeconds()

The number of seconds until the pre-signed URL expires. This value defaults to 300.

Returns:

The number of seconds until the pre-signed URL expires. This value defaults to 300.

spaceName

public final String spaceName()

The name of the space.

Returns:

The name of the space.

landingUri

public final String landingUri()

The landing page that the user is directed to when accessing the presigned URL. Using this value, users can access Studio or Studio Classic, even if it is not the default experience for the domain. The supported values are:

• studio::relative/path: Directs users to the relative path in Studio.

• app:JupyterServer:relative/path: Directs users to the relative path in the Studio Classic application.

• app:JupyterLab:relative/path: Directs users to the relative path in the JupyterLab application.

• app:RStudioServerPro:relative/path: Directs users to the relative path in the RStudio application.

• app:CodeEditor:relative/path: Directs users to the relative path in the Code Editor, based on Code-OSS, Visual Studio Code - Open Source application.

• app:Canvas:relative/path: Directs users to the relative path in the Canvas application.

Returns:

The landing page that the user is directed to when accessing the presigned URL. Using this value, users can access Studio or Studio Classic, even if it is not the default experience for the domain. The supported values are:

• studio::relative/path: Directs users to the relative path in Studio.

• app:JupyterServer:relative/path: Directs users to the relative path in the Studio Classic application.

• app:JupyterLab:relative/path: Directs users to the relative path in the JupyterLab application.

• app:RStudioServerPro:relative/path: Directs users to the relative path in the RStudio application.

• app:CodeEditor:relative/path: Directs users to the relative path in the Code Editor, based on Code-OSS, Visual Studio Code - Open Source application.

• app:Canvas:relative/path: Directs users to the relative path in the Canvas application.

toBuilder

public CreatePresignedDomainUrlRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreatePresignedDomainUrlRequest.Builder,CreatePresignedDomainUrlRequest>

Specified by:

toBuilder in class SageMakerRequest

builder

public static CreatePresignedDomainUrlRequest.Builder builder()

serializableBuilderClass

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