software.amazon.awssdk.services.iotsitewise.model

Class CreatePortalResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseResponse

software.amazon.awssdk.services.iotsitewise.model.CreatePortalResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreatePortalResponse.Builder,CreatePortalResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreatePortalResponse
extends IoTSiteWiseResponse
implements ToCopyableBuilder<CreatePortalResponse.Builder,CreatePortalResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreatePortalResponse.Builder

Method Summary

Modifier and Type	Method and Description
static CreatePortalResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	portalArn() The ARN of the portal, which has the following format.
String	portalId() The ID of the created portal.
String	portalStartUrl() The URL for the AWS IoT SiteWise Monitor portal.
PortalStatus	portalStatus() The status of the portal, which contains a state (CREATING after successfully calling this operation) and any error message.
List<SdkField<?>>	sdkFields()
static Class<? extends CreatePortalResponse.Builder>	serializableBuilderClass()
String	ssoApplicationId() The associated AWS SSO application ID, if the portal uses AWS SSO.
CreatePortalResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

portalId

public final String portalId()

The ID of the created portal.

Returns:

The ID of the created portal.

portalArn

public final String portalArn()

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

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

Returns:

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

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

portalStartUrl

public final String portalStartUrl()

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:

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.

portalStatus

public final PortalStatus portalStatus()

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

Returns:

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

ssoApplicationId

public final String ssoApplicationId()

The associated AWS SSO application ID, if the portal uses AWS SSO.

Returns:

The associated AWS SSO application ID, if the portal uses AWS SSO.

toBuilder

public CreatePortalResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreatePortalResponse.Builder,CreatePortalResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static CreatePortalResponse.Builder builder()

serializableBuilderClass

public static Class<? extends CreatePortalResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo