software.amazon.awssdk.services.iotsitewise.model

Interface CreatePortalResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<CreatePortalResponse.Builder,CreatePortalResponse>, IoTSiteWiseResponse.Builder, SdkBuilder<CreatePortalResponse.Builder,CreatePortalResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

CreatePortalResponse

public static interface CreatePortalResponse.Builder
extends IoTSiteWiseResponse.Builder, SdkPojo, CopyableBuilder<CreatePortalResponse.Builder,CreatePortalResponse>

Method Summary

Modifier and Type	Method and Description
CreatePortalResponse.Builder	portalArn(String portalArn) The ARN of the portal, which has the following format.
CreatePortalResponse.Builder	portalId(String portalId) The ID of the created portal.
CreatePortalResponse.Builder	portalStartUrl(String portalStartUrl) The URL for the IoT SiteWise Monitor portal.
default CreatePortalResponse.Builder	portalStatus(Consumer<PortalStatus.Builder> portalStatus) The status of the portal, which contains a state (CREATING after successfully calling this operation) and any error message.
CreatePortalResponse.Builder	portalStatus(PortalStatus portalStatus) The status of the portal, which contains a state (CREATING after successfully calling this operation) and any error message.
CreatePortalResponse.Builder	ssoApplicationId(String ssoApplicationId) The associated Amazon Web Services SSO application ID, if the portal uses Amazon Web Services SSO.

Methods inherited from interface software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

portalId

CreatePortalResponse.Builder portalId(String portalId)

The ID of the created portal.

Parameters:

portalId - The ID of the created portal.

Returns:

Returns a reference to this object so that method calls can be chained together.

portalArn

CreatePortalResponse.Builder portalArn(String portalArn)

The ARN of the portal, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}

Parameters:

portalArn - The ARN of the portal, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:portal/${PortalId}

Returns:

Returns a reference to this object so that method calls can be chained together.

portalStartUrl

CreatePortalResponse.Builder portalStartUrl(String portalStartUrl)

The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that use Amazon Web Services SSO 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.

Parameters:

portalStartUrl - The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that use Amazon Web Services SSO 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:

Returns a reference to this object so that method calls can be chained together.

portalStatus

CreatePortalResponse.Builder portalStatus(PortalStatus portalStatus)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

portalStatus

default CreatePortalResponse.Builder portalStatus(Consumer<PortalStatus.Builder> portalStatus)

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

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

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

Parameters:

portalStatus - a consumer that will call methods on PortalStatus.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

portalStatus(PortalStatus)

ssoApplicationId

CreatePortalResponse.Builder ssoApplicationId(String ssoApplicationId)

The associated Amazon Web Services SSO application ID, if the portal uses Amazon Web Services SSO.

Parameters:

ssoApplicationId - The associated Amazon Web Services SSO application ID, if the portal uses Amazon Web Services SSO.

Returns:

Returns a reference to this object so that method calls can be chained together.