Class CreateRuleSnapshotResponse

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

  • Method Details

    • ruleId

      public final String ruleId()

      The service-generated id of the rule.

      Returns:
      The service-generated id of the rule.

    • ruleArn

      public final String ruleArn()

      The Amazon Resource Name (ARN) of the rule.

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

    • ruleName

      public final String ruleName()

      The name of the rule.

      Returns:
      The name of the rule.

    • firewallType

      public final RuleFirewallType firewallType()

      The firewall type associated with the resource.

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

      Returns:
      The firewall type associated with the resource.
      See Also:

    • firewallTypeAsString

      public final String firewallTypeAsString()

      The firewall type associated with the resource.

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

      Returns:
      The firewall type associated with the resource.
      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:

    • ruleDescription

      public final String ruleDescription()

      A description of the rule.

      Returns:
      A description of the rule.

    • configuration

      public final Document configuration()

      The firewall configuration for the rule, as a JSON document. The structure depends on the rule's firewall type and rule type.

      Returns:
      The firewall configuration for the rule, as a JSON document. The structure depends on the rule's firewall type and rule type.

    • status

      public final EntityStatus status()

      The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).

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

      Returns:
      The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).

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

      Returns:
      The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
      See Also:

    • version

      public final String version()

      The version of the resource.

      Returns:
      The version of the resource.

    • updateToken

      public final String updateToken()

      A token used for optimistic concurrency control. Each read and write returns an updateToken. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.

      Returns:
      A token used for optimistic concurrency control. Each read and write returns an updateToken. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.

    • isSnapshot

      public final Boolean isSnapshot()

      Specifies whether the resource is a snapshot of a published version.

      Returns:
      Specifies whether the resource is a snapshot of a published version.

    • hasPublishedVersion

      public final Boolean hasPublishedVersion()

      Specifies whether a published version of the resource exists.

      Returns:
      Specifies whether a published version of the resource exists.

    • updatedAt

      public final Instant updatedAt()

      The time when the snapshot was created.

      Returns:
      The time when the snapshot was created.

    • toBuilder

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

    • builder

      public static CreateRuleSnapshotResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateRuleSnapshotResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.