Class PortalSummary

java.lang.Object
software.amazon.awssdk.services.iotsitewise.model.PortalSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PortalSummary.Builder,PortalSummary>
@Generated("software.amazon.awssdk:codegen") public final class PortalSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PortalSummary.Builder,PortalSummary>

Contains a portal summary.

See Also:

  • Method Details

    • id

      public final String id()

      The ID of the portal.

      Returns:
      The ID of the portal.

    • name

      public final String name()

      The name of the portal.

      Returns:
      The name of the portal.

    • description

      public final String description()

      The portal's description.

      Returns:
      The portal's description.

    • startUrl

      public final 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.

      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

      public final Instant creationDate()

      The date the portal was created, in Unix epoch time.

      Returns:
      The date the portal was created, in Unix epoch time.

    • lastUpdateDate

      public final Instant 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

      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.

    • status

      public final PortalStatus status()
      Returns the value of the Status property for this object.
      Returns:
      The value of the Status property for this object.

    • portalType

      public final PortalType portalType()

      Define the type of portal. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.

      If the service returns an enum value that is not available in the current SDK version, portalType will return PortalType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from portalTypeAsString().

      Returns:
      Define the type of portal. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.
      See Also:

    • portalTypeAsString

      public final String portalTypeAsString()

      Define the type of portal. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.

      If the service returns an enum value that is not available in the current SDK version, portalType will return PortalType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from portalTypeAsString().

      Returns:
      Define the type of portal. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.
      See Also:

    • toBuilder

      public PortalSummary.Builder 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 interface ToCopyableBuilder<PortalSummary.Builder,PortalSummary>
      Returns:
      a builder for type T

    • builder

      public static PortalSummary.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PortalSummary.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.