Package software.amazon.awssdk.services.wafv2.model

Class IPSetSummary

java.lang.Object
software.amazon.awssdk.services.wafv2.model.IPSetSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<IPSetSummary.Builder,IPSetSummary>
@Generated("software.amazon.awssdk:codegen") public final class IPSetSummary extends Object implements SdkPojo, Serializable, 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:

  • Method Details

    • name

      public final String 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

      public final String 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

      public final String description()

      A description of the IP set that helps with identification.

      Returns:
      A description of the IP set that helps with identification.

    • lockToken

      public final String lockToken()

      A token used for optimistic locking. WAF returns a token to your get and list 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 like update and delete. 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 a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

      Returns:
      A token used for optimistic locking. WAF returns a token to your get and list 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 like update and delete. 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 a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the entity.

      Returns:
      The Amazon Resource Name (ARN) of the entity.

    • toBuilder

      public IPSetSummary.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<IPSetSummary.Builder,IPSetSummary>

    • builder

      public static IPSetSummary.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo