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

Interface DescribePortalResponse.Builder

    • Method Detail

      • portalId

        DescribePortalResponse.Builder portalId​(String portalId)

        The ID of the portal.

        Parameters:
        portalId - The ID of the portal.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • portalArn

        DescribePortalResponse.Builder portalArn​(String portalArn)

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

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

        Parameters:
        portalArn - The ARN of the portal, which has the following format.

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

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

      • portalName

        DescribePortalResponse.Builder portalName​(String portalName)

        The name of the portal.

        Parameters:
        portalName - The name of the portal.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • portalDescription

        DescribePortalResponse.Builder portalDescription​(String portalDescription)

        The portal's description.

        Parameters:
        portalDescription - The portal's description.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • portalClientId

        DescribePortalResponse.Builder portalClientId​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • portalStartUrl

        DescribePortalResponse.Builder portalStartUrl​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • portalContactEmail

        DescribePortalResponse.Builder portalContactEmail​(String portalContactEmail)

        The Amazon Web Services administrator's contact email address.

        Parameters:
        portalContactEmail - The Amazon Web Services administrator's contact email address.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • portalStatus

        DescribePortalResponse.Builder portalStatus​(PortalStatus portalStatus)

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

        Parameters:
        portalStatus - The current status of the portal, which contains a state and any error message.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • portalCreationDate

        DescribePortalResponse.Builder portalCreationDate​(Instant portalCreationDate)

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

        Parameters:
        portalCreationDate - The date the portal was created, in Unix epoch time.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • portalLastUpdateDate

        DescribePortalResponse.Builder portalLastUpdateDate​(Instant portalLastUpdateDate)

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

        Parameters:
        portalLastUpdateDate - The date the portal was last updated, in Unix epoch time.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • portalLogoImageLocation

        DescribePortalResponse.Builder portalLogoImageLocation​(ImageLocation portalLogoImageLocation)

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

        Parameters:
        portalLogoImageLocation - The portal's logo image, which is available at a URL.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • portalAuthMode

        DescribePortalResponse.Builder portalAuthMode​(String portalAuthMode)

        The service to use to authenticate users to the portal.

        Parameters:
        portalAuthMode - The service to use to authenticate users to the portal.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AuthMode, AuthMode

      • portalAuthMode

        DescribePortalResponse.Builder portalAuthMode​(AuthMode portalAuthMode)

        The service to use to authenticate users to the portal.

        Parameters:
        portalAuthMode - The service to use to authenticate users to the portal.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AuthMode, AuthMode

      • notificationSenderEmail

        DescribePortalResponse.Builder notificationSenderEmail​(String notificationSenderEmail)

        The email address that sends alarm notifications.

        Parameters:
        notificationSenderEmail - The email address that sends alarm notifications.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • alarms

        DescribePortalResponse.Builder alarms​(Alarms alarms)

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

        Parameters:
        alarms - Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal.
        Returns:
        Returns a reference to this object so that method calls can be chained together.