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

Class UpdatePortalRequest

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>

  • Method Details

    • 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.

    • toBuilder

      public UpdatePortalRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdatePortalRequest.Builder,UpdatePortalRequest>
      Specified by:
      toBuilder in class IoTSiteWiseRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.