Class IpAccessSettings

java.lang.Object
software.amazon.awssdk.services.workspacesweb.model.IpAccessSettings
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<IpAccessSettings.Builder,IpAccessSettings>
@Generated("software.amazon.awssdk:codegen") public final class IpAccessSettings extends Object implements SdkPojo, Serializable, ToCopyableBuilder<IpAccessSettings.Builder,IpAccessSettings>

The IP access settings resource that can be associated with a web portal.

See Also:

  • Method Details

    • ipAccessSettingsArn

      public final String ipAccessSettingsArn()

      The ARN of the IP access settings resource.

      Returns:
      The ARN of the IP access settings resource.

    • hasAssociatedPortalArns

      public final boolean hasAssociatedPortalArns()
      For responses, this returns true if the service returned a value for the AssociatedPortalArns 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.

    • associatedPortalArns

      public final List<String> associatedPortalArns()

      A list of web portal ARNs that this IP access settings resource is associated with.

      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 hasAssociatedPortalArns() method.

      Returns:
      A list of web portal ARNs that this IP access settings resource is associated with.

    • hasIpRules

      public final boolean hasIpRules()
      For responses, this returns true if the service returned a value for the IpRules 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.

    • ipRules

      public final List<IpRule> ipRules()

      The IP rules of the IP access settings.

      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 hasIpRules() method.

      Returns:
      The IP rules of the IP access settings.

    • displayName

      public final String displayName()

      The display name of the IP access settings.

      Returns:
      The display name of the IP access settings.

    • description

      public final String description()

      The description of the IP access settings.

      Returns:
      The description of the IP access settings.

    • creationDate

      public final Instant creationDate()

      The creation date timestamp of the IP access settings.

      Returns:
      The creation date timestamp of the IP access settings.

    • customerManagedKey

      public final String customerManagedKey()

      The customer managed key used to encrypt sensitive information in the IP access settings.

      Returns:
      The customer managed key used to encrypt sensitive information in the IP access settings.

    • hasAdditionalEncryptionContext

      public final boolean hasAdditionalEncryptionContext()
      For responses, this returns true if the service returned a value for the AdditionalEncryptionContext 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.

    • additionalEncryptionContext

      public final Map<String,String> additionalEncryptionContext()

      The additional encryption context of the IP access settings.

      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 hasAdditionalEncryptionContext() method.

      Returns:
      The additional encryption context of the IP access settings.

    • toBuilder

      public IpAccessSettings.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<IpAccessSettings.Builder,IpAccessSettings>
      Returns:
      a builder for type T

    • builder

      public static IpAccessSettings.Builder builder()

    • serializableBuilderClass

      public static Class<? extends IpAccessSettings.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)
      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)

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.