Package software.amazon.awssdk.services.macie2.model

Class S3ClassificationScopeExclusionUpdate

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

Specifies S3 buckets to add or remove from the exclusion list defined by the classification scope for an Amazon Macie account.

See Also:

  • Method Details

    • hasBucketNames

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

    • bucketNames

      public final List<String> bucketNames()

      Depending on the value specified for the update operation (ClassificationScopeUpdateOperation), an array of strings that: lists the names of buckets to add or remove from the list, or specifies a new set of bucket names that overwrites all existing names in the list. Each string must be the full name of an S3 bucket. Values are case sensitive.

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

      Returns:
      Depending on the value specified for the update operation (ClassificationScopeUpdateOperation), an array of strings that: lists the names of buckets to add or remove from the list, or specifies a new set of bucket names that overwrites all existing names in the list. Each string must be the full name of an S3 bucket. Values are case sensitive.

    • operation

      public final ClassificationScopeUpdateOperation operation()

      Specifies how to apply the changes to the exclusion list. Valid values are:

      • ADD - Append the specified bucket names to the current list.

      • REMOVE - Remove the specified bucket names from the current list.

      • REPLACE - Overwrite the current list with the specified list of bucket names. If you specify this value, Amazon Macie removes all existing names from the list and adds all the specified names to the list.

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

      Returns:
      Specifies how to apply the changes to the exclusion list. Valid values are:

      • ADD - Append the specified bucket names to the current list.

      • REMOVE - Remove the specified bucket names from the current list.

      • REPLACE - Overwrite the current list with the specified list of bucket names. If you specify this value, Amazon Macie removes all existing names from the list and adds all the specified names to the list.

      See Also:

    • operationAsString

      public final String operationAsString()

      Specifies how to apply the changes to the exclusion list. Valid values are:

      • ADD - Append the specified bucket names to the current list.

      • REMOVE - Remove the specified bucket names from the current list.

      • REPLACE - Overwrite the current list with the specified list of bucket names. If you specify this value, Amazon Macie removes all existing names from the list and adds all the specified names to the list.

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

      Returns:
      Specifies how to apply the changes to the exclusion list. Valid values are:

      • ADD - Append the specified bucket names to the current list.

      • REMOVE - Remove the specified bucket names from the current list.

      • REPLACE - Overwrite the current list with the specified list of bucket names. If you specify this value, Amazon Macie removes all existing names from the list and adds all the specified names to the list.

      See Also:

    • toBuilder

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

    • builder

      public static S3ClassificationScopeExclusionUpdate.Builder builder()

    • serializableBuilderClass

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