Class ProxyConfiguration

java.lang.Object
software.amazon.awssdk.services.networkfirewall.model.ProxyConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ProxyConfiguration.Builder,ProxyConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class ProxyConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ProxyConfiguration.Builder,ProxyConfiguration>

A Proxy Configuration defines the monitoring and protection behavior for a Proxy. The details of the behavior are defined in the rule groups that you add to your configuration.

See Also:

  • Method Details

    • proxyConfigurationName

      public final String proxyConfigurationName()

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

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

    • proxyConfigurationArn

      public final String proxyConfigurationArn()

      The Amazon Resource Name (ARN) of a proxy configuration.

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

    • description

      public final String description()

      A description of the proxy configuration.

      Returns:
      A description of the proxy configuration.

    • createTime

      public final Instant createTime()

      Time the Proxy Configuration was created.

      Returns:
      Time the Proxy Configuration was created.

    • deleteTime

      public final Instant deleteTime()

      Time the Proxy Configuration was deleted.

      Returns:
      Time the Proxy Configuration was deleted.

    • hasRuleGroups

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

    • ruleGroups

      public final List<ProxyConfigRuleGroup> ruleGroups()

      Proxy rule groups within the proxy configuration.

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

      Returns:
      Proxy rule groups within the proxy configuration.

    • defaultRulePhaseActions

      public final ProxyConfigDefaultRulePhaseActionsRequest defaultRulePhaseActions()

      Evaluation points in the traffic flow where rules are applied. There are three phases in a traffic where the rule match is applied.

      Pre-DNS - before domain resolution.

      Pre-Request - after DNS, before request.

      Post-Response - after receiving response.

      Returns:
      Evaluation points in the traffic flow where rules are applied. There are three phases in a traffic where the rule match is applied.

      Pre-DNS - before domain resolution.

      Pre-Request - after DNS, before request.

      Post-Response - after receiving response.

    • 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 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.

    • tags

      public final List<Tag> tags()

      The key:value pairs to associate with the resource.

      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 key:value pairs to associate with the resource.

    • toBuilder

      public ProxyConfiguration.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<ProxyConfiguration.Builder,ProxyConfiguration>
      Returns:
      a builder for type T

    • builder

      public static ProxyConfiguration.Builder builder()

    • serializableBuilderClass

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

    • 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.