/*
* Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.iotsitewise.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DescribePortalResult extends com.amazonaws.AmazonWebServiceResult
* The ID of the portal.
*
* The ARN of the portal,
* which has the following format.
*
*
* The name of the portal.
*
* The portal's description.
*
* The IAM Identity Center application generated client ID (used with IAM Identity Center APIs). IoT SiteWise
* includes
* 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.
*
* The Amazon Web Services administrator's contact email address.
*
* The current status of the portal, which contains a state and any error message.
*
* The date the portal was created, in Unix epoch time.
*
* The date the portal was last updated, in Unix epoch time.
*
* The portal's logo image, which is available at a URL.
*
* 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.
*
* The service to use to authenticate users to the portal.
*
* The email address that sends alarm notifications.
*
* Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal.
*
* The ID of the portal.
*
* The ID of the portal.
*
* The ID of the portal.
*
* The ARN of the portal,
* which has the following format.
*
* arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}
* portalClientId
for only portals that use IAM Identity Center to authenticate users.
* arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}
*
* arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}
*/
public void setPortalArn(String portalArn) {
this.portalArn = portalArn;
}
/**
*
* The ARN of the portal, * which has the following format. *
*
* arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}
*
* arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}
*/
public String getPortalArn() {
return this.portalArn;
}
/**
*
* The ARN of the portal, * which has the following format. *
*
* arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}
*
* arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribePortalResult withPortalArn(String portalArn) {
setPortalArn(portalArn);
return this;
}
/**
*
* The name of the portal. *
* * @param portalName * The name of the portal. */ public void setPortalName(String portalName) { this.portalName = portalName; } /** ** The name of the portal. *
* * @return The name of the portal. */ public String getPortalName() { return this.portalName; } /** ** The name of the portal. *
* * @param portalName * The name of the portal. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribePortalResult withPortalName(String portalName) { setPortalName(portalName); return this; } /** ** The portal's description. *
* * @param portalDescription * The portal's description. */ public void setPortalDescription(String portalDescription) { this.portalDescription = portalDescription; } /** ** The portal's description. *
* * @return The portal's description. */ public String getPortalDescription() { return this.portalDescription; } /** ** The portal's description. *
* * @param portalDescription * The portal's description. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribePortalResult withPortalDescription(String portalDescription) { setPortalDescription(portalDescription); return this; } /** *
* The IAM Identity Center application generated client ID (used with IAM Identity Center APIs). IoT SiteWise
* includes portalClientId
for only portals that use IAM Identity Center to authenticate users.
*
portalClientId
for only portals that use IAM Identity Center to authenticate users.
*/
public void setPortalClientId(String portalClientId) {
this.portalClientId = portalClientId;
}
/**
*
* The IAM Identity Center application generated client ID (used with IAM Identity Center APIs). IoT SiteWise
* includes portalClientId
for only portals that use IAM Identity Center to authenticate users.
*
portalClientId
for only portals that use IAM Identity Center to
* authenticate users.
*/
public String getPortalClientId() {
return this.portalClientId;
}
/**
*
* The IAM Identity Center application generated client ID (used with IAM Identity Center APIs). IoT SiteWise
* includes portalClientId
for only portals that use IAM Identity Center to authenticate users.
*
portalClientId
for only portals that use IAM Identity Center to authenticate users.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DescribePortalResult withPortalClientId(String portalClientId) {
setPortalClientId(portalClientId);
return this;
}
/**
* * 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. *
* * @param 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. */ public void setPortalStartUrl(String portalStartUrl) { this.portalStartUrl = 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. *
* * @return 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. */ public String getPortalStartUrl() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribePortalResult withPortalStartUrl(String portalStartUrl) { setPortalStartUrl(portalStartUrl); return this; } /** ** The Amazon Web Services administrator's contact email address. *
* * @param portalContactEmail * The Amazon Web Services administrator's contact email address. */ public void setPortalContactEmail(String portalContactEmail) { this.portalContactEmail = portalContactEmail; } /** ** The Amazon Web Services administrator's contact email address. *
* * @return The Amazon Web Services administrator's contact email address. */ public String getPortalContactEmail() { return this.portalContactEmail; } /** ** The Amazon Web Services administrator's contact email address. *
* * @param portalContactEmail * The Amazon Web Services administrator's contact email address. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribePortalResult withPortalContactEmail(String portalContactEmail) { setPortalContactEmail(portalContactEmail); return this; } /** ** The current status of the portal, which contains a state and any error message. *
* * @param portalStatus * The current status of the portal, which contains a state and any error message. */ public void setPortalStatus(PortalStatus portalStatus) { this.portalStatus = portalStatus; } /** ** The current status of the portal, which contains a state and any error message. *
* * @return The current status of the portal, which contains a state and any error message. */ public PortalStatus getPortalStatus() { return this.portalStatus; } /** ** The current status of the portal, which contains a state and any error message. *
* * @param portalStatus * The current status of the portal, which contains a state and any error message. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribePortalResult withPortalStatus(PortalStatus portalStatus) { setPortalStatus(portalStatus); return this; } /** ** The date the portal was created, in Unix epoch time. *
* * @param portalCreationDate * The date the portal was created, in Unix epoch time. */ public void setPortalCreationDate(java.util.Date portalCreationDate) { this.portalCreationDate = portalCreationDate; } /** ** The date the portal was created, in Unix epoch time. *
* * @return The date the portal was created, in Unix epoch time. */ public java.util.Date getPortalCreationDate() { return this.portalCreationDate; } /** ** The date the portal was created, in Unix epoch time. *
* * @param portalCreationDate * The date the portal was created, in Unix epoch time. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribePortalResult withPortalCreationDate(java.util.Date portalCreationDate) { setPortalCreationDate(portalCreationDate); return this; } /** ** The date the portal was last updated, in Unix epoch time. *
* * @param portalLastUpdateDate * The date the portal was last updated, in Unix epoch time. */ public void setPortalLastUpdateDate(java.util.Date portalLastUpdateDate) { this.portalLastUpdateDate = portalLastUpdateDate; } /** ** The date the portal was last updated, in Unix epoch time. *
* * @return The date the portal was last updated, in Unix epoch time. */ public java.util.Date getPortalLastUpdateDate() { return this.portalLastUpdateDate; } /** ** The date the portal was last updated, in Unix epoch time. *
* * @param portalLastUpdateDate * The date the portal was last updated, in Unix epoch time. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribePortalResult withPortalLastUpdateDate(java.util.Date portalLastUpdateDate) { setPortalLastUpdateDate(portalLastUpdateDate); return this; } /** ** The portal's logo image, which is available at a URL. *
* * @param portalLogoImageLocation * The portal's logo image, which is available at a URL. */ public void setPortalLogoImageLocation(ImageLocation portalLogoImageLocation) { this.portalLogoImageLocation = portalLogoImageLocation; } /** ** The portal's logo image, which is available at a URL. *
* * @return The portal's logo image, which is available at a URL. */ public ImageLocation getPortalLogoImageLocation() { return this.portalLogoImageLocation; } /** ** The portal's logo image, which is available at a URL. *
* * @param portalLogoImageLocation * The portal's logo image, which is available at a URL. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribePortalResult withPortalLogoImageLocation(ImageLocation portalLogoImageLocation) { setPortalLogoImageLocation(portalLogoImageLocation); return this; } /** ** 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. *
* * @param 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. */ public void setRoleArn(String roleArn) { this.roleArn = 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. *
* * @return 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. */ public String getRoleArn() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribePortalResult withRoleArn(String roleArn) { setRoleArn(roleArn); return this; } /** ** The service to use to authenticate users to the portal. *
* * @param portalAuthMode * The service to use to authenticate users to the portal. * @see AuthMode */ public void setPortalAuthMode(String portalAuthMode) { this.portalAuthMode = portalAuthMode; } /** ** The service to use to authenticate users to the portal. *
* * @return The service to use to authenticate users to the portal. * @see AuthMode */ public String getPortalAuthMode() { return this.portalAuthMode; } /** ** The service to use to authenticate users to the portal. *
* * @param portalAuthMode * The service to use to authenticate users to the portal. * @return Returns a reference to this object so that method calls can be chained together. * @see AuthMode */ public DescribePortalResult withPortalAuthMode(String portalAuthMode) { setPortalAuthMode(portalAuthMode); return this; } /** ** The service to use to authenticate users to the portal. *
* * @param portalAuthMode * The service to use to authenticate users to the portal. * @return Returns a reference to this object so that method calls can be chained together. * @see AuthMode */ public DescribePortalResult withPortalAuthMode(AuthMode portalAuthMode) { this.portalAuthMode = portalAuthMode.toString(); return this; } /** ** The email address that sends alarm notifications. *
* * @param notificationSenderEmail * The email address that sends alarm notifications. */ public void setNotificationSenderEmail(String notificationSenderEmail) { this.notificationSenderEmail = notificationSenderEmail; } /** ** The email address that sends alarm notifications. *
* * @return The email address that sends alarm notifications. */ public String getNotificationSenderEmail() { return this.notificationSenderEmail; } /** ** The email address that sends alarm notifications. *
* * @param notificationSenderEmail * The email address that sends alarm notifications. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribePortalResult withNotificationSenderEmail(String notificationSenderEmail) { setNotificationSenderEmail(notificationSenderEmail); return this; } /** ** Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal. *
* * @param alarms * Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal. */ public void setAlarms(Alarms alarms) { this.alarms = alarms; } /** ** Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal. *
* * @return Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal. */ public Alarms getAlarms() { return this.alarms; } /** ** Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal. *
* * @param alarms * Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal. * @return Returns a reference to this object so that method calls can be chained together. */ public DescribePortalResult withAlarms(Alarms alarms) { setAlarms(alarms); return this; } /** * 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. * * @return A string representation of this object. * * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getPortalId() != null) sb.append("PortalId: ").append(getPortalId()).append(","); if (getPortalArn() != null) sb.append("PortalArn: ").append(getPortalArn()).append(","); if (getPortalName() != null) sb.append("PortalName: ").append(getPortalName()).append(","); if (getPortalDescription() != null) sb.append("PortalDescription: ").append(getPortalDescription()).append(","); if (getPortalClientId() != null) sb.append("PortalClientId: ").append(getPortalClientId()).append(","); if (getPortalStartUrl() != null) sb.append("PortalStartUrl: ").append(getPortalStartUrl()).append(","); if (getPortalContactEmail() != null) sb.append("PortalContactEmail: ").append(getPortalContactEmail()).append(","); if (getPortalStatus() != null) sb.append("PortalStatus: ").append(getPortalStatus()).append(","); if (getPortalCreationDate() != null) sb.append("PortalCreationDate: ").append(getPortalCreationDate()).append(","); if (getPortalLastUpdateDate() != null) sb.append("PortalLastUpdateDate: ").append(getPortalLastUpdateDate()).append(","); if (getPortalLogoImageLocation() != null) sb.append("PortalLogoImageLocation: ").append(getPortalLogoImageLocation()).append(","); if (getRoleArn() != null) sb.append("RoleArn: ").append(getRoleArn()).append(","); if (getPortalAuthMode() != null) sb.append("PortalAuthMode: ").append(getPortalAuthMode()).append(","); if (getNotificationSenderEmail() != null) sb.append("NotificationSenderEmail: ").append(getNotificationSenderEmail()).append(","); if (getAlarms() != null) sb.append("Alarms: ").append(getAlarms()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof DescribePortalResult == false) return false; DescribePortalResult other = (DescribePortalResult) obj; if (other.getPortalId() == null ^ this.getPortalId() == null) return false; if (other.getPortalId() != null && other.getPortalId().equals(this.getPortalId()) == false) return false; if (other.getPortalArn() == null ^ this.getPortalArn() == null) return false; if (other.getPortalArn() != null && other.getPortalArn().equals(this.getPortalArn()) == false) return false; if (other.getPortalName() == null ^ this.getPortalName() == null) return false; if (other.getPortalName() != null && other.getPortalName().equals(this.getPortalName()) == false) return false; if (other.getPortalDescription() == null ^ this.getPortalDescription() == null) return false; if (other.getPortalDescription() != null && other.getPortalDescription().equals(this.getPortalDescription()) == false) return false; if (other.getPortalClientId() == null ^ this.getPortalClientId() == null) return false; if (other.getPortalClientId() != null && other.getPortalClientId().equals(this.getPortalClientId()) == false) return false; if (other.getPortalStartUrl() == null ^ this.getPortalStartUrl() == null) return false; if (other.getPortalStartUrl() != null && other.getPortalStartUrl().equals(this.getPortalStartUrl()) == false) return false; if (other.getPortalContactEmail() == null ^ this.getPortalContactEmail() == null) return false; if (other.getPortalContactEmail() != null && other.getPortalContactEmail().equals(this.getPortalContactEmail()) == false) return false; if (other.getPortalStatus() == null ^ this.getPortalStatus() == null) return false; if (other.getPortalStatus() != null && other.getPortalStatus().equals(this.getPortalStatus()) == false) return false; if (other.getPortalCreationDate() == null ^ this.getPortalCreationDate() == null) return false; if (other.getPortalCreationDate() != null && other.getPortalCreationDate().equals(this.getPortalCreationDate()) == false) return false; if (other.getPortalLastUpdateDate() == null ^ this.getPortalLastUpdateDate() == null) return false; if (other.getPortalLastUpdateDate() != null && other.getPortalLastUpdateDate().equals(this.getPortalLastUpdateDate()) == false) return false; if (other.getPortalLogoImageLocation() == null ^ this.getPortalLogoImageLocation() == null) return false; if (other.getPortalLogoImageLocation() != null && other.getPortalLogoImageLocation().equals(this.getPortalLogoImageLocation()) == false) return false; if (other.getRoleArn() == null ^ this.getRoleArn() == null) return false; if (other.getRoleArn() != null && other.getRoleArn().equals(this.getRoleArn()) == false) return false; if (other.getPortalAuthMode() == null ^ this.getPortalAuthMode() == null) return false; if (other.getPortalAuthMode() != null && other.getPortalAuthMode().equals(this.getPortalAuthMode()) == false) return false; if (other.getNotificationSenderEmail() == null ^ this.getNotificationSenderEmail() == null) return false; if (other.getNotificationSenderEmail() != null && other.getNotificationSenderEmail().equals(this.getNotificationSenderEmail()) == false) return false; if (other.getAlarms() == null ^ this.getAlarms() == null) return false; if (other.getAlarms() != null && other.getAlarms().equals(this.getAlarms()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getPortalId() == null) ? 0 : getPortalId().hashCode()); hashCode = prime * hashCode + ((getPortalArn() == null) ? 0 : getPortalArn().hashCode()); hashCode = prime * hashCode + ((getPortalName() == null) ? 0 : getPortalName().hashCode()); hashCode = prime * hashCode + ((getPortalDescription() == null) ? 0 : getPortalDescription().hashCode()); hashCode = prime * hashCode + ((getPortalClientId() == null) ? 0 : getPortalClientId().hashCode()); hashCode = prime * hashCode + ((getPortalStartUrl() == null) ? 0 : getPortalStartUrl().hashCode()); hashCode = prime * hashCode + ((getPortalContactEmail() == null) ? 0 : getPortalContactEmail().hashCode()); hashCode = prime * hashCode + ((getPortalStatus() == null) ? 0 : getPortalStatus().hashCode()); hashCode = prime * hashCode + ((getPortalCreationDate() == null) ? 0 : getPortalCreationDate().hashCode()); hashCode = prime * hashCode + ((getPortalLastUpdateDate() == null) ? 0 : getPortalLastUpdateDate().hashCode()); hashCode = prime * hashCode + ((getPortalLogoImageLocation() == null) ? 0 : getPortalLogoImageLocation().hashCode()); hashCode = prime * hashCode + ((getRoleArn() == null) ? 0 : getRoleArn().hashCode()); hashCode = prime * hashCode + ((getPortalAuthMode() == null) ? 0 : getPortalAuthMode().hashCode()); hashCode = prime * hashCode + ((getNotificationSenderEmail() == null) ? 0 : getNotificationSenderEmail().hashCode()); hashCode = prime * hashCode + ((getAlarms() == null) ? 0 : getAlarms().hashCode()); return hashCode; } @Override public DescribePortalResult clone() { try { return (DescribePortalResult) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } }