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

Class UpdatePortalRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseRequest

software.amazon.awssdk.services.iotsitewise.model.UpdatePortalRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdatePortalRequest.Builder,UpdatePortalRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UpdatePortalRequest
extends IoTSiteWiseRequest
implements ToCopyableBuilder<UpdatePortalRequest.Builder,UpdatePortalRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdatePortalRequest.Builder

Method Summary

Modifier and Type	Method	Description
Alarms	alarms()	Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal.
static UpdatePortalRequest.Builder	builder()
String	clientToken()	A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	notificationSenderEmail()	The email address that sends alarm notifications.
String	portalContactEmail()	The Amazon Web Services administrator's contact email address.
String	portalDescription()	A new description for the portal.
String	portalId()	The ID of the portal to update.
Image	portalLogoImage()	Returns the value of the PortalLogoImage property for this object.
String	portalName()	A new friendly name for the portal.
String	roleArn()	The ARN of a service role that allows the portal's users to access your IoT SiteWise resources on your behalf.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdatePortalRequest.Builder>	serializableBuilderClass()
UpdatePortalRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

portalId

public final String portalId()

The ID of the portal to update.

Returns:

The ID of the portal to update.

portalName

public final String portalName()

A new friendly name for the portal.

Returns:

A new friendly name for the portal.

portalDescription

public final String portalDescription()

A new description for the portal.

Returns:

A new description for the portal.

portalContactEmail

public final String portalContactEmail()

The Amazon Web Services administrator's contact email address.

Returns:

The Amazon Web Services administrator's contact email address.

portalLogoImage

public final Image portalLogoImage()

Returns the value of the PortalLogoImage property for this object.

Returns:

The value of the PortalLogoImage property for this object.

roleArn

public final 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.

Returns:

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.

clientToken

public final 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.

Returns:

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.

notificationSenderEmail

public final String notificationSenderEmail()

The email address that sends alarm notifications.

Returns:

The email address that sends alarm notifications.

alarms

public final 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.

Returns:

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.

toBuilder

public UpdatePortalRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdatePortalRequest.Builder,UpdatePortalRequest>

Specified by:

toBuilder in class IoTSiteWiseRequest

builder

public static UpdatePortalRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdatePortalRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo