Interface DescribePortalResponse.Builder
- All Superinterfaces:
AwsResponse.Builder
,Buildable
,CopyableBuilder<DescribePortalResponse.Builder,
,DescribePortalResponse> IoTSiteWiseResponse.Builder
,SdkBuilder<DescribePortalResponse.Builder,
,DescribePortalResponse> SdkPojo
,SdkResponse.Builder
- Enclosing class:
DescribePortalResponse
-
Method Summary
Modifier and TypeMethodDescriptiondefault DescribePortalResponse.Builder
alarms
(Consumer<Alarms.Builder> alarms) Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal.Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal.notificationSenderEmail
(String notificationSenderEmail) The email address that sends alarm notifications.The ARN of the portal, which has the following format.portalAuthMode
(String portalAuthMode) The service to use to authenticate users to the portal.portalAuthMode
(AuthMode portalAuthMode) The service to use to authenticate users to the portal.portalClientId
(String portalClientId) The IAM Identity Center application generated client ID (used with IAM Identity Center API operations).portalContactEmail
(String portalContactEmail) The Amazon Web Services administrator's contact email address.portalCreationDate
(Instant portalCreationDate) The date the portal was created, in Unix epoch time.portalDescription
(String portalDescription) The portal's description.The ID of the portal.portalLastUpdateDate
(Instant portalLastUpdateDate) The date the portal was last updated, in Unix epoch time.default DescribePortalResponse.Builder
portalLogoImageLocation
(Consumer<ImageLocation.Builder> portalLogoImageLocation) The portal's logo image, which is available at a URL.portalLogoImageLocation
(ImageLocation portalLogoImageLocation) The portal's logo image, which is available at a URL.portalName
(String portalName) The name of the portal.portalStartUrl
(String portalStartUrl) The URL for the IoT SiteWise Monitor portal.default DescribePortalResponse.Builder
portalStatus
(Consumer<PortalStatus.Builder> portalStatus) The current status of the portal, which contains a state and any error message.portalStatus
(PortalStatus portalStatus) The current status of the portal, which contains a state and any error message.The ARN of the service role that allows the portal's users to access your IoT SiteWise resources on your behalf.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseResponse.Builder
build, responseMetadata, responseMetadata
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder
sdkHttpResponse, sdkHttpResponse
-
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
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
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
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
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 includesportalClientId
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
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
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
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
The current status of the portal, which contains a state and any error message.
This is a convenience method that creates an instance of thePortalStatus.Builder
avoiding the need to create one manually viaPortalStatus.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toportalStatus(PortalStatus)
.- Parameters:
portalStatus
- a consumer that will call methods onPortalStatus.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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
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
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 theImageLocation.Builder
avoiding the need to create one manually viaImageLocation.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toportalLogoImageLocation(ImageLocation)
.- Parameters:
portalLogoImageLocation
- a consumer that will call methods onImageLocation.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
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
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
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 theAlarms.Builder
avoiding the need to create one manually viaAlarms.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toalarms(Alarms)
.- Parameters:
alarms
- a consumer that will call methods onAlarms.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-