Class IPSetSummary
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<IPSetSummary.Builder,
IPSetSummary>
High-level information about an IPSet, returned by operations like create and list. This provides information
like the ID, that you can use to retrieve and manage an IPSet
, and the ARN, that you provide to the
IPSetReferenceStatement to use the address set in a Rule.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
arn()
The Amazon Resource Name (ARN) of the entity.static IPSetSummary.Builder
builder()
final String
A description of the IP set that helps with identification.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
id()
A unique identifier for the set.final String
A token used for optimistic locking.final String
name()
The name of the IP set.static Class
<? extends IPSetSummary.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the IP set. You cannot change the name of an
IPSet
after you create it.- Returns:
- The name of the IP set. You cannot change the name of an
IPSet
after you create it.
-
id
A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
- Returns:
- A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
-
description
A description of the IP set that helps with identification.
- Returns:
- A description of the IP set that helps with identification.
-
lockToken
A token used for optimistic locking. WAF returns a token to your
get
andlist
requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdate
anddelete
. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException
. If this happens, perform anotherget
, and use the new token returned by that operation.- Returns:
- A token used for optimistic locking. WAF returns a token to your
get
andlist
requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdate
anddelete
. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException
. If this happens, perform anotherget
, and use the new token returned by that operation.
-
arn
The Amazon Resource Name (ARN) of the entity.
- Returns:
- The Amazon Resource Name (ARN) of the entity.
-
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 interfaceToCopyableBuilder<IPSetSummary.Builder,
IPSetSummary> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
-
sdkFields
-