Portal (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.workspacesweb.model.Portal

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

The web portal.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Portal()

Constructors
Constructor and Description
`Portal()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Portal`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getBrowserSettingsArn()` The ARN of the browser settings that is associated with this web portal.
`String`	`getBrowserType()` The browser that users see when using a streaming session.
`Date`	`getCreationDate()` The creation date of the web portal.
`String`	`getDisplayName()` The name of the web portal.
`String`	`getNetworkSettingsArn()` The ARN of the network settings that is associated with the web portal.
`String`	`getPortalArn()` The ARN of the web portal.
`String`	`getPortalEndpoint()` The endpoint URL of the web portal that users access in order to start streaming sessions.
`String`	`getPortalStatus()` The status of the web portal.
`String`	`getRendererType()` The renderer that is used in streaming sessions.
`String`	`getStatusReason()` A message that explains why the web portal is in its current status.
`String`	`getTrustStoreArn()` The ARN of the trust store that is associated with the web portal.
`String`	`getUserSettingsArn()` The ARN of the trust store that is associated with the web portal.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setBrowserSettingsArn(String browserSettingsArn)` The ARN of the browser settings that is associated with this web portal.
`void`	`setBrowserType(String browserType)` The browser that users see when using a streaming session.
`void`	`setCreationDate(Date creationDate)` The creation date of the web portal.
`void`	`setDisplayName(String displayName)` The name of the web portal.
`void`	`setNetworkSettingsArn(String networkSettingsArn)` The ARN of the network settings that is associated with the web portal.
`void`	`setPortalArn(String portalArn)` The ARN of the web portal.
`void`	`setPortalEndpoint(String portalEndpoint)` The endpoint URL of the web portal that users access in order to start streaming sessions.
`void`	`setPortalStatus(String portalStatus)` The status of the web portal.
`void`	`setRendererType(String rendererType)` The renderer that is used in streaming sessions.
`void`	`setStatusReason(String statusReason)` A message that explains why the web portal is in its current status.
`void`	`setTrustStoreArn(String trustStoreArn)` The ARN of the trust store that is associated with the web portal.
`void`	`setUserSettingsArn(String userSettingsArn)` The ARN of the trust store that is associated with the web portal.
`String`	`toString()` Returns a string representation of this object.
`Portal`	`withBrowserSettingsArn(String browserSettingsArn)` The ARN of the browser settings that is associated with this web portal.
`Portal`	`withBrowserType(BrowserType browserType)` The browser that users see when using a streaming session.
`Portal`	`withBrowserType(String browserType)` The browser that users see when using a streaming session.
`Portal`	`withCreationDate(Date creationDate)` The creation date of the web portal.
`Portal`	`withDisplayName(String displayName)` The name of the web portal.
`Portal`	`withNetworkSettingsArn(String networkSettingsArn)` The ARN of the network settings that is associated with the web portal.
`Portal`	`withPortalArn(String portalArn)` The ARN of the web portal.
`Portal`	`withPortalEndpoint(String portalEndpoint)` The endpoint URL of the web portal that users access in order to start streaming sessions.
`Portal`	`withPortalStatus(PortalStatus portalStatus)` The status of the web portal.
`Portal`	`withPortalStatus(String portalStatus)` The status of the web portal.
`Portal`	`withRendererType(RendererType rendererType)` The renderer that is used in streaming sessions.
`Portal`	`withRendererType(String rendererType)` The renderer that is used in streaming sessions.
`Portal`	`withStatusReason(String statusReason)` A message that explains why the web portal is in its current status.
`Portal`	`withTrustStoreArn(String trustStoreArn)` The ARN of the trust store that is associated with the web portal.
`Portal`	`withUserSettingsArn(String userSettingsArn)` The ARN of the trust store that is associated with the web portal.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Portal
```
public Portal()
```
- Method Detail
  - setBrowserSettingsArn
```
public void setBrowserSettingsArn(String browserSettingsArn)
```
    The ARN of the browser settings that is associated with this web portal.
    
    Parameters:
    
    browserSettingsArn - The ARN of the browser settings that is associated with this web portal.
  - getBrowserSettingsArn
```
public String getBrowserSettingsArn()
```
    The ARN of the browser settings that is associated with this web portal.
    
    Returns:
    
    The ARN of the browser settings that is associated with this web portal.
  - withBrowserSettingsArn
```
public Portal withBrowserSettingsArn(String browserSettingsArn)
```
    The ARN of the browser settings that is associated with this web portal.
    
    Parameters:
    
    browserSettingsArn - The ARN of the browser settings that is associated with this web portal.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setBrowserType
```
public void setBrowserType(String browserType)
```
    The browser that users see when using a streaming session.
    
    Parameters:
    
    browserType - The browser that users see when using a streaming session.
    
    See Also:
    
    BrowserType
  - getBrowserType
```
public String getBrowserType()
```
    The browser that users see when using a streaming session.
    
    Returns:
    
    The browser that users see when using a streaming session.
    
    See Also:
    
    BrowserType
  - withBrowserType
```
public Portal withBrowserType(String browserType)
```
    The browser that users see when using a streaming session.
    
    Parameters:
    
    browserType - The browser that users see when using a streaming session.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BrowserType
  - withBrowserType
```
public Portal withBrowserType(BrowserType browserType)
```
    The browser that users see when using a streaming session.
    
    Parameters:
    
    browserType - The browser that users see when using a streaming session.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    BrowserType
  - setCreationDate
```
public void setCreationDate(Date creationDate)
```
    The creation date of the web portal.
    
    Parameters:
    
    creationDate - The creation date of the web portal.
  - getCreationDate
```
public Date getCreationDate()
```
    The creation date of the web portal.
    
    Returns:
    
    The creation date of the web portal.
  - withCreationDate
```
public Portal withCreationDate(Date creationDate)
```
    The creation date of the web portal.
    
    Parameters:
    
    creationDate - The creation date of the web portal.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDisplayName
```
public void setDisplayName(String displayName)
```
    The name of the web portal.
    
    Parameters:
    
    displayName - The name of the web portal.
  - getDisplayName
```
public String getDisplayName()
```
    The name of the web portal.
    
    Returns:
    
    The name of the web portal.
  - withDisplayName
```
public Portal withDisplayName(String displayName)
```
    The name of the web portal.
    
    Parameters:
    
    displayName - The name of the web portal.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNetworkSettingsArn
```
public void setNetworkSettingsArn(String networkSettingsArn)
```
    The ARN of the network settings that is associated with the web portal.
    
    Parameters:
    
    networkSettingsArn - The ARN of the network settings that is associated with the web portal.
  - getNetworkSettingsArn
```
public String getNetworkSettingsArn()
```
    The ARN of the network settings that is associated with the web portal.
    
    Returns:
    
    The ARN of the network settings that is associated with the web portal.
  - withNetworkSettingsArn
```
public Portal withNetworkSettingsArn(String networkSettingsArn)
```
    The ARN of the network settings that is associated with the web portal.
    
    Parameters:
    
    networkSettingsArn - The ARN of the network settings that is associated with the web portal.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPortalArn
```
public void setPortalArn(String portalArn)
```
    The ARN of the web portal.
    
    Parameters:
    
    portalArn - The ARN of the web portal.
  - getPortalArn
```
public String getPortalArn()
```
    The ARN of the web portal.
    
    Returns:
    
    The ARN of the web portal.
  - withPortalArn
```
public Portal withPortalArn(String portalArn)
```
    The ARN of the web portal.
    
    Parameters:
    
    portalArn - The ARN of the web portal.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPortalEndpoint
```
public void setPortalEndpoint(String portalEndpoint)
```
    The endpoint URL of the web portal that users access in order to start streaming sessions.
    
    Parameters:
    
    portalEndpoint - The endpoint URL of the web portal that users access in order to start streaming sessions.
  - getPortalEndpoint
```
public String getPortalEndpoint()
```
    The endpoint URL of the web portal that users access in order to start streaming sessions.
    
    Returns:
    
    The endpoint URL of the web portal that users access in order to start streaming sessions.
  - withPortalEndpoint
```
public Portal withPortalEndpoint(String portalEndpoint)
```
    The endpoint URL of the web portal that users access in order to start streaming sessions.
    
    Parameters:
    
    portalEndpoint - The endpoint URL of the web portal that users access in order to start streaming sessions.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPortalStatus
```
public void setPortalStatus(String portalStatus)
```
    The status of the web portal.
    
    Parameters:
    
    portalStatus - The status of the web portal.
    
    See Also:
    
    PortalStatus
  - getPortalStatus
```
public String getPortalStatus()
```
    The status of the web portal.
    
    Returns:
    
    The status of the web portal.
    
    See Also:
    
    PortalStatus
  - withPortalStatus
```
public Portal withPortalStatus(String portalStatus)
```
    The status of the web portal.
    
    Parameters:
    
    portalStatus - The status of the web portal.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PortalStatus
  - withPortalStatus
```
public Portal withPortalStatus(PortalStatus portalStatus)
```
    The status of the web portal.
    
    Parameters:
    
    portalStatus - The status of the web portal.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    PortalStatus
  - setRendererType
```
public void setRendererType(String rendererType)
```
    The renderer that is used in streaming sessions.
    
    Parameters:
    
    rendererType - The renderer that is used in streaming sessions.
    
    See Also:
    
    RendererType
  - getRendererType
```
public String getRendererType()
```
    The renderer that is used in streaming sessions.
    
    Returns:
    
    The renderer that is used in streaming sessions.
    
    See Also:
    
    RendererType
  - withRendererType
```
public Portal withRendererType(String rendererType)
```
    The renderer that is used in streaming sessions.
    
    Parameters:
    
    rendererType - The renderer that is used in streaming sessions.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RendererType
  - withRendererType
```
public Portal withRendererType(RendererType rendererType)
```
    The renderer that is used in streaming sessions.
    
    Parameters:
    
    rendererType - The renderer that is used in streaming sessions.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    RendererType
  - setStatusReason
```
public void setStatusReason(String statusReason)
```
    A message that explains why the web portal is in its current status.
    
    Parameters:
    
    statusReason - A message that explains why the web portal is in its current status.
  - getStatusReason
```
public String getStatusReason()
```
    A message that explains why the web portal is in its current status.
    
    Returns:
    
    A message that explains why the web portal is in its current status.
  - withStatusReason
```
public Portal withStatusReason(String statusReason)
```
    A message that explains why the web portal is in its current status.
    
    Parameters:
    
    statusReason - A message that explains why the web portal is in its current status.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTrustStoreArn
```
public void setTrustStoreArn(String trustStoreArn)
```
    The ARN of the trust store that is associated with the web portal.
    
    Parameters:
    
    trustStoreArn - The ARN of the trust store that is associated with the web portal.
  - getTrustStoreArn
```
public String getTrustStoreArn()
```
    The ARN of the trust store that is associated with the web portal.
    
    Returns:
    
    The ARN of the trust store that is associated with the web portal.
  - withTrustStoreArn
```
public Portal withTrustStoreArn(String trustStoreArn)
```
    The ARN of the trust store that is associated with the web portal.
    
    Parameters:
    
    trustStoreArn - The ARN of the trust store that is associated with the web portal.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUserSettingsArn
```
public void setUserSettingsArn(String userSettingsArn)
```
    The ARN of the trust store that is associated with the web portal.
    
    Parameters:
    
    userSettingsArn - The ARN of the trust store that is associated with the web portal.
  - getUserSettingsArn
```
public String getUserSettingsArn()
```
    The ARN of the trust store that is associated with the web portal.
    
    Returns:
    
    The ARN of the trust store that is associated with the web portal.
  - withUserSettingsArn
```
public Portal withUserSettingsArn(String userSettingsArn)
```
    The ARN of the trust store that is associated with the web portal.
    
    Parameters:
    
    userSettingsArn - The ARN of the trust store that is associated with the web portal.
    
    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 Portal clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class Portal

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Portal

Method Detail

setBrowserSettingsArn

getBrowserSettingsArn

withBrowserSettingsArn

setBrowserType

getBrowserType

withBrowserType

withBrowserType

setCreationDate

getCreationDate

withCreationDate

setDisplayName

getDisplayName

withDisplayName

setNetworkSettingsArn

getNetworkSettingsArn

withNetworkSettingsArn

setPortalArn

getPortalArn

withPortalArn

setPortalEndpoint

getPortalEndpoint

withPortalEndpoint

setPortalStatus

getPortalStatus

withPortalStatus

withPortalStatus

setRendererType

getRendererType

withRendererType

withRendererType

setStatusReason

getStatusReason

withStatusReason

setTrustStoreArn

getTrustStoreArn

withTrustStoreArn

setUserSettingsArn

getUserSettingsArn

withUserSettingsArn

toString

equals

hashCode

clone

marshall