Class PortalSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<PortalSummary.Builder,
PortalSummary>
Contains a portal summary.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic PortalSummary.Builder
builder()
final Instant
The date the portal was created, in Unix epoch time.final String
The portal's description.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
id()
The ID of the portal.final Instant
The date the portal was last updated, in Unix epoch time.final String
name()
The name of the portal.final String
roleArn()
The ARN of the service role that allows the portal's users to access your IoT SiteWise resources on your behalf.static Class
<? extends PortalSummary.Builder> final String
startUrl()
The URL for the IoT SiteWise Monitor portal.final PortalStatus
status()
Returns the value of the Status property for this object.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
id
The ID of the portal.
- Returns:
- The ID of the portal.
-
name
The name of the portal.
- Returns:
- The name of the portal.
-
description
The portal's description.
- Returns:
- The portal's description.
-
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:
- 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.
-
creationDate
The date the portal was created, in Unix epoch time.
- Returns:
- The date the portal was created, in Unix epoch time.
-
lastUpdateDate
The date the portal was last updated, in Unix epoch time.
- Returns:
- The date the portal was last updated, in Unix epoch time.
-
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:
- 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.
-
status
Returns the value of the Status property for this object.- Returns:
- The value of the Status property for this object.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<PortalSummary.Builder,
PortalSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-