Package software.amazon.awssdk.services.iotsitewise.model

Class DescribePortalResponse

    • Method Detail

      • portalId

        public final String portalId()

        The ID of the portal.

        Returns:
        The ID of the portal.

      • portalArn

        public final String portalArn()

        The ARN of the portal, which has the following format.

        arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}

        Returns:
        The ARN of the portal, which has the following format.

        arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}

      • portalName

        public final String portalName()

        The name of the portal.

        Returns:
        The name of the portal.

      • portalDescription

        public final String portalDescription()

        The portal's description.

        Returns:
        The portal's description.

      • portalClientId

        public final String portalClientId()

        The IAM Identity Center application generated client ID (used with IAM Identity Center API operations). IoT SiteWise includes portalClientId for only portals that use IAM Identity Center to authenticate users.

        Returns:
        The IAM Identity Center application generated client ID (used with IAM Identity Center API operations). IoT SiteWise includes portalClientId for only portals that use IAM Identity Center to authenticate users.

      • portalStartUrl

        public final String portalStartUrl()

        The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that use IAM Identity Center for authentication. For portals that use IAM for authentication, you must use the IoT SiteWise console to get a URL that you can use to access the portal.

        Returns:
        The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that use IAM Identity Center for authentication. For portals that use IAM for authentication, you must use the IoT SiteWise console to get a URL that you can use to access the portal.

      • portalContactEmail

        public final String portalContactEmail()

        The Amazon Web Services administrator's contact email address.

        Returns:
        The Amazon Web Services administrator's contact email address.

      • portalStatus

        public final PortalStatus portalStatus()

        The current status of the portal, which contains a state and any error message.

        Returns:
        The current status of the portal, which contains a state and any error message.

      • portalCreationDate

        public final Instant portalCreationDate()

        The date the portal was created, in Unix epoch time.

        Returns:
        The date the portal was created, in Unix epoch time.

      • portalLastUpdateDate

        public final Instant portalLastUpdateDate()

        The date the portal was last updated, in Unix epoch time.

        Returns:
        The date the portal was last updated, in Unix epoch time.

      • portalLogoImageLocation

        public final ImageLocation portalLogoImageLocation()

        The portal's logo image, which is available at a URL.

        Returns:
        The portal's logo image, which is available at a URL.

      • portalAuthMode

        public final AuthMode portalAuthMode()

        The service to use to authenticate users to the portal.

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

        Returns:
        The service to use to authenticate users to the portal.
        See Also:
        AuthMode

      • portalAuthModeAsString

        public final String portalAuthModeAsString()

        The service to use to authenticate users to the portal.

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

        Returns:
        The service to use to authenticate users to the portal.
        See Also:
        AuthMode

      • notificationSenderEmail

        public final String notificationSenderEmail()

        The email address that sends alarm notifications.

        Returns:
        The email address that sends alarm notifications.

      • alarms

        public final Alarms alarms()

        Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal.

        Returns:
        Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal.

      • portalType

        public final PortalType portalType()

        Define the type of portal. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.

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

        Returns:
        Define the type of portal. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.
        See Also:
        PortalType

      • portalTypeAsString

        public final String portalTypeAsString()

        Define the type of portal. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.

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

        Returns:
        Define the type of portal. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.
        See Also:
        PortalType

      • hasPortalTypeConfiguration

        public final boolean hasPortalTypeConfiguration()
        For responses, this returns true if the service returned a value for the PortalTypeConfiguration 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.

      • portalTypeConfiguration

        public final Map<String,​PortalTypeEntry> portalTypeConfiguration()

        The configuration entry associated with the specific portal type. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2 .

        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 hasPortalTypeConfiguration() method.

        Returns:
        The configuration entry associated with the specific portal type. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.

      • 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