com.amazonaws.services.iotsitewise.model

Class CreatePortalRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iotsitewise.model.CreatePortalRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreatePortalRequest
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
CreatePortalRequest()

Method Summary

Modifier and Type	Method and Description
CreatePortalRequest	addTagsEntry(String key, String value) Add a single Tags entry
CreatePortalRequest	clearTagsEntries() Removes all the entries added into Tags.
CreatePortalRequest	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 AWS 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	getPortalAuthMode() The service to use to authenticate users to the portal.
String	getPortalContactEmail() The AWS administrator's contact email address.
String	getPortalDescription() A description for the portal.
ImageFile	getPortalLogoImageFile() A logo image to display in the portal.
String	getPortalName() A friendly name for the portal.
String	getRoleArn() The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf.
Map<String,String>	getTags() A list of key-value pairs that contain metadata for the portal.
int	hashCode()
void	setAlarms(Alarms alarms) Contains the configuration information of an alarm created in an AWS 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	setPortalAuthMode(String portalAuthMode) The service to use to authenticate users to the portal.
void	setPortalContactEmail(String portalContactEmail) The AWS administrator's contact email address.
void	setPortalDescription(String portalDescription) A description for the portal.
void	setPortalLogoImageFile(ImageFile portalLogoImageFile) A logo image to display in the portal.
void	setPortalName(String portalName) A friendly name for the portal.
void	setRoleArn(String roleArn) The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf.
void	setTags(Map<String,String> tags) A list of key-value pairs that contain metadata for the portal.
String	toString() Returns a string representation of this object.
CreatePortalRequest	withAlarms(Alarms alarms) Contains the configuration information of an alarm created in an AWS IoT SiteWise Monitor portal.
CreatePortalRequest	withClientToken(String clientToken) A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.
CreatePortalRequest	withNotificationSenderEmail(String notificationSenderEmail) The email address that sends alarm notifications.
CreatePortalRequest	withPortalAuthMode(AuthMode portalAuthMode) The service to use to authenticate users to the portal.
CreatePortalRequest	withPortalAuthMode(String portalAuthMode) The service to use to authenticate users to the portal.
CreatePortalRequest	withPortalContactEmail(String portalContactEmail) The AWS administrator's contact email address.
CreatePortalRequest	withPortalDescription(String portalDescription) A description for the portal.
CreatePortalRequest	withPortalLogoImageFile(ImageFile portalLogoImageFile) A logo image to display in the portal.
CreatePortalRequest	withPortalName(String portalName) A friendly name for the portal.
CreatePortalRequest	withRoleArn(String roleArn) The ARN of a service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf.
CreatePortalRequest	withTags(Map<String,String> tags) A list of key-value pairs that contain metadata for the portal.

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

CreatePortalRequest

public CreatePortalRequest()

Method Detail

setPortalName

public void setPortalName(String portalName)

A friendly name for the portal.

Parameters:

portalName - A friendly name for the portal.

getPortalName

public String getPortalName()

A friendly name for the portal.

Returns:

A friendly name for the portal.

withPortalName

public CreatePortalRequest withPortalName(String portalName)

A friendly name for the portal.

Parameters:

portalName - A 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 description for the portal.

Parameters:

portalDescription - A description for the portal.

getPortalDescription

public String getPortalDescription()

A description for the portal.

Returns:

A description for the portal.

withPortalDescription

public CreatePortalRequest withPortalDescription(String portalDescription)

A description for the portal.

Parameters:

portalDescription - A 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 AWS administrator's contact email address.

Parameters:

portalContactEmail - The AWS administrator's contact email address.

getPortalContactEmail

public String getPortalContactEmail()

The AWS administrator's contact email address.

Returns:

The AWS administrator's contact email address.

withPortalContactEmail

public CreatePortalRequest withPortalContactEmail(String portalContactEmail)

The AWS administrator's contact email address.

Parameters:

portalContactEmail - The AWS administrator's contact email address.

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 CreatePortalRequest 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.

setPortalLogoImageFile

public void setPortalLogoImageFile(ImageFile portalLogoImageFile)

A logo image to display in the portal. Upload a square, high-resolution image. The image is displayed on a dark background.

Parameters:

portalLogoImageFile - A logo image to display in the portal. Upload a square, high-resolution image. The image is displayed on a dark background.

getPortalLogoImageFile

public ImageFile getPortalLogoImageFile()

A logo image to display in the portal. Upload a square, high-resolution image. The image is displayed on a dark background.

Returns:

A logo image to display in the portal. Upload a square, high-resolution image. The image is displayed on a dark background.

withPortalLogoImageFile

public CreatePortalRequest withPortalLogoImageFile(ImageFile portalLogoImageFile)

A logo image to display in the portal. Upload a square, high-resolution image. The image is displayed on a dark background.

Parameters:

portalLogoImageFile - A logo image to display in the portal. Upload a square, high-resolution image. The image is displayed on a dark background.

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 AWS IoT SiteWise resources on your behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in the AWS IoT SiteWise User Guide.

Parameters:

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

getRoleArn

public String getRoleArn()

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

Returns:

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

withRoleArn

public CreatePortalRequest withRoleArn(String roleArn)

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

Parameters:

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

Returns:

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

getTags

public Map<String,String> getTags()

A list of key-value pairs that contain metadata for the portal. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.

Returns:

A list of key-value pairs that contain metadata for the portal. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.

setTags

public void setTags(Map<String,String> tags)

A list of key-value pairs that contain metadata for the portal. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.

Parameters:

tags - A list of key-value pairs that contain metadata for the portal. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.

withTags

public CreatePortalRequest withTags(Map<String,String> tags)

A list of key-value pairs that contain metadata for the portal. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.

Parameters:

tags - A list of key-value pairs that contain metadata for the portal. For more information, see Tagging your AWS IoT SiteWise resources in the AWS IoT SiteWise User Guide.

Returns:

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

addTagsEntry

public CreatePortalRequest addTagsEntry(String key,
                                        String value)

Add a single Tags entry

See Also:

withTags(java.util.Map<java.lang.String, java.lang.String>)

clearTagsEntries

public CreatePortalRequest clearTagsEntries()

Removes all the entries added into Tags.

Returns:

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

setPortalAuthMode

public void setPortalAuthMode(String portalAuthMode)

The service to use to authenticate users to the portal. Choose from the following options:

• SSO – The portal uses AWS Single Sign-On to authenticate users and manage user permissions. Before you can create a portal that uses AWS SSO, you must enable AWS SSO. For more information, see Enabling AWS SSO in the AWS IoT SiteWise User Guide. This option is only available in AWS Regions other than the China Regions.

• IAM – The portal uses AWS Identity and Access Management (IAM) to authenticate users and manage user permissions. This option is only available in the China Regions.

You can't change this value after you create a portal.

Default: SSO

Parameters:

portalAuthMode - The service to use to authenticate users to the portal. Choose from the following options:

• SSO – The portal uses AWS Single Sign-On to authenticate users and manage user permissions. Before you can create a portal that uses AWS SSO, you must enable AWS SSO. For more information, see Enabling AWS SSO in the AWS IoT SiteWise User Guide. This option is only available in AWS Regions other than the China Regions.

• IAM – The portal uses AWS Identity and Access Management (IAM) to authenticate users and manage user permissions. This option is only available in the China Regions.

You can't change this value after you create a portal.

Default: SSO

See Also:

AuthMode

getPortalAuthMode

public String getPortalAuthMode()

The service to use to authenticate users to the portal. Choose from the following options:

• SSO – The portal uses AWS Single Sign-On to authenticate users and manage user permissions. Before you can create a portal that uses AWS SSO, you must enable AWS SSO. For more information, see Enabling AWS SSO in the AWS IoT SiteWise User Guide. This option is only available in AWS Regions other than the China Regions.

• IAM – The portal uses AWS Identity and Access Management (IAM) to authenticate users and manage user permissions. This option is only available in the China Regions.

You can't change this value after you create a portal.

Default: SSO

Returns:

The service to use to authenticate users to the portal. Choose from the following options:

• SSO – The portal uses AWS Single Sign-On to authenticate users and manage user permissions. Before you can create a portal that uses AWS SSO, you must enable AWS SSO. For more information, see Enabling AWS SSO in the AWS IoT SiteWise User Guide. This option is only available in AWS Regions other than the China Regions.

• IAM – The portal uses AWS Identity and Access Management (IAM) to authenticate users and manage user permissions. This option is only available in the China Regions.

You can't change this value after you create a portal.

Default: SSO

See Also:

AuthMode

withPortalAuthMode

public CreatePortalRequest withPortalAuthMode(String portalAuthMode)

The service to use to authenticate users to the portal. Choose from the following options:

• SSO – The portal uses AWS Single Sign-On to authenticate users and manage user permissions. Before you can create a portal that uses AWS SSO, you must enable AWS SSO. For more information, see Enabling AWS SSO in the AWS IoT SiteWise User Guide. This option is only available in AWS Regions other than the China Regions.

• IAM – The portal uses AWS Identity and Access Management (IAM) to authenticate users and manage user permissions. This option is only available in the China Regions.

You can't change this value after you create a portal.

Default: SSO

Parameters:

portalAuthMode - The service to use to authenticate users to the portal. Choose from the following options:

• SSO – The portal uses AWS Single Sign-On to authenticate users and manage user permissions. Before you can create a portal that uses AWS SSO, you must enable AWS SSO. For more information, see Enabling AWS SSO in the AWS IoT SiteWise User Guide. This option is only available in AWS Regions other than the China Regions.

• IAM – The portal uses AWS Identity and Access Management (IAM) to authenticate users and manage user permissions. This option is only available in the China Regions.

You can't change this value after you create a portal.

Default: SSO

Returns:

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

See Also:

AuthMode

withPortalAuthMode

public CreatePortalRequest withPortalAuthMode(AuthMode portalAuthMode)

The service to use to authenticate users to the portal. Choose from the following options:

• SSO – The portal uses AWS Single Sign-On to authenticate users and manage user permissions. Before you can create a portal that uses AWS SSO, you must enable AWS SSO. For more information, see Enabling AWS SSO in the AWS IoT SiteWise User Guide. This option is only available in AWS Regions other than the China Regions.

• IAM – The portal uses AWS Identity and Access Management (IAM) to authenticate users and manage user permissions. This option is only available in the China Regions.

You can't change this value after you create a portal.

Default: SSO

Parameters:

portalAuthMode - The service to use to authenticate users to the portal. Choose from the following options:

• SSO – The portal uses AWS Single Sign-On to authenticate users and manage user permissions. Before you can create a portal that uses AWS SSO, you must enable AWS SSO. For more information, see Enabling AWS SSO in the AWS IoT SiteWise User Guide. This option is only available in AWS Regions other than the China Regions.

• IAM – The portal uses AWS Identity and Access Management (IAM) to authenticate users and manage user permissions. This option is only available in the China Regions.

You can't change this value after you create a portal.

Default: SSO

Returns:

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

See Also:

AuthMode

setNotificationSenderEmail

public void setNotificationSenderEmail(String notificationSenderEmail)

The email address that sends alarm notifications.

If you use the AWS IoT Events managed AWS Lambda function to manage your emails, you must verify the sender email address in Amazon SES.

Parameters:

notificationSenderEmail - The email address that sends alarm notifications.

If you use the AWS IoT Events managed AWS Lambda function to manage your emails, you must verify the sender email address in Amazon SES.

getNotificationSenderEmail

public String getNotificationSenderEmail()

The email address that sends alarm notifications.

If you use the AWS IoT Events managed AWS Lambda function to manage your emails, you must verify the sender email address in Amazon SES.

Returns:

The email address that sends alarm notifications.

If you use the AWS IoT Events managed AWS Lambda function to manage your emails, you must verify the sender email address in Amazon SES.

withNotificationSenderEmail

public CreatePortalRequest withNotificationSenderEmail(String notificationSenderEmail)

The email address that sends alarm notifications.

If you use the AWS IoT Events managed AWS Lambda function to manage your emails, you must verify the sender email address in Amazon SES.

Parameters:

notificationSenderEmail - The email address that sends alarm notifications.

If you use the AWS IoT Events managed AWS Lambda function to manage your emails, you must verify the sender email address in Amazon SES.

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 AWS 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 .

Parameters:

alarms - Contains the configuration information of an alarm created in an AWS 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 .

getAlarms

public Alarms getAlarms()

Contains the configuration information of an alarm created in an AWS 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 .

Returns:

Contains the configuration information of an alarm created in an AWS 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 .

withAlarms

public CreatePortalRequest withAlarms(Alarms alarms)

Contains the configuration information of an alarm created in an AWS 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 .

Parameters:

alarms - Contains the configuration information of an alarm created in an AWS 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 .

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 CreatePortalRequest 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()