Class AssociateFirewallPolicyRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.networkfirewall.model.NetworkFirewallRequest
software.amazon.awssdk.services.networkfirewall.model.AssociateFirewallPolicyRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<AssociateFirewallPolicyRequest.Builder,AssociateFirewallPolicyRequest>
@Generated("software.amazon.awssdk:codegen") public final class AssociateFirewallPolicyRequest extends NetworkFirewallRequest implements ToCopyableBuilder<AssociateFirewallPolicyRequest.Builder,AssociateFirewallPolicyRequest>

  • Method Details

    • updateToken

      public final String updateToken()

      An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

      To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

      To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

      Returns:
      An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.

      To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.

      To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.

    • firewallArn

      public final String firewallArn()

      The Amazon Resource Name (ARN) of the firewall.

      You must specify the ARN or the name, and you can specify both.

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

      You must specify the ARN or the name, and you can specify both.

    • firewallName

      public final String firewallName()

      The descriptive name of the firewall. You can't change the name of a firewall after you create it.

      You must specify the ARN or the name, and you can specify both.

      Returns:
      The descriptive name of the firewall. You can't change the name of a firewall after you create it.

      You must specify the ARN or the name, and you can specify both.

    • firewallPolicyArn

      public final String firewallPolicyArn()

      The Amazon Resource Name (ARN) of the firewall policy.

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

    • toBuilder

      public AssociateFirewallPolicyRequest.Builder 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 interface ToCopyableBuilder<AssociateFirewallPolicyRequest.Builder,AssociateFirewallPolicyRequest>
      Specified by:
      toBuilder in class NetworkFirewallRequest
      Returns:
      a builder for type T

    • builder

      public static AssociateFirewallPolicyRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends AssociateFirewallPolicyRequest.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.