Class UpdateProxyRuleRequest

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.UpdateProxyRuleRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateProxyRuleRequest.Builder,UpdateProxyRuleRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateProxyRuleRequest extends NetworkFirewallRequest implements ToCopyableBuilder<UpdateProxyRuleRequest.Builder,UpdateProxyRuleRequest>

  • Method Details

    • proxyRuleGroupName

      public final String proxyRuleGroupName()

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

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

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

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

    • proxyRuleGroupArn

      public final String proxyRuleGroupArn()

      The Amazon Resource Name (ARN) of a proxy rule group.

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

      Returns:
      The Amazon Resource Name (ARN) of a proxy rule group.

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

    • proxyRuleName

      public final String proxyRuleName()

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

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

    • description

      public final String description()

      A description of the proxy rule.

      Returns:
      A description of the proxy rule.

    • action

      public final ProxyRulePhaseAction action()

      Depending on the match action, the proxy either stops the evaluation (if the action is terminal - allow or deny), or continues it (if the action is alert) until it matches a rule with a terminal action.

      If the service returns an enum value that is not available in the current SDK version, action will return ProxyRulePhaseAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().

      Returns:
      Depending on the match action, the proxy either stops the evaluation (if the action is terminal - allow or deny), or continues it (if the action is alert) until it matches a rule with a terminal action.
      See Also:

    • actionAsString

      public final String actionAsString()

      Depending on the match action, the proxy either stops the evaluation (if the action is terminal - allow or deny), or continues it (if the action is alert) until it matches a rule with a terminal action.

      If the service returns an enum value that is not available in the current SDK version, action will return ProxyRulePhaseAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().

      Returns:
      Depending on the match action, the proxy either stops the evaluation (if the action is terminal - allow or deny), or continues it (if the action is alert) until it matches a rule with a terminal action.
      See Also:

    • hasAddConditions

      public final boolean hasAddConditions()
      For responses, this returns true if the service returned a value for the AddConditions 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.

    • addConditions

      public final List<ProxyRuleCondition> addConditions()

      Proxy rule conditions to add. Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.

      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 hasAddConditions() method.

      Returns:
      Proxy rule conditions to add. Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.

    • hasRemoveConditions

      public final boolean hasRemoveConditions()
      For responses, this returns true if the service returned a value for the RemoveConditions 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.

    • removeConditions

      public final List<ProxyRuleCondition> removeConditions()

      Proxy rule conditions to remove. Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.

      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 hasRemoveConditions() method.

      Returns:
      Proxy rule conditions to remove. Match criteria that specify what traffic attributes to examine. Conditions include operators (StringEquals, StringLike) and values to match against.

    • updateToken

      public final String updateToken()

      A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy rule. The token marks the state of the proxy rule resource at the time of the request.

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

      Returns:
      A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy rule. The token marks the state of the proxy rule resource at the time of the request.

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

    • toBuilder

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

    • builder

      public static UpdateProxyRuleRequest.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.