com.amazonaws.services.iotsitewise.model

Class UpdatePortalRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iotsitewise.model.UpdatePortalRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdatePortalRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdatePortalRequest()

Method Summary

Modifier and Type	Method and Description
UpdatePortalRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Alarms	getAlarms() Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal.
String	getClientToken() A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.
String	getNotificationSenderEmail() The email address that sends alarm notifications.
String	getPortalContactEmail() The Amazon Web Services administrator's contact email address.
String	getPortalDescription() A new description for the portal.
String	getPortalId() The ID of the portal to update.
Image	getPortalLogoImage()
String	getPortalName() A new friendly name for the portal.
String	getRoleArn() The ARN of a service role that allows the portal's users to access your IoT SiteWise resources on your behalf.
int	hashCode()
void	setAlarms(Alarms alarms) Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal.
void	setClientToken(String clientToken) A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.
void	setNotificationSenderEmail(String notificationSenderEmail) The email address that sends alarm notifications.
void	setPortalContactEmail(String portalContactEmail) The Amazon Web Services administrator's contact email address.
void	setPortalDescription(String portalDescription) A new description for the portal.
void	setPortalId(String portalId) The ID of the portal to update.
void	setPortalLogoImage(Image portalLogoImage)
void	setPortalName(String portalName) A new friendly name for the portal.
void	setRoleArn(String roleArn) The ARN of a service role that allows the portal's users to access your IoT SiteWise resources on your behalf.
String	toString() Returns a string representation of this object.
UpdatePortalRequest	withAlarms(Alarms alarms) Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal.
UpdatePortalRequest	withClientToken(String clientToken) A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.
UpdatePortalRequest	withNotificationSenderEmail(String notificationSenderEmail) The email address that sends alarm notifications.
UpdatePortalRequest	withPortalContactEmail(String portalContactEmail) The Amazon Web Services administrator's contact email address.
UpdatePortalRequest	withPortalDescription(String portalDescription) A new description for the portal.
UpdatePortalRequest	withPortalId(String portalId) The ID of the portal to update.
UpdatePortalRequest	withPortalLogoImage(Image portalLogoImage)
UpdatePortalRequest	withPortalName(String portalName) A new friendly name for the portal.
UpdatePortalRequest	withRoleArn(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 class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdatePortalRequest

public UpdatePortalRequest()

Method Detail

setPortalId

public void setPortalId(String portalId)

The ID of the portal to update.

Parameters:

portalId - The ID of the portal to update.

getPortalId

public String getPortalId()

The ID of the portal to update.

Returns:

The ID of the portal to update.

withPortalId

public UpdatePortalRequest withPortalId(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.

setPortalName

public void setPortalName(String portalName)

A new friendly name for the portal.

Parameters:

portalName - A new friendly name for the portal.

getPortalName

public String getPortalName()

A new friendly name for the portal.

Returns:

A new friendly name for the portal.

withPortalName

public UpdatePortalRequest withPortalName(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.

setPortalDescription

public void setPortalDescription(String portalDescription)

A new description for the portal.

Parameters:

portalDescription - A new description for the portal.

getPortalDescription

public String getPortalDescription()

A new description for the portal.

Returns:

A new description for the portal.

withPortalDescription

public UpdatePortalRequest withPortalDescription(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.

setPortalContactEmail

public void setPortalContactEmail(String portalContactEmail)

The Amazon Web Services administrator's contact email address.

Parameters:

portalContactEmail - The Amazon Web Services administrator's contact email address.

getPortalContactEmail

public String getPortalContactEmail()

The Amazon Web Services administrator's contact email address.

Returns:

The Amazon Web Services administrator's contact email address.

withPortalContactEmail

public UpdatePortalRequest withPortalContactEmail(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.

setPortalLogoImage

public void setPortalLogoImage(Image portalLogoImage)

Parameters:

portalLogoImage -

getPortalLogoImage

public Image getPortalLogoImage()

Returns:

withPortalLogoImage

public UpdatePortalRequest withPortalLogoImage(Image portalLogoImage)

Parameters:

portalLogoImage -

Returns:

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

setRoleArn

public void setRoleArn(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.

getRoleArn

public String getRoleArn()

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.

withRoleArn

public UpdatePortalRequest withRoleArn(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.

setClientToken

public void setClientToken(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.

getClientToken

public String getClientToken()

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.

withClientToken

public UpdatePortalRequest withClientToken(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.

setNotificationSenderEmail

public void setNotificationSenderEmail(String notificationSenderEmail)

The email address that sends alarm notifications.

Parameters:

notificationSenderEmail - The email address that sends alarm notifications.

getNotificationSenderEmail

public String getNotificationSenderEmail()

The email address that sends alarm notifications.

Returns:

The email address that sends alarm notifications.

withNotificationSenderEmail

public UpdatePortalRequest withNotificationSenderEmail(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.

setAlarms

public void setAlarms(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.

getAlarms

public Alarms getAlarms()

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.

withAlarms

public UpdatePortalRequest withAlarms(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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public UpdatePortalRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()