/*
* 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 CreatePortalResult extends com.amazonaws.AmazonWebServiceResult
* The ID of the created portal.
*
* The ARN of the portal,
* which has the following format.
*
*
* 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 status of the portal, which contains a state (
* The associated IAM Identity Center application ID, if the portal uses IAM Identity Center.
*
* The ID of the created portal.
*
* The ID of the created portal.
*
* The ID of the created portal.
*
* The ARN of the portal,
* which has the following format.
*
* arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}
* CREATING
after successfully calling this
* operation) and any error message.
* 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 CreatePortalResult withPortalArn(String portalArn) {
setPortalArn(portalArn);
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 CreatePortalResult withPortalStartUrl(String portalStartUrl) { setPortalStartUrl(portalStartUrl); return this; } /** *
* The status of the portal, which contains a state (CREATING
after successfully calling this
* operation) and any error message.
*
CREATING
after successfully calling this
* operation) and any error message.
*/
public void setPortalStatus(PortalStatus portalStatus) {
this.portalStatus = portalStatus;
}
/**
*
* The status of the portal, which contains a state (CREATING
after successfully calling this
* operation) and any error message.
*
CREATING
after successfully calling this
* operation) and any error message.
*/
public PortalStatus getPortalStatus() {
return this.portalStatus;
}
/**
*
* The status of the portal, which contains a state (CREATING
after successfully calling this
* operation) and any error message.
*
CREATING
after successfully calling this
* operation) and any error message.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreatePortalResult withPortalStatus(PortalStatus portalStatus) {
setPortalStatus(portalStatus);
return this;
}
/**
* * The associated IAM Identity Center application ID, if the portal uses IAM Identity Center. *
* * @param ssoApplicationId * The associated IAM Identity Center application ID, if the portal uses IAM Identity Center. */ public void setSsoApplicationId(String ssoApplicationId) { this.ssoApplicationId = ssoApplicationId; } /** ** The associated IAM Identity Center application ID, if the portal uses IAM Identity Center. *
* * @return The associated IAM Identity Center application ID, if the portal uses IAM Identity Center. */ public String getSsoApplicationId() { return this.ssoApplicationId; } /** ** The associated IAM Identity Center application ID, if the portal uses IAM Identity Center. *
* * @param ssoApplicationId * The associated IAM Identity Center application ID, if the portal uses IAM Identity Center. * @return Returns a reference to this object so that method calls can be chained together. */ public CreatePortalResult withSsoApplicationId(String ssoApplicationId) { setSsoApplicationId(ssoApplicationId); 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 (getPortalStartUrl() != null) sb.append("PortalStartUrl: ").append(getPortalStartUrl()).append(","); if (getPortalStatus() != null) sb.append("PortalStatus: ").append(getPortalStatus()).append(","); if (getSsoApplicationId() != null) sb.append("SsoApplicationId: ").append(getSsoApplicationId()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof CreatePortalResult == false) return false; CreatePortalResult other = (CreatePortalResult) 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.getPortalStartUrl() == null ^ this.getPortalStartUrl() == null) return false; if (other.getPortalStartUrl() != null && other.getPortalStartUrl().equals(this.getPortalStartUrl()) == 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.getSsoApplicationId() == null ^ this.getSsoApplicationId() == null) return false; if (other.getSsoApplicationId() != null && other.getSsoApplicationId().equals(this.getSsoApplicationId()) == 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 + ((getPortalStartUrl() == null) ? 0 : getPortalStartUrl().hashCode()); hashCode = prime * hashCode + ((getPortalStatus() == null) ? 0 : getPortalStatus().hashCode()); hashCode = prime * hashCode + ((getSsoApplicationId() == null) ? 0 : getSsoApplicationId().hashCode()); return hashCode; } @Override public CreatePortalResult clone() { try { return (CreatePortalResult) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } }