All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreatePresignedDomainUrlRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable 

See Also:

AWS API Documentation, Serialized Form

• Field Summary

  • Fields inherited from class com.amazonaws.AmazonWebServiceRequest

    NOOP

• Constructor Summary

  Constructors

  Constructor and Description
  CreatePresignedDomainUrlRequest ()

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  CreatePresignedDomainUrlRequest	clone () Creates a shallow clone of this object for all fields except the handler context.
  boolean	equals (Object obj)
  String	getDomainId () The domain ID.
  Integer	getExpiresInSeconds () The number of seconds until the pre-signed URL expires.
  String	getLandingUri () The landing page that the user is directed to when accessing the presigned URL.
  Integer	getSessionExpirationDurationInSeconds () The session expiration duration in seconds.
  String	getSpaceName () The name of the space.
  String	getUserProfileName () The name of the UserProfile to sign-in as.
  int	hashCode ()
  void	setDomainId (String domainId) The domain ID.
  void	setExpiresInSeconds (Integer expiresInSeconds) The number of seconds until the pre-signed URL expires.
  void	setLandingUri (String landingUri) The landing page that the user is directed to when accessing the presigned URL.
  void	setSessionExpirationDurationInSeconds (Integer sessionExpirationDurationInSeconds) The session expiration duration in seconds.
  void	setSpaceName (String spaceName) The name of the space.
  void	setUserProfileName (String userProfileName) The name of the UserProfile to sign-in as.
  String	toString () Returns a string representation of this object.
  CreatePresignedDomainUrlRequest	withDomainId (String domainId) The domain ID.
  CreatePresignedDomainUrlRequest	withExpiresInSeconds (Integer expiresInSeconds) The number of seconds until the pre-signed URL expires.
  CreatePresignedDomainUrlRequest	withLandingUri (String landingUri) The landing page that the user is directed to when accessing the presigned URL.
  CreatePresignedDomainUrlRequest	withSessionExpirationDurationInSeconds (Integer sessionExpirationDurationInSeconds) The session expiration duration in seconds.
  CreatePresignedDomainUrlRequest	withSpaceName (String spaceName) The name of the space.
  CreatePresignedDomainUrlRequest	withUserProfileName (String userProfileName) The name of the UserProfile to sign-in as.

  • Methods inherited from class com.amazonaws.AmazonWebServiceRequest

    addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

  • Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

• Constructor Detail

  • CreatePresignedDomainUrlRequest

    public CreatePresignedDomainUrlRequest()

• Method Detail

  • setDomainId

    public void setDomainId(String domainId)

    The domain ID.

    Parameters:

    domainId - The domain ID.

  • getDomainId

    public String getDomainId()

    The domain ID.

    Returns:

    The domain ID.

  • withDomainId

    public CreatePresignedDomainUrlRequest withDomainId(String domainId)

    The domain ID.

    Parameters:

    domainId - The domain ID.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setUserProfileName

    public void setUserProfileName(String userProfileName)

    The name of the UserProfile to sign-in as.

    Parameters:

    userProfileName - The name of the UserProfile to sign-in as.

  • getUserProfileName

    public String getUserProfileName()

    The name of the UserProfile to sign-in as.

    Returns:

    The name of the UserProfile to sign-in as.

  • withUserProfileName

    public CreatePresignedDomainUrlRequest withUserProfileName(String userProfileName)

    The name of the UserProfile to sign-in as.

    Parameters:

    userProfileName - The name of the UserProfile to sign-in as.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setSessionExpirationDurationInSeconds

    public void setSessionExpirationDurationInSeconds(Integer sessionExpirationDurationInSeconds)

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

    Parameters:

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

  • getSessionExpirationDurationInSeconds

    public Integer getSessionExpirationDurationInSeconds()

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

    Returns:

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

  • withSessionExpirationDurationInSeconds

    public CreatePresignedDomainUrlRequest withSessionExpirationDurationInSeconds(Integer sessionExpirationDurationInSeconds)

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

    Parameters:

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

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setExpiresInSeconds

    public void setExpiresInSeconds(Integer expiresInSeconds)

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

    Parameters:

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

  • getExpiresInSeconds

    public Integer getExpiresInSeconds()

    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.

  • withExpiresInSeconds

    public CreatePresignedDomainUrlRequest withExpiresInSeconds(Integer expiresInSeconds)

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

    Parameters:

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

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setSpaceName

    public void setSpaceName(String spaceName)

    The name of the space.

    Parameters:

    spaceName - The name of the space.

  • getSpaceName

    public String getSpaceName()

    The name of the space.

    Returns:

    The name of the space.

  • withSpaceName

    public CreatePresignedDomainUrlRequest withSpaceName(String spaceName)

    The name of the space.

    Parameters:

    spaceName - The name of the space.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setLandingUri

    public void setLandingUri(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.

    Parameters:

    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.

  • getLandingUri

    public String getLandingUri()

    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.

  • withLandingUri

    public CreatePresignedDomainUrlRequest withLandingUri(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.

    Parameters:

    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:

    Returns a reference to this object so that method calls can be chained together.

  • 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

    Returns:

    A string representation of this object.

    See Also:

    Object.toString()

  • equals

    public boolean equals(Object obj)

    Overrides:

    equals in class Object

  • hashCode

    public int hashCode()

    Overrides:

    hashCode in class Object

  • clone

    public CreatePresignedDomainUrlRequest clone()

    Description copied from class: AmazonWebServiceRequest
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

    Overrides:

    clone in class AmazonWebServiceRequest

    See Also:

    Object.clone()