java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.workspacesweb.model.WorkSpacesWebRequest
    - - software.amazon.awssdk.services.workspacesweb.model.UpdatePortalRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<UpdatePortalRequest.Builder,UpdatePortalRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UpdatePortalRequest
extends WorkSpacesWebRequest
implements ToCopyableBuilder<UpdatePortalRequest.Builder,UpdatePortalRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface UpdatePortalRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AuthenticationType`	`authenticationType()`	The type of authentication integration points used when signing into the web portal.
`String`	`authenticationTypeAsString()`	The type of authentication integration points used when signing into the web portal.
`static UpdatePortalRequest.Builder`	`builder()`
`String`	`displayName()`	The name of the web portal.
`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 web portal.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends UpdatePortalRequest.Builder>`	`serializableBuilderClass()`
`UpdatePortalRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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
  - authenticationType
```
public final AuthenticationType authenticationType()
```
    The type of authentication integration points used when signing into the web portal. Defaults to Standard.
    
    Standard web portals are authenticated directly through your identity provider. You need to call CreateIdentityProvider to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.
    
    IAM_Identity_Center web portals are authenticated through AWS IAM Identity Center (successor to AWS Single Sign-On). They provide additional features, such as IdP-initiated authentication. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.
    
    If the service returns an enum value that is not available in the current SDK version, authenticationType will return AuthenticationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationTypeAsString().
    
    Returns:
    
    The type of authentication integration points used when signing into the web portal. Defaults to Standard.
    
    Standard web portals are authenticated directly through your identity provider. You need to call CreateIdentityProvider to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.
    
    IAM_Identity_Center web portals are authenticated through AWS IAM Identity Center (successor to AWS Single Sign-On). They provide additional features, such as IdP-initiated authentication. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.
    
    See Also:
    
    AuthenticationType
  - authenticationTypeAsString
```
public final String authenticationTypeAsString()
```
    The type of authentication integration points used when signing into the web portal. Defaults to Standard.
    
    Standard web portals are authenticated directly through your identity provider. You need to call CreateIdentityProvider to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.
    
    IAM_Identity_Center web portals are authenticated through AWS IAM Identity Center (successor to AWS Single Sign-On). They provide additional features, such as IdP-initiated authentication. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.
    
    If the service returns an enum value that is not available in the current SDK version, authenticationType will return AuthenticationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from authenticationTypeAsString().
    
    Returns:
    
    The type of authentication integration points used when signing into the web portal. Defaults to Standard.
    
    Standard web portals are authenticated directly through your identity provider. You need to call CreateIdentityProvider to integrate your identity provider with your web portal. User and group access to your web portal is controlled through your identity provider.
    
    IAM_Identity_Center web portals are authenticated through AWS IAM Identity Center (successor to AWS Single Sign-On). They provide additional features, such as IdP-initiated authentication. Identity sources (including external identity provider integration), plus user and group access to your web portal, can be configured in the IAM Identity Center.
    
    See Also:
    
    AuthenticationType
  - displayName
```
public final String displayName()
```
    The name of the web portal. This is not visible to users who log into the web portal.
    
    Returns:
    
    The name of the web portal. This is not visible to users who log into the web portal.
  - portalArn
```
public final String portalArn()
```
    The ARN of the web portal.
    
    Returns:
    
    The ARN of the web portal.
  - toBuilder
```
public UpdatePortalRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UpdatePortalRequest.Builder,UpdatePortalRequest>
    
    Specified by:
    
    toBuilder in class WorkSpacesWebRequest
  - builder
```
public static UpdatePortalRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UpdatePortalRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - 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 SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class UpdatePortalRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

authenticationType

authenticationTypeAsString

displayName

portalArn

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields