Class DetectionRuleOrgConfiguration

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

Contains the 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 execution mode of the organization configuration. Valid values: LIVE | DRY_RUN.

      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 execution mode of the organization configuration. Valid values: LIVE | DRY_RUN.
      See Also:

    • modeAsString

      public final String modeAsString()

      The execution mode of the organization configuration. Valid values: LIVE | DRY_RUN.

      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 execution mode of the organization configuration. Valid values: LIVE | DRY_RUN.
      See Also:

    • status

      public final DetectionRuleConfigurationStatus status()

      The configuration status. Valid values: ACTIVE | PROCESSING | FAILED.

      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. Valid values: ACTIVE | PROCESSING | FAILED.
      See Also:

    • statusAsString

      public final String statusAsString()

      The configuration status. Valid values: ACTIVE | PROCESSING | FAILED.

      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. Valid values: ACTIVE | PROCESSING | FAILED.
      See Also:

    • statusReason

      public final String statusReason()

      The reason for the current configuration status.

      Returns:
      The reason for the current configuration status.

    • hasIncludeAccountIds

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

    • includeAccountIds

      public final List<String> includeAccountIds()

      A list of member account IDs included in the organization configuration. Mutually exclusive with ExcludeAccountIds.

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

      Returns:
      A list of member account IDs included in the organization configuration. Mutually exclusive with ExcludeAccountIds.

    • hasExcludeAccountIds

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

    • excludeAccountIds

      public final List<String> excludeAccountIds()

      A list of member account IDs excluded from the organization configuration. Mutually exclusive with IncludeAccountIds.

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

      Returns:
      A list of member account IDs excluded from the organization configuration. Mutually exclusive with IncludeAccountIds.

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

    • builder

      public static DetectionRuleOrgConfiguration.Builder builder()

    • serializableBuilderClass

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