software.amazon.awssdk.services.iotsitewise.model

Interface UpdatePortalRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<UpdatePortalRequest.Builder,UpdatePortalRequest>, IoTSiteWiseRequest.Builder, SdkBuilder<UpdatePortalRequest.Builder,UpdatePortalRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

UpdatePortalRequest

public static interface UpdatePortalRequest.Builder
extends IoTSiteWiseRequest.Builder, SdkPojo, CopyableBuilder<UpdatePortalRequest.Builder,UpdatePortalRequest>

Method Summary

Modifier and Type	Method and Description
UpdatePortalRequest.Builder	alarms(Alarms alarms) Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal.
default UpdatePortalRequest.Builder	alarms(Consumer<Alarms.Builder> alarms) Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal.
UpdatePortalRequest.Builder	clientToken(String clientToken) A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.
UpdatePortalRequest.Builder	notificationSenderEmail(String notificationSenderEmail) The email address that sends alarm notifications.
UpdatePortalRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
UpdatePortalRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
UpdatePortalRequest.Builder	portalContactEmail(String portalContactEmail) The Amazon Web Services administrator's contact email address.
UpdatePortalRequest.Builder	portalDescription(String portalDescription) A new description for the portal.
UpdatePortalRequest.Builder	portalId(String portalId) The ID of the portal to update.
default UpdatePortalRequest.Builder	portalLogoImage(Consumer<Image.Builder> portalLogoImage) Sets the value of the PortalLogoImage property for this object.
UpdatePortalRequest.Builder	portalLogoImage(Image portalLogoImage) Sets the value of the PortalLogoImage property for this object.
UpdatePortalRequest.Builder	portalName(String portalName) A new friendly name for the portal.
UpdatePortalRequest.Builder	roleArn(String roleArn) The ARN of a service role that allows the portal's users to access your IoT SiteWise resources on your behalf.

Methods inherited from interface software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

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.

portalLogoImage

default UpdatePortalRequest.Builder portalLogoImage(Consumer<Image.Builder> portalLogoImage)

Sets the value of the PortalLogoImage property for this object. This is a convenience method that creates an instance of the Image.Builder avoiding the need to create one manually via Image.builder().

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

Parameters:

portalLogoImage - a consumer that will call methods on Image.Builder

Returns:

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

See Also:

portalLogoImage(Image)

roleArn

UpdatePortalRequest.Builder roleArn(String roleArn)

The ARN of a 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 a 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.

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.

alarms

default UpdatePortalRequest.Builder alarms(Consumer<Alarms.Builder> 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.

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:

alarms(Alarms)

overrideConfiguration

UpdatePortalRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

UpdatePortalRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder