com.amazonaws.services.workspacesweb.model

Class PortalSummary

java.lang.Object

com.amazonaws.services.workspacesweb.model.PortalSummary

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

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

The summary of the portal.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
PortalSummary()

Method Summary

Modifier and Type	Method and Description
PortalSummary	clone()
boolean	equals(Object obj)
String	getAuthenticationType() The type of authentication integration points used when signing into the web portal.
String	getBrowserSettingsArn() The ARN of the browser settings that is associated with the web portal.
String	getBrowserType() The browser type of the web portal.
Date	getCreationDate() The creation date of the web portal.
String	getDisplayName() The name of the web portal.
String	getIpAccessSettingsArn() The ARN of the IP access settings.
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	getTrustStoreArn() The ARN of the trust that is associated with this web portal.
String	getUserAccessLoggingSettingsArn() The ARN of the user access logging settings that is associated with the web portal.
String	getUserSettingsArn() The ARN of the user settings that is associated with the web portal.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setAuthenticationType(String authenticationType) The type of authentication integration points used when signing into the web portal.
void	setBrowserSettingsArn(String browserSettingsArn) The ARN of the browser settings that is associated with the web portal.
void	setBrowserType(String browserType) The browser type of the web portal.
void	setCreationDate(Date creationDate) The creation date of the web portal.
void	setDisplayName(String displayName) The name of the web portal.
void	setIpAccessSettingsArn(String ipAccessSettingsArn) The ARN of the IP access settings.
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	setTrustStoreArn(String trustStoreArn) The ARN of the trust that is associated with this web portal.
void	setUserAccessLoggingSettingsArn(String userAccessLoggingSettingsArn) The ARN of the user access logging settings that is associated with the web portal.
void	setUserSettingsArn(String userSettingsArn) The ARN of the user settings that is associated with the web portal.
String	toString() Returns a string representation of this object.
PortalSummary	withAuthenticationType(AuthenticationType authenticationType) The type of authentication integration points used when signing into the web portal.
PortalSummary	withAuthenticationType(String authenticationType) The type of authentication integration points used when signing into the web portal.
PortalSummary	withBrowserSettingsArn(String browserSettingsArn) The ARN of the browser settings that is associated with the web portal.
PortalSummary	withBrowserType(BrowserType browserType) The browser type of the web portal.
PortalSummary	withBrowserType(String browserType) The browser type of the web portal.
PortalSummary	withCreationDate(Date creationDate) The creation date of the web portal.
PortalSummary	withDisplayName(String displayName) The name of the web portal.
PortalSummary	withIpAccessSettingsArn(String ipAccessSettingsArn) The ARN of the IP access settings.
PortalSummary	withNetworkSettingsArn(String networkSettingsArn) The ARN of the network settings that is associated with the web portal.
PortalSummary	withPortalArn(String portalArn) The ARN of the web portal.
PortalSummary	withPortalEndpoint(String portalEndpoint) The endpoint URL of the web portal that users access in order to start streaming sessions.
PortalSummary	withPortalStatus(PortalStatus portalStatus) The status of the web portal.
PortalSummary	withPortalStatus(String portalStatus) The status of the web portal.
PortalSummary	withRendererType(RendererType rendererType) The renderer that is used in streaming sessions.
PortalSummary	withRendererType(String rendererType) The renderer that is used in streaming sessions.
PortalSummary	withTrustStoreArn(String trustStoreArn) The ARN of the trust that is associated with this web portal.
PortalSummary	withUserAccessLoggingSettingsArn(String userAccessLoggingSettingsArn) The ARN of the user access logging settings that is associated with the web portal.
PortalSummary	withUserSettingsArn(String userSettingsArn) The ARN of the user settings that is associated with the web portal.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PortalSummary

public PortalSummary()

Method Detail

setAuthenticationType

public void setAuthenticationType(String authenticationType)

The type of authentication integration points used when signing into the web portal. Defaults to Standard.

Standard web portals are authenticated directly through your identity provider. You need to call CreateIdentityProvider to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.

IAM_Identity_Center web portals are authenticated through AWS IAM Identity Center (successor to AWS Single Sign-On). They provide additional features, such as IdP-initiated authentication. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.

Parameters:

authenticationType - The type of authentication integration points used when signing into the web portal. Defaults to Standard.

Standard web portals are authenticated directly through your identity provider. You need to call CreateIdentityProvider to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.

IAM_Identity_Center web portals are authenticated through AWS IAM Identity Center (successor to AWS Single Sign-On). They provide additional features, such as IdP-initiated authentication. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.

See Also:

AuthenticationType

getAuthenticationType

public String getAuthenticationType()

The type of authentication integration points used when signing into the web portal. Defaults to Standard.

Standard web portals are authenticated directly through your identity provider. You need to call CreateIdentityProvider to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.

IAM_Identity_Center web portals are authenticated through AWS IAM Identity Center (successor to AWS Single Sign-On). They provide additional features, such as IdP-initiated authentication. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.

Returns:

The type of authentication integration points used when signing into the web portal. Defaults to Standard.

Standard web portals are authenticated directly through your identity provider. You need to call CreateIdentityProvider to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.

IAM_Identity_Center web portals are authenticated through AWS IAM Identity Center (successor to AWS Single Sign-On). They provide additional features, such as IdP-initiated authentication. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.

See Also:

AuthenticationType

withAuthenticationType

public PortalSummary withAuthenticationType(String authenticationType)

The type of authentication integration points used when signing into the web portal. Defaults to Standard.

Standard web portals are authenticated directly through your identity provider. You need to call CreateIdentityProvider to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.

IAM_Identity_Center web portals are authenticated through AWS IAM Identity Center (successor to AWS Single Sign-On). They provide additional features, such as IdP-initiated authentication. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.

Parameters:

authenticationType - The type of authentication integration points used when signing into the web portal. Defaults to Standard.

Standard web portals are authenticated directly through your identity provider. You need to call CreateIdentityProvider to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.

IAM_Identity_Center web portals are authenticated through AWS IAM Identity Center (successor to AWS Single Sign-On). They provide additional features, such as IdP-initiated authentication. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.

Returns:

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

See Also:

AuthenticationType

withAuthenticationType

public PortalSummary withAuthenticationType(AuthenticationType authenticationType)

The type of authentication integration points used when signing into the web portal. Defaults to Standard.

Standard web portals are authenticated directly through your identity provider. You need to call CreateIdentityProvider to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.

IAM_Identity_Center web portals are authenticated through AWS IAM Identity Center (successor to AWS Single Sign-On). They provide additional features, such as IdP-initiated authentication. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.

Parameters:

authenticationType - The type of authentication integration points used when signing into the web portal. Defaults to Standard.

Standard web portals are authenticated directly through your identity provider. You need to call CreateIdentityProvider to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.

IAM_Identity_Center web portals are authenticated through AWS IAM Identity Center (successor to AWS Single Sign-On). They provide additional features, such as IdP-initiated authentication. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.

Returns:

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

See Also:

AuthenticationType

setBrowserSettingsArn

public void setBrowserSettingsArn(String browserSettingsArn)

The ARN of the browser settings that is associated with the web portal.

Parameters:

browserSettingsArn - The ARN of the browser settings that is associated with the web portal.

getBrowserSettingsArn

public String getBrowserSettingsArn()

The ARN of the browser settings that is associated with the web portal.

Returns:

The ARN of the browser settings that is associated with the web portal.

withBrowserSettingsArn

public PortalSummary withBrowserSettingsArn(String browserSettingsArn)

The ARN of the browser settings that is associated with the web portal.

Parameters:

browserSettingsArn - The ARN of the browser settings that is associated with the 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 type of the web portal.

Parameters:

browserType - The browser type of the web portal.

See Also:

BrowserType

getBrowserType

public String getBrowserType()

The browser type of the web portal.

Returns:

The browser type of the web portal.

See Also:

BrowserType

withBrowserType

public PortalSummary withBrowserType(String browserType)

The browser type of the web portal.

Parameters:

browserType - The browser type of the web portal.

Returns:

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

See Also:

BrowserType

withBrowserType

public PortalSummary withBrowserType(BrowserType browserType)

The browser type of the web portal.

Parameters:

browserType - The browser type of the web portal.

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

setIpAccessSettingsArn

public void setIpAccessSettingsArn(String ipAccessSettingsArn)

The ARN of the IP access settings.

Parameters:

ipAccessSettingsArn - The ARN of the IP access settings.

getIpAccessSettingsArn

public String getIpAccessSettingsArn()

The ARN of the IP access settings.

Returns:

The ARN of the IP access settings.

withIpAccessSettingsArn

public PortalSummary withIpAccessSettingsArn(String ipAccessSettingsArn)

The ARN of the IP access settings.

Parameters:

ipAccessSettingsArn - The ARN of the IP access settings.

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 PortalSummary 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 PortalSummary 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 PortalSummary 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 PortalSummary 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 PortalSummary 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 PortalSummary 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 PortalSummary 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

setTrustStoreArn

public void setTrustStoreArn(String trustStoreArn)

The ARN of the trust that is associated with this web portal.

Parameters:

trustStoreArn - The ARN of the trust that is associated with this web portal.

getTrustStoreArn

public String getTrustStoreArn()

The ARN of the trust that is associated with this web portal.

Returns:

The ARN of the trust that is associated with this web portal.

withTrustStoreArn

public PortalSummary withTrustStoreArn(String trustStoreArn)

The ARN of the trust that is associated with this web portal.

Parameters:

trustStoreArn - The ARN of the trust that is associated with this web portal.

Returns:

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

setUserAccessLoggingSettingsArn

public void setUserAccessLoggingSettingsArn(String userAccessLoggingSettingsArn)

The ARN of the user access logging settings that is associated with the web portal.

Parameters:

userAccessLoggingSettingsArn - The ARN of the user access logging settings that is associated with the web portal.

getUserAccessLoggingSettingsArn

public String getUserAccessLoggingSettingsArn()

The ARN of the user access logging settings that is associated with the web portal.

Returns:

The ARN of the user access logging settings that is associated with the web portal.

withUserAccessLoggingSettingsArn

public PortalSummary withUserAccessLoggingSettingsArn(String userAccessLoggingSettingsArn)

The ARN of the user access logging settings that is associated with the web portal.

Parameters:

userAccessLoggingSettingsArn - The ARN of the user access logging settings 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 user settings that is associated with the web portal.

Parameters:

userSettingsArn - The ARN of the user settings that is associated with the web portal.

getUserSettingsArn

public String getUserSettingsArn()

The ARN of the user settings that is associated with the web portal.

Returns:

The ARN of the user settings that is associated with the web portal.

withUserSettingsArn

public PortalSummary withUserSettingsArn(String userSettingsArn)

The ARN of the user settings that is associated with the web portal.

Parameters:

userSettingsArn - The ARN of the user settings 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 PortalSummary 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.