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

Class UpdateAllowListRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.macie2.model.Macie2Request
software.amazon.awssdk.services.macie2.model.UpdateAllowListRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateAllowListRequest.Builder,UpdateAllowListRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateAllowListRequest extends Macie2Request implements ToCopyableBuilder<UpdateAllowListRequest.Builder,UpdateAllowListRequest>

  • Method Details

    • criteria

      public final AllowListCriteria criteria()

      The criteria that specify the text or text pattern to ignore. The criteria can be the location and name of an S3 object that lists specific text to ignore (s3WordsList), or a regular expression that defines a text pattern to ignore (regex).

      You can change a list's underlying criteria, such as the name of the S3 object or the regular expression to use. However, you can't change the type from s3WordsList to regex or the other way around.

      Returns:
      The criteria that specify the text or text pattern to ignore. The criteria can be the location and name of an S3 object that lists specific text to ignore (s3WordsList), or a regular expression that defines a text pattern to ignore (regex).

      You can change a list's underlying criteria, such as the name of the S3 object or the regular expression to use. However, you can't change the type from s3WordsList to regex or the other way around.

    • description

      public final String description()

      A custom description of the allow list. The description can contain as many as 512 characters.

      Returns:
      A custom description of the allow list. The description can contain as many as 512 characters.

    • id

      public final String id()

      The unique identifier for the Amazon Macie resource that the request applies to.

      Returns:
      The unique identifier for the Amazon Macie resource that the request applies to.

    • name

      public final String name()

      A custom name for the allow list. The name can contain as many as 128 characters.

      Returns:
      A custom name for the allow list. The name can contain as many as 128 characters.

    • toBuilder

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

    • builder

      public static UpdateAllowListRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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