DescribePortalResult (AWS SDK for Java

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

All Implemented Interfaces:: Serializable, Cloneable

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

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribePortalResult()

Constructors
Constructor and Description
`DescribePortalResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribePortalResult`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getPortalArn()` The ARN of the portal, which has the following format.
`String`	`getPortalAuthMode()` The service to use to authenticate users to the portal.
`String`	`getPortalClientId()` The AWS SSO application generated client ID (used with AWS SSO APIs).
`String`	`getPortalContactEmail()` The AWS administrator's contact email address.
`Date`	`getPortalCreationDate()` The date the portal was created, in Unix epoch time.
`String`	`getPortalDescription()` The portal's description.
`String`	`getPortalId()` The ID of the portal.
`Date`	`getPortalLastUpdateDate()` The date the portal was last updated, in Unix epoch time.
`ImageLocation`	`getPortalLogoImageLocation()` The portal's logo image, which is available at a URL.
`String`	`getPortalName()` The name of the portal.
`String`	`getPortalStartUrl()` The URL for the AWS IoT SiteWise Monitor portal.
`PortalStatus`	`getPortalStatus()` The current status of the portal, which contains a state and any error message.
`String`	`getRoleArn()` The ARN of the service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf.
`int`	`hashCode()`
`void`	`setPortalArn(String portalArn)` The ARN of the portal, which has the following format.
`void`	`setPortalAuthMode(String portalAuthMode)` The service to use to authenticate users to the portal.
`void`	`setPortalClientId(String portalClientId)` The AWS SSO application generated client ID (used with AWS SSO APIs).
`void`	`setPortalContactEmail(String portalContactEmail)` The AWS administrator's contact email address.
`void`	`setPortalCreationDate(Date portalCreationDate)` The date the portal was created, in Unix epoch time.
`void`	`setPortalDescription(String portalDescription)` The portal's description.
`void`	`setPortalId(String portalId)` The ID of the portal.
`void`	`setPortalLastUpdateDate(Date portalLastUpdateDate)` The date the portal was last updated, in Unix epoch time.
`void`	`setPortalLogoImageLocation(ImageLocation portalLogoImageLocation)` The portal's logo image, which is available at a URL.
`void`	`setPortalName(String portalName)` The name of the portal.
`void`	`setPortalStartUrl(String portalStartUrl)` The URL for the AWS IoT SiteWise Monitor portal.
`void`	`setPortalStatus(PortalStatus portalStatus)` The current status of the portal, which contains a state and any error message.
`void`	`setRoleArn(String roleArn)` The ARN of the service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf.
`String`	`toString()` Returns a string representation of this object.
`DescribePortalResult`	`withPortalArn(String portalArn)` The ARN of the portal, which has the following format.
`DescribePortalResult`	`withPortalAuthMode(AuthMode portalAuthMode)` The service to use to authenticate users to the portal.
`DescribePortalResult`	`withPortalAuthMode(String portalAuthMode)` The service to use to authenticate users to the portal.
`DescribePortalResult`	`withPortalClientId(String portalClientId)` The AWS SSO application generated client ID (used with AWS SSO APIs).
`DescribePortalResult`	`withPortalContactEmail(String portalContactEmail)` The AWS administrator's contact email address.
`DescribePortalResult`	`withPortalCreationDate(Date portalCreationDate)` The date the portal was created, in Unix epoch time.
`DescribePortalResult`	`withPortalDescription(String portalDescription)` The portal's description.
`DescribePortalResult`	`withPortalId(String portalId)` The ID of the portal.
`DescribePortalResult`	`withPortalLastUpdateDate(Date portalLastUpdateDate)` The date the portal was last updated, in Unix epoch time.
`DescribePortalResult`	`withPortalLogoImageLocation(ImageLocation portalLogoImageLocation)` The portal's logo image, which is available at a URL.
`DescribePortalResult`	`withPortalName(String portalName)` The name of the portal.
`DescribePortalResult`	`withPortalStartUrl(String portalStartUrl)` The URL for the AWS IoT SiteWise Monitor portal.
`DescribePortalResult`	`withPortalStatus(PortalStatus portalStatus)` The current status of the portal, which contains a state and any error message.
`DescribePortalResult`	`withRoleArn(String roleArn)` The ARN of the service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf.

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
  - DescribePortalResult
```
public DescribePortalResult()
```
- Method Detail
  - setPortalId
```
public void setPortalId(String portalId)
```
    The ID of the portal.
    
    Parameters:
    
    portalId - The ID of the portal.
  - getPortalId
```
public String getPortalId()
```
    The ID of the portal.
    
    Returns:
    
    The ID of the portal.
  - withPortalId
```
public DescribePortalResult withPortalId(String portalId)
```
    The ID of the portal.
    
    Parameters:
    
    portalId - The ID of the 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 DescribePortalResult 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.
  - setPortalName
```
public void setPortalName(String portalName)
```
    The name of the portal.
    
    Parameters:
    
    portalName - The name of the portal.
  - getPortalName
```
public String getPortalName()
```
    The name of the portal.
    
    Returns:
    
    The name of the portal.
  - withPortalName
```
public DescribePortalResult withPortalName(String portalName)
```
    The name of the portal.
    
    Parameters:
    
    portalName - The name of the portal.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPortalDescription
```
public void setPortalDescription(String portalDescription)
```
    The portal's description.
    
    Parameters:
    
    portalDescription - The portal's description.
  - getPortalDescription
```
public String getPortalDescription()
```
    The portal's description.
    
    Returns:
    
    The portal's description.
  - withPortalDescription
```
public DescribePortalResult withPortalDescription(String portalDescription)
```
    The portal's description.
    
    Parameters:
    
    portalDescription - The portal's description.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPortalClientId
```
public void setPortalClientId(String portalClientId)
```
    The AWS SSO application generated client ID (used with AWS SSO APIs). AWS IoT SiteWise includes portalClientId for only portals that use AWS SSO to authenticate users.
    
    Parameters:
    
    portalClientId - The AWS SSO application generated client ID (used with AWS SSO APIs). AWS IoT SiteWise includes portalClientId for only portals that use AWS SSO to authenticate users.
  - getPortalClientId
```
public String getPortalClientId()
```
    The AWS SSO application generated client ID (used with AWS SSO APIs). AWS IoT SiteWise includes portalClientId for only portals that use AWS SSO to authenticate users.
    
    Returns:
    
    The AWS SSO application generated client ID (used with AWS SSO APIs). AWS IoT SiteWise includes portalClientId for only portals that use AWS SSO to authenticate users.
  - withPortalClientId
```
public DescribePortalResult withPortalClientId(String portalClientId)
```
    The AWS SSO application generated client ID (used with AWS SSO APIs). AWS IoT SiteWise includes portalClientId for only portals that use AWS SSO to authenticate users.
    
    Parameters:
    
    portalClientId - The AWS SSO application generated client ID (used with AWS SSO APIs). AWS IoT SiteWise includes portalClientId for only portals that use AWS SSO to authenticate users.
    
    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 AWS IoT SiteWise Monitor portal. You can use this URL to access portals that use AWS SSO for authentication. For portals that use IAM for authentication, you must use the AWS IoT SiteWise console to get a URL that you can use to access the portal.
    
    Parameters:
    
    portalStartUrl - The URL for the AWS IoT SiteWise Monitor portal. You can use this URL to access portals that use AWS SSO for authentication. For portals that use IAM for authentication, you must use the AWS IoT SiteWise console to get a URL that you can use to access the portal.
  - getPortalStartUrl
```
public String getPortalStartUrl()
```
    The URL for the AWS IoT SiteWise Monitor portal. You can use this URL to access portals that use AWS SSO for authentication. For portals that use IAM for authentication, you must use the AWS IoT SiteWise console to get a URL that you can use to access the portal.
    
    Returns:
    
    The URL for the AWS IoT SiteWise Monitor portal. You can use this URL to access portals that use AWS SSO for authentication. For portals that use IAM for authentication, you must use the AWS IoT SiteWise console to get a URL that you can use to access the portal.
  - withPortalStartUrl
```
public DescribePortalResult withPortalStartUrl(String portalStartUrl)
```
    The URL for the AWS IoT SiteWise Monitor portal. You can use this URL to access portals that use AWS SSO for authentication. For portals that use IAM for authentication, you must use the AWS IoT SiteWise console to get a URL that you can use to access the portal.
    
    Parameters:
    
    portalStartUrl - The URL for the AWS IoT SiteWise Monitor portal. You can use this URL to access portals that use AWS SSO for authentication. For portals that use IAM for authentication, you must use the AWS 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.
  - 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 DescribePortalResult 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.
  - setPortalStatus
```
public void setPortalStatus(PortalStatus portalStatus)
```
    The current status of the portal, which contains a state and any error message.
    
    Parameters:
    
    portalStatus - The current status of the portal, which contains a state and any error message.
  - getPortalStatus
```
public PortalStatus getPortalStatus()
```
    The current status of the portal, which contains a state and any error message.
    
    Returns:
    
    The current status of the portal, which contains a state and any error message.
  - withPortalStatus
```
public DescribePortalResult withPortalStatus(PortalStatus portalStatus)
```
    The current status of the portal, which contains a state and any error message.
    
    Parameters:
    
    portalStatus - The current status of the portal, which contains a state and any error message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPortalCreationDate
```
public void setPortalCreationDate(Date portalCreationDate)
```
    The date the portal was created, in Unix epoch time.
    
    Parameters:
    
    portalCreationDate - The date the portal was created, in Unix epoch time.
  - getPortalCreationDate
```
public Date getPortalCreationDate()
```
    The date the portal was created, in Unix epoch time.
    
    Returns:
    
    The date the portal was created, in Unix epoch time.
  - withPortalCreationDate
```
public DescribePortalResult withPortalCreationDate(Date portalCreationDate)
```
    The date the portal was created, in Unix epoch time.
    
    Parameters:
    
    portalCreationDate - The date the portal was created, in Unix epoch time.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPortalLastUpdateDate
```
public void setPortalLastUpdateDate(Date portalLastUpdateDate)
```
    The date the portal was last updated, in Unix epoch time.
    
    Parameters:
    
    portalLastUpdateDate - The date the portal was last updated, in Unix epoch time.
  - getPortalLastUpdateDate
```
public Date getPortalLastUpdateDate()
```
    The date the portal was last updated, in Unix epoch time.
    
    Returns:
    
    The date the portal was last updated, in Unix epoch time.
  - withPortalLastUpdateDate
```
public DescribePortalResult withPortalLastUpdateDate(Date portalLastUpdateDate)
```
    The date the portal was last updated, in Unix epoch time.
    
    Parameters:
    
    portalLastUpdateDate - The date the portal was last updated, in Unix epoch time.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPortalLogoImageLocation
```
public void setPortalLogoImageLocation(ImageLocation portalLogoImageLocation)
```
    The portal's logo image, which is available at a URL.
    
    Parameters:
    
    portalLogoImageLocation - The portal's logo image, which is available at a URL.
  - getPortalLogoImageLocation
```
public ImageLocation getPortalLogoImageLocation()
```
    The portal's logo image, which is available at a URL.
    
    Returns:
    
    The portal's logo image, which is available at a URL.
  - withPortalLogoImageLocation
```
public DescribePortalResult withPortalLogoImageLocation(ImageLocation portalLogoImageLocation)
```
    The portal's logo image, which is available at a URL.
    
    Parameters:
    
    portalLogoImageLocation - The portal's logo image, which is available at a URL.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRoleArn
```
public void setRoleArn(String roleArn)
```
    The ARN of the 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 the 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 the 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 the 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 DescribePortalResult withRoleArn(String roleArn)
```
    The ARN of the 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 the 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.
  - setPortalAuthMode
```
public void setPortalAuthMode(String portalAuthMode)
```
    The service to use to authenticate users to the portal.
    
    Parameters:
    
    portalAuthMode - The service to use to authenticate users to the portal.
    
    See Also:
    
    AuthMode
  - getPortalAuthMode
```
public String getPortalAuthMode()
```
    The service to use to authenticate users to the portal.
    
    Returns:
    
    The service to use to authenticate users to the portal.
    
    See Also:
    
    AuthMode
  - withPortalAuthMode
```
public DescribePortalResult withPortalAuthMode(String portalAuthMode)
```
    The service to use to authenticate users to the portal.
    
    Parameters:
    
    portalAuthMode - The service to use to authenticate users to the portal.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AuthMode
  - withPortalAuthMode
```
public DescribePortalResult withPortalAuthMode(AuthMode portalAuthMode)
```
    The service to use to authenticate users to the portal.
    
    Parameters:
    
    portalAuthMode - The service to use to authenticate users to the portal.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AuthMode
  - 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 DescribePortalResult clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class DescribePortalResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

DescribePortalResult

Method Detail

setPortalId

getPortalId

withPortalId

setPortalArn

getPortalArn

withPortalArn

setPortalName

getPortalName

withPortalName

setPortalDescription

getPortalDescription

withPortalDescription

setPortalClientId

getPortalClientId

withPortalClientId

setPortalStartUrl

getPortalStartUrl

withPortalStartUrl

setPortalContactEmail

getPortalContactEmail

withPortalContactEmail

setPortalStatus

getPortalStatus

withPortalStatus

setPortalCreationDate

getPortalCreationDate

withPortalCreationDate

setPortalLastUpdateDate

getPortalLastUpdateDate

withPortalLastUpdateDate

setPortalLogoImageLocation

getPortalLogoImageLocation

withPortalLogoImageLocation

setRoleArn

getRoleArn

withRoleArn

setPortalAuthMode

getPortalAuthMode

withPortalAuthMode

withPortalAuthMode

toString

equals

hashCode

clone