Class Portal

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:

  • Method Details

    • hasAdditionalEncryptionContext

      public final boolean hasAdditionalEncryptionContext()
      For responses, this returns true if the service returned a value for the AdditionalEncryptionContext property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • additionalEncryptionContext

      public final Map<String,String> additionalEncryptionContext()

      The additional encryption context of the portal.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAdditionalEncryptionContext() method.

      Returns:
      The additional encryption context of the portal.

    • 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 IAM Identity Center. 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 IAM Identity Center. 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:

    • 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 IAM Identity Center. 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 IAM Identity Center. 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:

    • 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:

    • 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:

    • creationDate

      public final Instant creationDate()

      The creation date of the web portal.

      Returns:
      The creation date of the web portal.

    • customerManagedKey

      public final String customerManagedKey()

      The customer managed key used to encrypt sensitive information in the portal.

      Returns:
      The customer managed key used to encrypt sensitive information in the portal.

    • dataProtectionSettingsArn

      public final String dataProtectionSettingsArn()

      The ARN of the data protection settings.

      Returns:
      The ARN of the data protection settings.

    • displayName

      public final String displayName()

      The name of the web portal.

      Returns:
      The name of the web portal.

    • instanceType

      public final InstanceType instanceType()

      The type and resources of the underlying instance.

      If the service returns an enum value that is not available in the current SDK version, instanceType will return InstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().

      Returns:
      The type and resources of the underlying instance.
      See Also:

    • instanceTypeAsString

      public final String instanceTypeAsString()

      The type and resources of the underlying instance.

      If the service returns an enum value that is not available in the current SDK version, instanceType will return InstanceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from instanceTypeAsString().

      Returns:
      The type and resources of the underlying instance.
      See Also:

    • ipAccessSettingsArn

      public final String ipAccessSettingsArn()

      The ARN of the IP access settings.

      Returns:
      The ARN of the IP access settings.

    • maxConcurrentSessions

      public final Integer maxConcurrentSessions()

      The maximum number of concurrent sessions for the portal.

      Returns:
      The maximum number of concurrent sessions for the portal.

    • 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:

    • 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:

    • 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:

    • 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:

    • 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()
      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<Portal.Builder,Portal>
      Returns:
      a builder for type T

    • 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)
      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)

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.