Interface PortalSummary.Builder

  • Method Details

    • portalId

      PortalSummary.Builder portalId(String portalId)

      The identifier of the portal.

      Parameters:
      portalId - The identifier of the portal.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • portalArn

      PortalSummary.Builder portalArn(String portalArn)

      The ARN of the portal.

      Parameters:
      portalArn - The ARN of the portal.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • endpointConfiguration

      PortalSummary.Builder endpointConfiguration(EndpointConfigurationResponse endpointConfiguration)

      The domain configuration of the portal.

      Parameters:
      endpointConfiguration - The domain configuration of the portal.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • endpointConfiguration

      default PortalSummary.Builder endpointConfiguration(Consumer<EndpointConfigurationResponse.Builder> endpointConfiguration)

      The domain configuration of the portal.

      This is a convenience method that creates an instance of the EndpointConfigurationResponse.Builder avoiding the need to create one manually via EndpointConfigurationResponse.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to endpointConfiguration(EndpointConfigurationResponse).

      Parameters:
      endpointConfiguration - a consumer that will call methods on EndpointConfigurationResponse.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • authorization

      PortalSummary.Builder authorization(Authorization authorization)

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

      Parameters:
      authorization - How readers sign in to the portal, and whether fine-grained access control is on.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • authorization

      default PortalSummary.Builder authorization(Consumer<Authorization.Builder> authorization)

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

      This is a convenience method that creates an instance of the Authorization.Builder avoiding the need to create one manually via Authorization.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to authorization(Authorization).

      Parameters:
      authorization - a consumer that will call methods on Authorization.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • portalContent

      PortalSummary.Builder portalContent(PortalContent portalContent)

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

      Parameters:
      portalContent - The portal's display name, description, and theme.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • portalContent

      default PortalSummary.Builder portalContent(Consumer<PortalContent.Builder> portalContent)

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

      This is a convenience method that creates an instance of the PortalContent.Builder avoiding the need to create one manually via PortalContent.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to portalContent(PortalContent).

      Parameters:
      portalContent - a consumer that will call methods on PortalContent.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • includedProductArns

      PortalSummary.Builder includedProductArns(Collection<String> includedProductArns)

      The ARNs of the products the portal includes.

      Parameters:
      includedProductArns - The ARNs of the products the portal includes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • includedProductArns

      PortalSummary.Builder includedProductArns(String... includedProductArns)

      The ARNs of the products the portal includes.

      Parameters:
      includedProductArns - The ARNs of the products the portal includes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • publishStatus

      PortalSummary.Builder publishStatus(String publishStatus)

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

      Parameters:
      publishStatus - The publish status of the portal. Absent if the portal has never been published.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • publishStatus

      PortalSummary.Builder publishStatus(PublishStatus publishStatus)

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

      Parameters:
      publishStatus - The publish status of the portal. Absent if the portal has never been published.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • statusException

      PortalSummary.Builder statusException(PortalStatusException statusException)
      Sets the value of the StatusException property for this object.
      Parameters:
      statusException - The new value for the StatusException property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • statusException

      default PortalSummary.Builder statusException(Consumer<PortalStatusException.Builder> statusException)
      Sets the value of the StatusException property for this object. This is a convenience method that creates an instance of the PortalStatusException.Builder avoiding the need to create one manually via PortalStatusException.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to statusException(PortalStatusException).

      Parameters:
      statusException - a consumer that will call methods on PortalStatusException.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • updatedAt

      PortalSummary.Builder updatedAt(Instant updatedAt)

      When the resource was last updated.

      Parameters:
      updatedAt - When the resource was last updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • publishedAt

      PortalSummary.Builder publishedAt(Instant publishedAt)

      When the portal was last published.

      Parameters:
      publishedAt - When the portal was last published.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • publishDescription

      PortalSummary.Builder publishDescription(String publishDescription)

      The description supplied with the most recent publish request.

      Parameters:
      publishDescription - The description supplied with the most recent publish request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • rumAppMonitorName

      PortalSummary.Builder rumAppMonitorName(String rumAppMonitorName)

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

      Parameters:
      rumAppMonitorName - The name of the CloudWatch RUM app monitor that collects reader telemetry for the portal.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • preview

      PortalSummary.Builder preview(Preview preview)

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

      Parameters:
      preview - The most recent preview of the portal. Absent if no preview has been created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • preview

      default PortalSummary.Builder preview(Consumer<Preview.Builder> preview)

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

      This is a convenience method that creates an instance of the Preview.Builder avoiding the need to create one manually via Preview.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to preview(Preview).

      Parameters:
      preview - a consumer that will call methods on Preview.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: