Class GenerateRuleConfigurationRequest

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

  • Method Details

    • prompt

      public final String prompt()

      A natural-language description of the configuration that you want to generate.

      Returns:
      A natural-language description of the configuration that you want to generate.

    • ruleFirewallType

      public final RuleFirewallType ruleFirewallType()

      The firewall type of the rule.

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

      Returns:
      The firewall type of the rule.
      See Also:

    • ruleFirewallTypeAsString

      public final String ruleFirewallTypeAsString()

      The firewall type of the rule.

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

      Returns:
      The firewall type of the rule.
      See Also:

    • ruleType

      public final RuleType ruleType()

      The type of the rule. CONFIGURATION rules contain firewall settings, and INSPECTION rules contain rule groups.

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

      Returns:
      The type of the rule. CONFIGURATION rules contain firewall settings, and INSPECTION rules contain rule groups.
      See Also:

    • ruleTypeAsString

      public final String ruleTypeAsString()

      The type of the rule. CONFIGURATION rules contain firewall settings, and INSPECTION rules contain rule groups.

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

      Returns:
      The type of the rule. CONFIGURATION rules contain firewall settings, and INSPECTION rules contain rule groups.
      See Also:

    • wafConfigDataType

      public final WAFConfigDataType wafConfigDataType()

      For AWS WAF configuration rules, the specific AWS WAF configuration variant to generate. This is optional; if you omit it, the service selects the variant.

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

      Returns:
      For AWS WAF configuration rules, the specific AWS WAF configuration variant to generate. This is optional; if you omit it, the service selects the variant.
      See Also:

    • wafConfigDataTypeAsString

      public final String wafConfigDataTypeAsString()

      For AWS WAF configuration rules, the specific AWS WAF configuration variant to generate. This is optional; if you omit it, the service selects the variant.

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

      Returns:
      For AWS WAF configuration rules, the specific AWS WAF configuration variant to generate. This is optional; if you omit it, the service selects the variant.
      See Also:

    • currentConfiguration

      public final String currentConfiguration()

      An existing configuration to edit, as a JSON string. When you provide this value, the operation edits the configuration. When you omit it, the operation generates a new configuration.

      Returns:
      An existing configuration to edit, as a JSON string. When you provide this value, the operation edits the configuration. When you omit it, the operation generates a new configuration.

    • clientToken

      public final String clientToken()

      A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.

      Returns:
      A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.

    • toBuilder

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

    • builder

      public static GenerateRuleConfigurationRequest.Builder builder()

    • serializableBuilderClass

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