Package software.amazon.awssdk.services.iotsitewise.model

Class PortalSummary

java.lang.Object

software.amazon.awssdk.services.iotsitewise.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>

Contains a portal summary.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PortalSummary.Builder

Method Summary

Modifier and Type	Method	Description
static PortalSummary.Builder	builder()
Instant	creationDate()	The date the portal was created, in Unix epoch time.
String	description()	The portal's description.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id()	The ID of the portal.
Instant	lastUpdateDate()	The date the portal was last updated, in Unix epoch time.
String	name()	The name of the portal.
PortalType	portalType()	Define the type of portal.
String	portalTypeAsString()	Define the type of portal.
String	roleArn()	The ARN of the service role that allows the portal's users to access your IoT SiteWise resources on your behalf.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends PortalSummary.Builder>	serializableBuilderClass()
String	startUrl()	The URL for the IoT SiteWise Monitor portal.
PortalStatus	status()	Returns the value of the Status property for this object.
PortalSummary.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

id

public final String id()

The ID of the portal.

Returns:

The ID of the portal.

name

public final String name()

The name of the portal.

Returns:

The name of the portal.

description

public final String description()

The portal's description.

Returns:

The portal's description.

startUrl

public final String startUrl()

The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that use IAM Identity Center 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:

The URL for the IoT SiteWise Monitor portal. You can use this URL to access portals that use IAM Identity Center 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.

creationDate

public final Instant creationDate()

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

Returns:

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

lastUpdateDate

public final Instant lastUpdateDate()

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

Returns:

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

roleArn

public final String roleArn()

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

Returns:

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

status

public final PortalStatus status()

Returns the value of the Status property for this object.

Returns:

The value of the Status property for this object.

portalType

public final PortalType portalType()

Define the type of portal. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.

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

Returns:

Define the type of portal. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.

See Also:

PortalType

portalTypeAsString

public final String portalTypeAsString()

Define the type of portal. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.

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

Returns:

Define the type of portal. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.

See Also:

PortalType

toBuilder

public PortalSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PortalSummary.Builder,PortalSummary>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo