Package software.amazon.awssdk.services.iotsitewise.model

Class CreatePortalResponse

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.CreatePortalResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreatePortalResponse.Builder,CreatePortalResponse>
@Generated("software.amazon.awssdk:codegen") public final class CreatePortalResponse extends IoTSiteWiseResponse implements ToCopyableBuilder<CreatePortalResponse.Builder,CreatePortalResponse>

  • Method Details

    • portalId

      public final String portalId()

      The ID of the created portal.

      Returns:
      The ID of the created 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}

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

    • portalStatus

      public final PortalStatus portalStatus()

      The status of the portal, which contains a state (CREATING after successfully calling this operation) and any error message.

      Returns:
      The status of the portal, which contains a state (CREATING after successfully calling this operation) and any error message.

    • ssoApplicationId

      public final String ssoApplicationId()

      The associated IAM Identity Center application ID, if the portal uses IAM Identity Center.

      Returns:
      The associated IAM Identity Center application ID, if the portal uses IAM Identity Center.

    • toBuilder

      public CreatePortalResponse.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<CreatePortalResponse.Builder,CreatePortalResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static CreatePortalResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreatePortalResponse.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)
      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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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

      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.