Interface DescribePortalResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<DescribePortalResponse.Builder,DescribePortalResponse>, IoTSiteWiseResponse.Builder, SdkBuilder<DescribePortalResponse.Builder,DescribePortalResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
DescribePortalResponse

public static interface DescribePortalResponse.Builder extends IoTSiteWiseResponse.Builder, SdkPojo, CopyableBuilder<DescribePortalResponse.Builder,DescribePortalResponse>
  • Method Details

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

      default DescribePortalResponse.Builder portalStatus(Consumer<PortalStatus.Builder> portalStatus)

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

      This is a convenience method that creates an instance of the PortalStatus.Builder avoiding the need to create one manually via PortalStatus.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to portalStatus(PortalStatus).

      Parameters:
      portalStatus - a consumer that will call methods on PortalStatus.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • 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.
    • portalLogoImageLocation

      default DescribePortalResponse.Builder portalLogoImageLocation(Consumer<ImageLocation.Builder> portalLogoImageLocation)

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

      This is a convenience method that creates an instance of the ImageLocation.Builder avoiding the need to create one manually via ImageLocation.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to portalLogoImageLocation(ImageLocation).

      Parameters:
      portalLogoImageLocation - a consumer that will call methods on ImageLocation.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • roleArn

      The ARN of the service role that allows the portal's users to access your IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the IoT SiteWise User Guide.

      Parameters:
      roleArn - The ARN of the service role that allows the portal's users to access your IoT SiteWise resources on your behalf. For more information, see Using service roles for IoT SiteWise Monitor in the IoT SiteWise User Guide.
      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:
    • 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:
    • 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

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

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

      This is a convenience method that creates an instance of the Alarms.Builder avoiding the need to create one manually via Alarms.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to alarms(Alarms).

      Parameters:
      alarms - a consumer that will call methods on Alarms.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: