java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.iotsitewise.model.IoTSiteWiseRequest
    - - software.amazon.awssdk.services.iotsitewise.model.UpdatePortalRequest

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

@Generated("software.amazon.awssdk:codegen")
public final class UpdatePortalRequest
extends IoTSiteWiseRequest
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
`Alarms`	`alarms()`	Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal.
`static UpdatePortalRequest.Builder`	`builder()`
`String`	`clientToken()`	A unique case-sensitive identifier that you can provide to ensure the idempotency of the request.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasPortalTypeConfiguration()`	For responses, this returns true if the service returned a value for the PortalTypeConfiguration property.
`String`	`notificationSenderEmail()`	The email address that sends alarm notifications.
`String`	`portalContactEmail()`	The Amazon Web Services administrator's contact email address.
`String`	`portalDescription()`	A new description for the portal.
`String`	`portalId()`	The ID of the portal to update.
`Image`	`portalLogoImage()`	Returns the value of the PortalLogoImage property for this object.
`String`	`portalName()`	A new friendly name for the portal.
`PortalType`	`portalType()`	Define the type of portal.
`String`	`portalTypeAsString()`	Define the type of portal.
`Map<String,PortalTypeEntry>`	`portalTypeConfiguration()`	The configuration entry associated with the specific portal type.
`String`	`roleArn()`	The ARN of a 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 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
  - portalId
```
public final String portalId()
```
    The ID of the portal to update.
    
    Returns:
    
    The ID of the portal to update.
  - portalName
```
public final String portalName()
```
    A new friendly name for the portal.
    
    Returns:
    
    A new friendly name for the portal.
  - portalDescription
```
public final String portalDescription()
```
    A new description for the portal.
    
    Returns:
    
    A new description for the portal.
  - portalContactEmail
```
public final String portalContactEmail()
```
    The Amazon Web Services administrator's contact email address.
    
    Returns:
    
    The Amazon Web Services administrator's contact email address.
  - portalLogoImage
```
public final Image portalLogoImage()
```
    Returns the value of the PortalLogoImage property for this object.
    
    Returns:
    
    The value of the PortalLogoImage property for this object.
  - roleArn
```
public final String roleArn()
```
    The ARN of a 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 a 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.
  - clientToken
```
public final String clientToken()
```
    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
    
    Returns:
    
    A unique case-sensitive identifier that you can provide to ensure the idempotency of the request. Don't reuse this client token if a new idempotent request is required.
  - notificationSenderEmail
```
public final String notificationSenderEmail()
```
    The email address that sends alarm notifications.
    
    Returns:
    
    The email address that sends alarm notifications.
  - alarms
```
public final Alarms alarms()
```
    Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range. For more information, see Monitoring with alarms in the IoT SiteWise Application Guide.
    
    Returns:
    
    Contains the configuration information of an alarm created in an IoT SiteWise Monitor portal. You can use the alarm to monitor an asset property and get notified when the asset property value is outside a specified range. For more information, see Monitoring with alarms in the IoT SiteWise Application Guide.
  - 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
  - hasPortalTypeConfiguration
```
public final boolean hasPortalTypeConfiguration()
```
    For responses, this returns true if the service returned a value for the PortalTypeConfiguration property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - portalTypeConfiguration
```
public final Map<String,PortalTypeEntry> portalTypeConfiguration()
```
    The configuration entry associated with the specific portal type. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2 .
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPortalTypeConfiguration() method.
    
    Returns:
    
    The configuration entry associated with the specific portal type. The value for IoT SiteWise Monitor (Classic) is SITEWISE_PORTAL_V1. The value for IoT SiteWise Monitor (AI-aware) is SITEWISE_PORTAL_V2.
  - toBuilder
```
public UpdatePortalRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UpdatePortalRequest.Builder,UpdatePortalRequest>
    
    Specified by:
    
    toBuilder in class IoTSiteWiseRequest
  - 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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField 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

portalId

portalName

portalDescription

portalContactEmail

portalLogoImage

roleArn

clientToken

notificationSenderEmail

alarms

portalType

portalTypeAsString

hasPortalTypeConfiguration

portalTypeConfiguration

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField