software.amazon.awssdk.services.iotsitewise.model

Interface PortalSummary.Builder

All Superinterfaces:

Buildable, CopyableBuilder<PortalSummary.Builder,PortalSummary>, SdkBuilder<PortalSummary.Builder,PortalSummary>, SdkPojo

Enclosing class:

PortalSummary

public static interface PortalSummary.Builder
extends SdkPojo, CopyableBuilder<PortalSummary.Builder,PortalSummary>

Method Summary

Modifier and Type	Method and Description
PortalSummary.Builder	creationDate(Instant creationDate) The date the portal was created, in Unix epoch time.
PortalSummary.Builder	description(String description) The portal's description.
PortalSummary.Builder	id(String id) The ID of the portal.
PortalSummary.Builder	lastUpdateDate(Instant lastUpdateDate) The date the portal was last updated, in Unix epoch time.
PortalSummary.Builder	name(String name) The name of the portal.
PortalSummary.Builder	roleArn(String roleArn) The ARN of the service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf.
PortalSummary.Builder	startUrl(String startUrl) The URL for the AWS IoT SiteWise Monitor portal.
default PortalSummary.Builder	status(Consumer<PortalStatus.Builder> status) Sets the value of the Status property for this object.
PortalSummary.Builder	status(PortalStatus status) Sets the value of the Status property for this object.

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

id

PortalSummary.Builder id(String id)

The ID of the portal.

Parameters:

id - The ID of the portal.

Returns:

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

name

PortalSummary.Builder name(String name)

The name of the portal.

Parameters:

name - The name of the portal.

Returns:

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

description

PortalSummary.Builder description(String description)

The portal's description.

Parameters:

description - The portal's description.

Returns:

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

startUrl

PortalSummary.Builder startUrl(String startUrl)

The URL for the AWS IoT SiteWise Monitor portal. You can use this URL to access portals that use AWS SSO for authentication. For portals that use IAM for authentication, you must use the AWS IoT SiteWise console to get a URL that you can use to access the portal.

Parameters:

startUrl - The URL for the AWS IoT SiteWise Monitor portal. You can use this URL to access portals that use AWS SSO for authentication. For portals that use IAM for authentication, you must use the AWS 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.

creationDate

PortalSummary.Builder creationDate(Instant creationDate)

The date the portal was created, in Unix epoch time.

Parameters:

creationDate - The date the portal was created, in Unix epoch time.

Returns:

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

lastUpdateDate

PortalSummary.Builder lastUpdateDate(Instant lastUpdateDate)

The date the portal was last updated, in Unix epoch time.

Parameters:

lastUpdateDate - The date the portal was last updated, in Unix epoch time.

Returns:

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

roleArn

PortalSummary.Builder roleArn(String roleArn)

The ARN of the service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in the AWS IoT SiteWise User Guide.

Parameters:

roleArn - The ARN of the service role that allows the portal's users to access your AWS IoT SiteWise resources on your behalf. For more information, see Using service roles for AWS IoT SiteWise Monitor in the AWS IoT SiteWise User Guide.

Returns:

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

status

PortalSummary.Builder status(PortalStatus status)

Sets the value of the Status property for this object.

Parameters:

status - The new value for the Status property for this object.

Returns:

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

status

default PortalSummary.Builder status(Consumer<PortalStatus.Builder> status)

Sets the value of the Status property for this object. This is a convenience 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 status(PortalStatus).

Parameters:

status - 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:

status(PortalStatus)