Class PortalSummary

java.lang.Object
software.amazon.awssdk.services.apigatewayv2.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>

Represents a portal summary.

See Also:

  • Method Details

    • authorization

      public final Authorization authorization()

      The authorization of the portal.

      Returns:
      The authorization of the portal.

    • endpointConfiguration

      public final EndpointConfigurationResponse endpointConfiguration()

      The endpoint configuration of the portal.

      Returns:
      The endpoint configuration of the portal.

    • hasIncludedPortalProductArns

      public final boolean hasIncludedPortalProductArns()
      For responses, this returns true if the service returned a value for the IncludedPortalProductArns 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.

    • includedPortalProductArns

      public final List<String> includedPortalProductArns()

      The ARNs of the portal products included in the portal.

      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 hasIncludedPortalProductArns() method.

      Returns:
      The ARNs of the portal products included in the portal.

    • lastModified

      public final Instant lastModified()

      The timestamp when the portal was last modified.

      Returns:
      The timestamp when the portal was last modified.

    • lastPublished

      public final Instant lastPublished()

      The timestamp when the portal was last published.

      Returns:
      The timestamp when the portal was last published.

    • lastPublishedDescription

      public final String lastPublishedDescription()

      The description of the portal the last time it was published.

      Returns:
      The description of the portal the last time it was published.

    • portalArn

      public final String portalArn()

      The ARN of the portal.

      Returns:
      The ARN of the portal.

    • portalContent

      public final PortalContent portalContent()

      Contains the content that is visible to portal consumers including the themes, display names, and description.

      Returns:
      Contains the content that is visible to portal consumers including the themes, display names, and description.

    • portalId

      public final String portalId()

      The portal identifier.

      Returns:
      The portal identifier.

    • preview

      public final Preview preview()

      Represents the preview endpoint and the any possible error messages during preview generation.

      Returns:
      Represents the preview endpoint and the any possible error messages during preview generation.

    • publishStatus

      public final PublishStatus publishStatus()

      The publish status.

      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.
      See Also:

    • publishStatusAsString

      public final String publishStatusAsString()

      The publish status.

      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.
      See Also:

    • rumAppMonitorName

      public final String rumAppMonitorName()

      The CloudWatch RUM app monitor name.

      Returns:
      The CloudWatch RUM app monitor name.

    • statusException

      public final StatusException statusException()

      The status exception information.

      Returns:
      The status exception information.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final Map<String,String> tags()

      The collection of tags. Each tag element is associated with a given resource.

      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 hasTags() method.

      Returns:
      The collection of tags. Each tag element is associated with a given resource.

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