Class UpdatePortalResponse

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

@Generated("software.amazon.awssdk:codegen") public final class UpdatePortalResponse extends ApiPortalResponse implements ToCopyableBuilder<UpdatePortalResponse.Builder,UpdatePortalResponse>
  • Method Details

    • portalId

      public final String portalId()

      The identifier of the portal.

      Returns:
      The identifier of the portal.
    • portalArn

      public final String portalArn()

      The ARN of the portal.

      Returns:
      The ARN of the portal.
    • endpointConfiguration

      public final EndpointConfigurationResponse endpointConfiguration()

      The domain configuration of the portal.

      Returns:
      The domain configuration of the portal.
    • authorization

      public final Authorization authorization()

      How readers sign in to the portal, and whether fine-grained access control is on.

      Returns:
      How readers sign in to the portal, and whether fine-grained access control is on.
    • portalContent

      public final PortalContent portalContent()

      The portal's display name, description, and theme.

      Returns:
      The portal's display name, description, and theme.
    • hasIncludedProductArns

      public final boolean hasIncludedProductArns()
      For responses, this returns true if the service returned a value for the IncludedProductArns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
    • includedProductArns

      public final List<String> includedProductArns()

      The ARNs of the products the portal includes.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasIncludedProductArns() method.

      Returns:
      The ARNs of the products the portal includes.
    • publishStatus

      public final PublishStatus publishStatus()

      The publish status of the portal. Absent if the portal has never been published.

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

      Returns:
      The publish status of the portal. Absent if the portal has never been published.
      See Also:
    • publishStatusAsString

      public final String publishStatusAsString()

      The publish status of the portal. Absent if the portal has never been published.

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

      Returns:
      The publish status of the portal. Absent if the portal has never been published.
      See Also:
    • statusException

      public final PortalStatusException statusException()
      Returns the value of the StatusException property for this object.
      Returns:
      The value of the StatusException property for this object.
    • updatedAt

      public final Instant updatedAt()

      When the resource was last updated.

      Returns:
      When the resource was last updated.
    • publishedAt

      public final Instant publishedAt()

      When the portal was last published.

      Returns:
      When the portal was last published.
    • publishDescription

      public final String publishDescription()

      The description supplied with the most recent publish request.

      Returns:
      The description supplied with the most recent publish request.
    • rumAppMonitorName

      public final String rumAppMonitorName()

      The name of the CloudWatch RUM app monitor that collects reader telemetry for the portal.

      Returns:
      The name of the CloudWatch RUM app monitor that collects reader telemetry for the portal.
    • preview

      public final Preview preview()

      The most recent preview of the portal. Absent if no preview has been created.

      Returns:
      The most recent preview of the portal. Absent if no preview has been created.
    • toBuilder

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

      public static UpdatePortalResponse.Builder builder()
    • serializableBuilderClass

      public static Class<? extends UpdatePortalResponse.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.
    • sdkFieldNameToField

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