CreatePortalResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.iotsitewise.model.CreatePortalResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreatePortalResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CreatePortalResult()

Constructors
Constructor and Description
`CreatePortalResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CreatePortalResult`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getPortalArn()` The ARN of the portal, which has the following format.
`String`	`getPortalId()` The ID of the created portal.
`String`	`getPortalStartUrl()` The URL for the IoT SiteWise Monitor portal.
`PortalStatus`	`getPortalStatus()` The status of the portal, which contains a state (`CREATING` after successfully calling this operation) and any error message.
`String`	`getSsoApplicationId()` The associated Amazon Web Services SSO application ID, if the portal uses Amazon Web Services SSO.
`int`	`hashCode()`
`void`	`setPortalArn(String portalArn)` The ARN of the portal, which has the following format.
`void`	`setPortalId(String portalId)` The ID of the created portal.
`void`	`setPortalStartUrl(String portalStartUrl)` The URL for the IoT SiteWise Monitor portal.
`void`	`setPortalStatus(PortalStatus portalStatus)` The status of the portal, which contains a state (`CREATING` after successfully calling this operation) and any error message.
`void`	`setSsoApplicationId(String ssoApplicationId)` The associated Amazon Web Services SSO application ID, if the portal uses Amazon Web Services SSO.
`String`	`toString()` Returns a string representation of this object.
`CreatePortalResult`	`withPortalArn(String portalArn)` The ARN of the portal, which has the following format.
`CreatePortalResult`	`withPortalId(String portalId)` The ID of the created portal.
`CreatePortalResult`	`withPortalStartUrl(String portalStartUrl)` The URL for the IoT SiteWise Monitor portal.
`CreatePortalResult`	`withPortalStatus(PortalStatus portalStatus)` The status of the portal, which contains a state (`CREATING` after successfully calling this operation) and any error message.
`CreatePortalResult`	`withSsoApplicationId(String ssoApplicationId)` The associated Amazon Web Services SSO application ID, if the portal uses Amazon Web Services SSO.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CreatePortalResult
```
public CreatePortalResult()
```
- Method Detail
  - setPortalId
```
public void setPortalId(String portalId)
```
    The ID of the created portal.
    
    Parameters:
    
    portalId - The ID of the created portal.
  - getPortalId
```
public String getPortalId()
```
    The ID of the created portal.
    
    Returns:
    
    The ID of the created portal.
  - withPortalId
```
public CreatePortalResult withPortalId(String portalId)
```
    The ID of the created portal.
    
    Parameters:
    
    portalId - The ID of the created portal.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPortalArn
```
public void setPortalArn(String portalArn)
```
    The ARN of the portal, which has the following format.
    
    arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}
    
    Parameters:
    
    portalArn - The ARN of the portal, which has the following format.
    
    arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}
  - getPortalArn
```
public String getPortalArn()
```
    The ARN of the portal, which has the following format.
    
    arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}
    
    Returns:
    
    The ARN of the portal, which has the following format.
    
    arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}
  - withPortalArn
```
public CreatePortalResult withPortalArn(String portalArn)
```
    The ARN of the portal, which has the following format.
    
    arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}
    
    Parameters:
    
    portalArn - The ARN of the portal, which has the following format.
    
    arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPortalStartUrl
```
public void setPortalStartUrl(String portalStartUrl)
```
    The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that use Amazon Web Services SSO 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.
    
    Parameters:
    
    portalStartUrl - The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that use Amazon Web Services SSO 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.
  - getPortalStartUrl
```
public String getPortalStartUrl()
```
    The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that use Amazon Web Services SSO 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.
    
    Returns:
    
    The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that use Amazon Web Services SSO 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.
  - withPortalStartUrl
```
public CreatePortalResult withPortalStartUrl(String portalStartUrl)
```
    The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that use Amazon Web Services SSO 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.
    
    Parameters:
    
    portalStartUrl - The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that use Amazon Web Services SSO 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPortalStatus
```
public void setPortalStatus(PortalStatus portalStatus)
```
    The status of the portal, which contains a state (CREATING after successfully calling this operation) and any error message.
    
    Parameters:
    
    portalStatus - The status of the portal, which contains a state (CREATING after successfully calling this operation) and any error message.
  - getPortalStatus
```
public PortalStatus getPortalStatus()
```
    The status of the portal, which contains a state (CREATING after successfully calling this operation) and any error message.
    
    Returns:
    
    The status of the portal, which contains a state (CREATING after successfully calling this operation) and any error message.
  - withPortalStatus
```
public CreatePortalResult withPortalStatus(PortalStatus portalStatus)
```
    The status of the portal, which contains a state (CREATING after successfully calling this operation) and any error message.
    
    Parameters:
    
    portalStatus - The status of the portal, which contains a state (CREATING after successfully calling this operation) and any error message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSsoApplicationId
```
public void setSsoApplicationId(String ssoApplicationId)
```
    The associated Amazon Web Services SSO application ID, if the portal uses Amazon Web Services SSO.
    
    Parameters:
    
    ssoApplicationId - The associated Amazon Web Services SSO application ID, if the portal uses Amazon Web Services SSO.
  - getSsoApplicationId
```
public String getSsoApplicationId()
```
    The associated Amazon Web Services SSO application ID, if the portal uses Amazon Web Services SSO.
    
    Returns:
    
    The associated Amazon Web Services SSO application ID, if the portal uses Amazon Web Services SSO.
  - withSsoApplicationId
```
public CreatePortalResult withSsoApplicationId(String ssoApplicationId)
```
    The associated Amazon Web Services SSO application ID, if the portal uses Amazon Web Services SSO.
    
    Parameters:
    
    ssoApplicationId - The associated Amazon Web Services SSO application ID, if the portal uses Amazon Web Services SSO.
    
    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 CreatePortalResult clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class CreatePortalResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

CreatePortalResult

Method Detail

setPortalId

getPortalId

withPortalId

setPortalArn

getPortalArn

withPortalArn

setPortalStartUrl

getPortalStartUrl

withPortalStartUrl

setPortalStatus

getPortalStatus

withPortalStatus

setSsoApplicationId

getSsoApplicationId

withSsoApplicationId

toString

equals

hashCode

clone