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

Interface UpdatePortalRequest.Builder

    • Method Detail

      • portalId

        UpdatePortalRequest.Builder portalId​(String portalId)

        The ID of the portal to update.

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

      • portalName

        UpdatePortalRequest.Builder portalName​(String portalName)

        A new friendly name for the portal.

        Parameters:
        portalName - A new friendly name for the portal.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • portalDescription

        UpdatePortalRequest.Builder portalDescription​(String portalDescription)

        A new description for the portal.

        Parameters:
        portalDescription - A new description for the portal.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • portalContactEmail

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

      • portalLogoImage

        UpdatePortalRequest.Builder portalLogoImage​(Image portalLogoImage)
        Sets the value of the PortalLogoImage property for this object.
        Parameters:
        portalLogoImage - The new value for the PortalLogoImage property for this object.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • clientToken

        UpdatePortalRequest.Builder clientToken​(String clientToken)

        A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.

        Parameters:
        clientToken - A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • notificationSenderEmail

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

        UpdatePortalRequest.Builder alarms​(Alarms alarms)

        Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range. For more information, see Monitoring with alarms in the IoT SiteWise Application Guide.

        Parameters:
        alarms - Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range. For more information, see Monitoring with alarms in the IoT SiteWise Application Guide.
        Returns:
        Returns a reference to this object so that method calls can be chained together.