Class CreateIpAccessSettingsRequest
- 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.CreateIpAccessSettingsRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateIpAccessSettingsRequest.Builder,CreateIpAccessSettingsRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateIpAccessSettingsRequest extends WorkSpacesWebRequest implements ToCopyableBuilder<CreateIpAccessSettingsRequest.Builder,CreateIpAccessSettingsRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateIpAccessSettingsRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Map<String,String>additionalEncryptionContext()Additional encryption context of the IP access settings.static CreateIpAccessSettingsRequest.Builderbuilder()StringclientToken()A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.StringcustomerManagedKey()The custom managed key of the IP access settings.Stringdescription()The description of the IP access settings.StringdisplayName()The display name of the IP access settings.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAdditionalEncryptionContext()For responses, this returns true if the service returned a value for the AdditionalEncryptionContext property.inthashCode()booleanhasIpRules()For responses, this returns true if the service returned a value for the IpRules property.booleanhasTags()For responses, this returns true if the service returned a value for the Tags property.List<IpRule>ipRules()The IP rules of the IP access settings.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends CreateIpAccessSettingsRequest.Builder>serializableBuilderClass()List<Tag>tags()The tags to add to the IP access settings resource.CreateIpAccessSettingsRequest.BuildertoBuilder()StringtoString()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
-
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 theisEmpty()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()
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:
- Additional encryption context of the IP access settings.
-
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 returns the result from the original successful request.
If you do not specify a client token, one is automatically generated by the Amazon Web Services 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 returns the result from the
original successful request.
If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.
-
customerManagedKey
public final String customerManagedKey()
The custom managed key of the IP access settings.
- Returns:
- The custom managed key 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.
-
displayName
public final String displayName()
The display name of the IP access settings.
- Returns:
- The display name 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 theisEmpty()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.
-
hasTags
public final boolean hasTags()
For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
tags
public final List<Tag> tags()
The tags to add to the IP access settings resource. A tag is a key-value pair.
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
hasTags()method.- Returns:
- The tags to add to the IP access settings resource. A tag is a key-value pair.
-
toBuilder
public CreateIpAccessSettingsRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateIpAccessSettingsRequest.Builder,CreateIpAccessSettingsRequest>- Specified by:
toBuilderin classWorkSpacesWebRequest
-
builder
public static CreateIpAccessSettingsRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateIpAccessSettingsRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-