Class DescribePortalResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<DescribePortalResponse.Builder,
DescribePortalResponse>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Alarms
alarms()
Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal.builder()
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) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final String
The email address that sends alarm notifications.final String
The ARN of the portal, which has the following format.final AuthMode
The service to use to authenticate users to the portal.final String
The service to use to authenticate users to the portal.final String
The IAM Identity Center application generated client ID (used with IAM Identity Center API operations).final String
The Amazon Web Services administrator's contact email address.final Instant
The date the portal was created, in Unix epoch time.final String
The portal's description.final String
portalId()
The ID of the portal.final Instant
The date the portal was last updated, in Unix epoch time.final ImageLocation
The portal's logo image, which is available at a URL.final String
The name of the portal.final String
The URL for the IoT SiteWise Monitor portal.final PortalStatus
The current status of the portal, which contains a state and any error message.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 DescribePortalResponse.Builder> 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 class software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
portalId
The ID of the portal.
- Returns:
- The ID of the portal.
-
portalArn
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}
-
portalName
The name of the portal.
- Returns:
- The name of the portal.
-
portalDescription
The portal's description.
- Returns:
- The portal's description.
-
portalClientId
The IAM Identity Center application generated client ID (used with IAM Identity Center API operations). IoT SiteWise includes
portalClientId
for only portals that use IAM Identity Center to authenticate users.- Returns:
- The IAM Identity Center application generated client ID (used with IAM Identity Center API operations).
IoT SiteWise includes
portalClientId
for only portals that use IAM Identity Center to authenticate users.
-
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.
- 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.
-
portalContactEmail
The Amazon Web Services administrator's contact email address.
- Returns:
- The Amazon Web Services administrator's contact email address.
-
portalStatus
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.
-
portalCreationDate
The date the portal was created, in Unix epoch time.
- Returns:
- The date the portal was created, in Unix epoch time.
-
portalLastUpdateDate
The date the portal was last updated, in Unix epoch time.
- Returns:
- The date the portal was last updated, in Unix epoch time.
-
portalLogoImageLocation
The portal's logo image, which is available at a URL.
- Returns:
- The portal's logo image, which is available at a URL.
-
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.
-
portalAuthMode
The service to use to authenticate users to the portal.
If the service returns an enum value that is not available in the current SDK version,
portalAuthMode
will returnAuthMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromportalAuthModeAsString()
.- Returns:
- The service to use to authenticate users to the portal.
- See Also:
-
portalAuthModeAsString
The service to use to authenticate users to the portal.
If the service returns an enum value that is not available in the current SDK version,
portalAuthMode
will returnAuthMode.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromportalAuthModeAsString()
.- Returns:
- The service to use to authenticate users to the portal.
- See Also:
-
notificationSenderEmail
The email address that sends alarm notifications.
- Returns:
- The email address that sends alarm notifications.
-
alarms
Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal.
- Returns:
- Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal.
-
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<DescribePortalResponse.Builder,
DescribePortalResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
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
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-