java.lang.Object
- software.amazon.awssdk.services.workspacesweb.model.Portal

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Portal.Builder,Portal>

@Generated("software.amazon.awssdk:codegen")
public final class Portal
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Portal.Builder,Portal>

The web portal.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface Portal.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AuthenticationType`	`authenticationType()`	The type of authentication integration points used when signing into the web portal.
`String`	`authenticationTypeAsString()`	The type of authentication integration points used when signing into the web portal.
`String`	`browserSettingsArn()`	The ARN of the browser settings that is associated with this web portal.
`BrowserType`	`browserType()`	The browser that users see when using a streaming session.
`String`	`browserTypeAsString()`	The browser that users see when using a streaming session.
`static Portal.Builder`	`builder()`
`Instant`	`creationDate()`	The creation date of the web portal.
`String`	`displayName()`	The name of the web portal.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`ipAccessSettingsArn()`	The ARN of the IP access settings.
`String`	`networkSettingsArn()`	The ARN of the network settings that is associated with the web portal.
`String`	`portalArn()`	The ARN of the web portal.
`String`	`portalEndpoint()`	The endpoint URL of the web portal that users access in order to start streaming sessions.
`PortalStatus`	`portalStatus()`	The status of the web portal.
`String`	`portalStatusAsString()`	The status of the web portal.
`RendererType`	`rendererType()`	The renderer that is used in streaming sessions.
`String`	`rendererTypeAsString()`	The renderer that is used in streaming sessions.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Portal.Builder>`	`serializableBuilderClass()`
`String`	`statusReason()`	A message that explains why the web portal is in its current status.
`Portal.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`trustStoreArn()`	The ARN of the trust store that is associated with the web portal.
`String`	`userAccessLoggingSettingsArn()`	The ARN of the user access logging settings that is associated with the web portal.
`String`	`userSettingsArn()`	The ARN of the user settings that is associated with the web portal.

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
  - authenticationType
```
public final 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.
    
    If the service returns an enum value that is not available in the current SDK version, authenticationType will return AuthenticationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationTypeAsString().
    
    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
  - authenticationTypeAsString
```
public final String authenticationTypeAsString()
```
    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.
    
    If the service returns an enum value that is not available in the current SDK version, authenticationType will return AuthenticationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationTypeAsString().
    
    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
  - browserSettingsArn
```
public final String browserSettingsArn()
```
    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.
  - browserType
```
public final BrowserType browserType()
```
    The browser that users see when using a streaming session.
    
    If the service returns an enum value that is not available in the current SDK version, browserType will return BrowserType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from browserTypeAsString().
    
    Returns:
    
    The browser that users see when using a streaming session.
    
    See Also:
    
    BrowserType
  - browserTypeAsString
```
public final String browserTypeAsString()
```
    The browser that users see when using a streaming session.
    
    If the service returns an enum value that is not available in the current SDK version, browserType will return BrowserType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from browserTypeAsString().
    
    Returns:
    
    The browser that users see when using a streaming session.
    
    See Also:
    
    BrowserType
  - creationDate
```
public final Instant creationDate()
```
    The creation date of the web portal.
    
    Returns:
    
    The creation date of the web portal.
  - displayName
```
public final String displayName()
```
    The name of the web portal.
    
    Returns:
    
    The name of the web portal.
  - ipAccessSettingsArn
```
public final String ipAccessSettingsArn()
```
    The ARN of the IP access settings.
    
    Returns:
    
    The ARN of the IP access settings.
  - networkSettingsArn
```
public final String networkSettingsArn()
```
    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.
  - portalArn
```
public final String portalArn()
```
    The ARN of the web portal.
    
    Returns:
    
    The ARN of the web portal.
  - portalEndpoint
```
public final String portalEndpoint()
```
    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.
  - portalStatus
```
public final PortalStatus portalStatus()
```
    The status of the web portal.
    
    If the service returns an enum value that is not available in the current SDK version, portalStatus will return PortalStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from portalStatusAsString().
    
    Returns:
    
    The status of the web portal.
    
    See Also:
    
    PortalStatus
  - portalStatusAsString
```
public final String portalStatusAsString()
```
    The status of the web portal.
    
    If the service returns an enum value that is not available in the current SDK version, portalStatus will return PortalStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from portalStatusAsString().
    
    Returns:
    
    The status of the web portal.
    
    See Also:
    
    PortalStatus
  - rendererType
```
public final RendererType rendererType()
```
    The renderer that is used in streaming sessions.
    
    If the service returns an enum value that is not available in the current SDK version, rendererType will return RendererType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from rendererTypeAsString().
    
    Returns:
    
    The renderer that is used in streaming sessions.
    
    See Also:
    
    RendererType
  - rendererTypeAsString
```
public final String rendererTypeAsString()
```
    The renderer that is used in streaming sessions.
    
    If the service returns an enum value that is not available in the current SDK version, rendererType will return RendererType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from rendererTypeAsString().
    
    Returns:
    
    The renderer that is used in streaming sessions.
    
    See Also:
    
    RendererType
  - statusReason
```
public final String statusReason()
```
    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.
  - trustStoreArn
```
public final String trustStoreArn()
```
    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.
  - userAccessLoggingSettingsArn
```
public final String userAccessLoggingSettingsArn()
```
    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.
  - userSettingsArn
```
public final String userSettingsArn()
```
    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.
  - toBuilder
```
public Portal.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Portal.Builder,Portal>
  - builder
```
public static Portal.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Portal.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - 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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Portal

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

authenticationType

authenticationTypeAsString

browserSettingsArn

browserType

browserTypeAsString

creationDate

displayName

ipAccessSettingsArn

networkSettingsArn

portalArn

portalEndpoint

portalStatus

portalStatusAsString

rendererType

rendererTypeAsString

statusReason

trustStoreArn

userAccessLoggingSettingsArn

userSettingsArn

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields