PortalSummary (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.iotsitewise.model.PortalSummary

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PortalSummary
extends Object
implements Serializable, Cloneable, StructuredPojo

Contains a portal summary.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

PortalSummary()

Constructors
Constructor and Description
`PortalSummary()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PortalSummary`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreationDate()` The date the portal was created, in Unix epoch time.
`String`	`getDescription()` The portal's description.
`String`	`getId()` The ID of the portal.
`Date`	`getLastUpdateDate()` The date the portal was last updated, in Unix epoch time.
`String`	`getName()` The name of the portal.
`String`	`getRoleArn()` The ARN of the service role that allows the portal's users to access your IoT SiteWise resources on your behalf.
`String`	`getStartUrl()` The URL for the IoT SiteWise Monitor portal.
`PortalStatus`	`getStatus()`
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCreationDate(Date creationDate)` The date the portal was created, in Unix epoch time.
`void`	`setDescription(String description)` The portal's description.
`void`	`setId(String id)` The ID of the portal.
`void`	`setLastUpdateDate(Date lastUpdateDate)` The date the portal was last updated, in Unix epoch time.
`void`	`setName(String name)` The name of the portal.
`void`	`setRoleArn(String roleArn)` The ARN of the service role that allows the portal's users to access your IoT SiteWise resources on your behalf.
`void`	`setStartUrl(String startUrl)` The URL for the IoT SiteWise Monitor portal.
`void`	`setStatus(PortalStatus status)`
`String`	`toString()` Returns a string representation of this object.
`PortalSummary`	`withCreationDate(Date creationDate)` The date the portal was created, in Unix epoch time.
`PortalSummary`	`withDescription(String description)` The portal's description.
`PortalSummary`	`withId(String id)` The ID of the portal.
`PortalSummary`	`withLastUpdateDate(Date lastUpdateDate)` The date the portal was last updated, in Unix epoch time.
`PortalSummary`	`withName(String name)` The name of the portal.
`PortalSummary`	`withRoleArn(String roleArn)` The ARN of the service role that allows the portal's users to access your IoT SiteWise resources on your behalf.
`PortalSummary`	`withStartUrl(String startUrl)` The URL for the IoT SiteWise Monitor portal.
`PortalSummary`	`withStatus(PortalStatus status)`

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

- Constructor Detail
  - PortalSummary
```
public PortalSummary()
```
- Method Detail
  - setId
```
public void setId(String id)
```
    The ID of the portal.
    
    Parameters:
    
    id - The ID of the portal.
  - getId
```
public String getId()
```
    The ID of the portal.
    
    Returns:
    
    The ID of the portal.
  - withId
```
public PortalSummary withId(String id)
```
    The ID of the portal.
    
    Parameters:
    
    id - The ID of the portal.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the portal.
    
    Parameters:
    
    name - The name of the portal.
  - getName
```
public String getName()
```
    The name of the portal.
    
    Returns:
    
    The name of the portal.
  - withName
```
public PortalSummary withName(String name)
```
    The name of the portal.
    
    Parameters:
    
    name - The name of the portal.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The portal's description.
    
    Parameters:
    
    description - The portal's description.
  - getDescription
```
public String getDescription()
```
    The portal's description.
    
    Returns:
    
    The portal's description.
  - withDescription
```
public PortalSummary withDescription(String description)
```
    The portal's description.
    
    Parameters:
    
    description - The portal's description.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStartUrl
```
public void setStartUrl(String startUrl)
```
    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.
    
    Parameters:
    
    startUrl - 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.
  - getStartUrl
```
public String getStartUrl()
```
    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.
    
    Returns:
    
    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.
  - withStartUrl
```
public PortalSummary withStartUrl(String startUrl)
```
    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.
    
    Parameters:
    
    startUrl - 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationDate
```
public void setCreationDate(Date creationDate)
```
    The date the portal was created, in Unix epoch time.
    
    Parameters:
    
    creationDate - The date the portal was created, in Unix epoch time.
  - getCreationDate
```
public Date getCreationDate()
```
    The date the portal was created, in Unix epoch time.
    
    Returns:
    
    The date the portal was created, in Unix epoch time.
  - withCreationDate
```
public PortalSummary withCreationDate(Date creationDate)
```
    The date the portal was created, in Unix epoch time.
    
    Parameters:
    
    creationDate - 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.
  - setLastUpdateDate
```
public void setLastUpdateDate(Date lastUpdateDate)
```
    The date the portal was last updated, in Unix epoch time.
    
    Parameters:
    
    lastUpdateDate - The date the portal was last updated, in Unix epoch time.
  - getLastUpdateDate
```
public Date getLastUpdateDate()
```
    The date the portal was last updated, in Unix epoch time.
    
    Returns:
    
    The date the portal was last updated, in Unix epoch time.
  - withLastUpdateDate
```
public PortalSummary withLastUpdateDate(Date lastUpdateDate)
```
    The date the portal was last updated, in Unix epoch time.
    
    Parameters:
    
    lastUpdateDate - 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.
  - setRoleArn
```
public void setRoleArn(String 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.
    
    Parameters:
    
    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.
  - getRoleArn
```
public String getRoleArn()
```
    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.
    
    Returns:
    
    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.
  - withRoleArn
```
public PortalSummary withRoleArn(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(PortalStatus status)
```
    Parameters:
    
    status -
  - getStatus
```
public PortalStatus getStatus()
```
    Returns:
  - withStatus
```
public PortalSummary withStatus(PortalStatus status)
```
    Parameters:
    
    status -
    
    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 PortalSummary clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.778

Class PortalSummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PortalSummary

Method Detail

setId

getId

withId

setName

getName

withName

setDescription

getDescription

withDescription

setStartUrl

getStartUrl

withStartUrl

setCreationDate

getCreationDate

withCreationDate

setLastUpdateDate

getLastUpdateDate

withLastUpdateDate

setRoleArn

getRoleArn

withRoleArn

setStatus

getStatus

withStatus

toString

equals

hashCode

clone

marshall