Class DetectionRuleOrgConfigurationSummary

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

Contains summary information about an organization-level configuration for a custom detection rule.

See Also:

  • Method Details

    • ruleId

      public final String ruleId()

      The unique identifier for the custom detection rule.

      Returns:
      The unique identifier for the custom detection rule.

    • mode

      public final AssociationMode mode()

      The rule execution mode.

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

      Returns:
      The rule execution mode.
      See Also:

    • modeAsString

      public final String modeAsString()

      The rule execution mode.

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

      Returns:
      The rule execution mode.
      See Also:

    • status

      public final DetectionRuleConfigurationStatus status()

      The configuration status.

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

      Returns:
      The configuration status.
      See Also:

    • statusAsString

      public final String statusAsString()

      The configuration status.

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

      Returns:
      The configuration status.
      See Also:

    • statusReason

      public final String statusReason()

      The reason for the current configuration status.

      Returns:
      The reason for the current configuration status.

    • createdAt

      public final Instant createdAt()

      The timestamp when the organization configuration was created.

      Returns:
      The timestamp when the organization configuration was created.

    • updatedAt

      public final Instant updatedAt()

      The timestamp when the organization configuration was last updated.

      Returns:
      The timestamp when the organization configuration was last updated.

    • expiresAt

      public final Instant expiresAt()

      The timestamp when the organization configuration expires.

      Returns:
      The timestamp when the organization configuration expires.

    • toBuilder

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

    • builder

      public static DetectionRuleOrgConfigurationSummary.Builder builder()

    • serializableBuilderClass

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