java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseResponse
    - - software.amazon.awssdk.services.iotsitewise.model.DescribePortalResponse

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DescribePortalResponse.Builder,DescribePortalResponse>

@Generated("software.amazon.awssdk:codegen")
public final class DescribePortalResponse
extends IoTSiteWiseResponse
implements ToCopyableBuilder<DescribePortalResponse.Builder,DescribePortalResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DescribePortalResponse.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Alarms`	`alarms()`	Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal.
`static DescribePortalResponse.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`notificationSenderEmail()`	The email address that sends alarm notifications.
`String`	`portalArn()`	The ARN of the portal, which has the following format.
`AuthMode`	`portalAuthMode()`	The service to use to authenticate users to the portal.
`String`	`portalAuthModeAsString()`	The service to use to authenticate users to the portal.
`String`	`portalClientId()`	The IAM Identity Center application generated client ID (used with IAM Identity Center APIs).
`String`	`portalContactEmail()`	The Amazon Web Services administrator's contact email address.
`Instant`	`portalCreationDate()`	The date the portal was created, in Unix epoch time.
`String`	`portalDescription()`	The portal's description.
`String`	`portalId()`	The ID of the portal.
`Instant`	`portalLastUpdateDate()`	The date the portal was last updated, in Unix epoch time.
`ImageLocation`	`portalLogoImageLocation()`	The portal's logo image, which is available at a URL.
`String`	`portalName()`	The name of the portal.
`String`	`portalStartUrl()`	The URL for the IoT SiteWise Monitor portal.
`PortalStatus`	`portalStatus()`	The current status of the portal, which contains a state and any error message.
`String`	`roleArn()`	The ARN of the service role that allows the portal's users to access your IoT SiteWise resources on your behalf.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribePortalResponse.Builder>`	`serializableBuilderClass()`
`DescribePortalResponse.Builder`	`toBuilder()`
`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 class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - portalId
```
public final String portalId()
```
    The ID of the portal.
    
    Returns:
    
    The ID of the portal.
  - portalArn
```
public final String 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
```
public final String portalName()
```
    The name of the portal.
    
    Returns:
    
    The name of the portal.
  - portalDescription
```
public final String portalDescription()
```
    The portal's description.
    
    Returns:
    
    The portal's description.
  - portalClientId
```
public final String portalClientId()
```
    The IAM Identity Center application generated client ID (used with IAM Identity Center APIs). 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 APIs). IoT SiteWise includes portalClientId for only portals that use IAM Identity Center to authenticate users.
  - portalStartUrl
```
public final String 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
```
public final String portalContactEmail()
```
    The Amazon Web Services administrator's contact email address.
    
    Returns:
    
    The Amazon Web Services administrator's contact email address.
  - portalStatus
```
public final PortalStatus 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
```
public final Instant portalCreationDate()
```
    The date the portal was created, in Unix epoch time.
    
    Returns:
    
    The date the portal was created, in Unix epoch time.
  - portalLastUpdateDate
```
public final Instant 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
```
public final ImageLocation 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
```
public final 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.
    
    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
```
public final AuthMode 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 return AuthMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from portalAuthModeAsString().
    
    Returns:
    
    The service to use to authenticate users to the portal.
    
    See Also:
    
    AuthMode
  - portalAuthModeAsString
```
public final String 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 return AuthMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from portalAuthModeAsString().
    
    Returns:
    
    The service to use to authenticate users to the portal.
    
    See Also:
    
    AuthMode
  - notificationSenderEmail
```
public final String notificationSenderEmail()
```
    The email address that sends alarm notifications.
    
    Returns:
    
    The email address that sends alarm notifications.
  - alarms
```
public final Alarms 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
```
public DescribePortalResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribePortalResponse.Builder,DescribePortalResponse>
    
    Specified by:
    
    toBuilder in class AwsResponse
  - builder
```
public static DescribePortalResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribePortalResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribePortalResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

portalId

portalArn

portalName

portalDescription

portalClientId

portalStartUrl

portalContactEmail

portalStatus

portalCreationDate

portalLastUpdateDate

portalLogoImageLocation

roleArn

portalAuthMode

portalAuthModeAsString

notificationSenderEmail

alarms

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields