Package software.amazon.awssdk.services.workspacesweb.model

Class UpdateIpAccessSettingsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateIpAccessSettingsRequest.Builder,UpdateIpAccessSettingsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateIpAccessSettingsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static UpdateIpAccessSettingsRequest.Builder	builder()
String	clientToken()	A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
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)
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.
List<IpRule>	ipRules()	The updated IP rules of the IP access settings.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateIpAccessSettingsRequest.Builder>	serializableBuilderClass()
UpdateIpAccessSettingsRequest.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

clientToken

public final String clientToken()

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request.

If you do not specify a client token, one is automatically generated by the AWS SDK.

Returns:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully, subsequent retries with the same client token return the result from the original successful request.

If you do not specify a client token, one is automatically generated by the AWS SDK.

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.

Returns:

The ARN of the IP access settings.

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 updated 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 updated IP rules of the IP access settings.

toBuilder

public UpdateIpAccessSettingsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateIpAccessSettingsRequest.Builder,UpdateIpAccessSettingsRequest>

Specified by:

toBuilder in class WorkSpacesWebRequest

builder

public static UpdateIpAccessSettingsRequest.Builder builder()

serializableBuilderClass

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