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:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface IpAccessSettings.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Map<String,String>`	`additionalEncryptionContext()`	The additional encryption context of the IP access settings.
`List<String>`	`associatedPortalArns()`	A list of web portal ARNs that this IP access settings resource is associated with.
`static IpAccessSettings.Builder`	`builder()`
`Instant`	`creationDate()`	The creation date timestamp of the IP access settings.
`String`	`customerManagedKey()`	The customer managed key used to encrypt sensitive information in the IP access settings.
`String`	`description()`	The description of the IP access settings.
`String`	`displayName()`	The display name of the IP access settings.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasAdditionalEncryptionContext()`	For responses, this returns true if the service returned a value for the AdditionalEncryptionContext property.
`boolean`	`hasAssociatedPortalArns()`	For responses, this returns true if the service returned a value for the AssociatedPortalArns property.
`int`	`hashCode()`
`boolean`	`hasIpRules()`	For responses, this returns true if the service returned a value for the IpRules property.
`String`	`ipAccessSettingsArn()`	The ARN of the IP access settings resource.
`List<IpRule>`	`ipRules()`	The IP rules of the IP access settings.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends IpAccessSettings.Builder>`	`serializableBuilderClass()`
`IpAccessSettings.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

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
  - 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.
  - 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.
  - 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.
  - description
```
public final String description()
```
    The description of the IP access settings.
    
    Returns:
    
    The description 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.
  - ipAccessSettingsArn
```
public final String ipAccessSettingsArn()
```
    The ARN of the IP access settings resource.
    
    Returns:
    
    The ARN of the IP access settings resource.
  - 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.
  - toBuilder
```
public IpAccessSettings.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<IpAccessSettings.Builder,IpAccessSettings>
  - 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)
```
    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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class IpAccessSettings

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

hasAdditionalEncryptionContext

additionalEncryptionContext

hasAssociatedPortalArns

associatedPortalArns

creationDate

customerManagedKey

description

displayName

ipAccessSettingsArn

hasIpRules

ipRules

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields