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>

  • Method Details

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreatePresignedDomainUrlRequest.Builder,CreatePresignedDomainUrlRequest>
      Specified by:
      toBuilder in class SageMakerRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.