Class SimpleCriterionForJob

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

Specifies a property-based condition that determines whether an S3 bucket is included or excluded from a classification job.

See Also:

  • Method Details

    • comparator

      public final JobComparator comparator()

      The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).

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

      Returns:
      The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).
      See Also:

    • comparatorAsString

      public final String comparatorAsString()

      The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).

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

      Returns:
      The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).
      See Also:

    • key

      public final SimpleCriterionKeyForJob key()

      The property to use in the condition.

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

      Returns:
      The property to use in the condition.
      See Also:

    • keyAsString

      public final String keyAsString()

      The property to use in the condition.

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

      Returns:
      The property to use in the condition.
      See Also:

    • hasValues

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

    • values

      public final List<String> values()

      An array that lists one or more values to use in the condition. If you specify multiple values, Amazon Macie uses OR logic to join the values. Valid values for each supported property (key) are:

      • ACCOUNT_ID - A string that represents the unique identifier for the Amazon Web Services account that owns the bucket.

      • S3_BUCKET_EFFECTIVE_PERMISSION - A string that represents an enumerated value that Macie defines for the BucketPublicAccess.effectivePermission property of a bucket.

      • S3_BUCKET_NAME - A string that represents the name of a bucket.

      • S3_BUCKET_SHARED_ACCESS - A string that represents an enumerated value that Macie defines for the BucketMetadata.sharedAccess property of a bucket.

      Values are case sensitive. Also, Macie doesn't support use of partial values or wildcard characters in these values.

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

      Returns:
      An array that lists one or more values to use in the condition. If you specify multiple values, Amazon Macie uses OR logic to join the values. Valid values for each supported property (key) are:

      • ACCOUNT_ID - A string that represents the unique identifier for the Amazon Web Services account that owns the bucket.

      • S3_BUCKET_EFFECTIVE_PERMISSION - A string that represents an enumerated value that Macie defines for the BucketPublicAccess.effectivePermission property of a bucket.

      • S3_BUCKET_NAME - A string that represents the name of a bucket.

      • S3_BUCKET_SHARED_ACCESS - A string that represents an enumerated value that Macie defines for the BucketMetadata.sharedAccess property of a bucket.

      Values are case sensitive. Also, Macie doesn't support use of partial values or wildcard characters in these values.

    • toBuilder

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

    • builder

      public static SimpleCriterionForJob.Builder builder()

    • serializableBuilderClass

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