All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class TestCustomDataIdentifierRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable 

See Also:

AWS API Documentation, Serialized Form

• Field Summary

  • Fields inherited from class com.amazonaws.AmazonWebServiceRequest

    NOOP

• Constructor Summary

  Constructors

  Constructor and Description
  TestCustomDataIdentifierRequest ()

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  TestCustomDataIdentifierRequest	clone () Creates a shallow clone of this object for all fields except the handler context.
  boolean	equals (Object obj)
  List<String>	getIgnoreWords () An array that lists specific character sequences (ignore words) to exclude from the results.
  List<String>	getKeywords () An array that lists specific character sequences (keywords), one of which must precede and be within proximity (maximumMatchDistance) of the regular expression to match.
  Integer	getMaximumMatchDistance () The maximum number of characters that can exist between the end of at least one complete character sequence specified by the keywords array and the end of the text that matches the regex pattern.
  String	getRegex () The regular expression (regex) that defines the pattern to match.
  String	getSampleText () The sample text to inspect by using the custom data identifier.
  int	hashCode ()
  void	setIgnoreWords (Collection<String> ignoreWords) An array that lists specific character sequences (ignore words) to exclude from the results.
  void	setKeywords (Collection<String> keywords) An array that lists specific character sequences (keywords), one of which must precede and be within proximity (maximumMatchDistance) of the regular expression to match.
  void	setMaximumMatchDistance (Integer maximumMatchDistance) The maximum number of characters that can exist between the end of at least one complete character sequence specified by the keywords array and the end of the text that matches the regex pattern.
  void	setRegex (String regex) The regular expression (regex) that defines the pattern to match.
  void	setSampleText (String sampleText) The sample text to inspect by using the custom data identifier.
  String	toString () Returns a string representation of this object.
  TestCustomDataIdentifierRequest	withIgnoreWords (Collection<String> ignoreWords) An array that lists specific character sequences (ignore words) to exclude from the results.
  TestCustomDataIdentifierRequest	withIgnoreWords (String... ignoreWords) An array that lists specific character sequences (ignore words) to exclude from the results.
  TestCustomDataIdentifierRequest	withKeywords (Collection<String> keywords) An array that lists specific character sequences (keywords), one of which must precede and be within proximity (maximumMatchDistance) of the regular expression to match.
  TestCustomDataIdentifierRequest	withKeywords (String... keywords) An array that lists specific character sequences (keywords), one of which must precede and be within proximity (maximumMatchDistance) of the regular expression to match.
  TestCustomDataIdentifierRequest	withMaximumMatchDistance (Integer maximumMatchDistance) The maximum number of characters that can exist between the end of at least one complete character sequence specified by the keywords array and the end of the text that matches the regex pattern.
  TestCustomDataIdentifierRequest	withRegex (String regex) The regular expression (regex) that defines the pattern to match.
  TestCustomDataIdentifierRequest	withSampleText (String sampleText) The sample text to inspect by using the custom data identifier.

  • Methods inherited from class com.amazonaws.AmazonWebServiceRequest

    addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

  • Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

• Constructor Detail

  • TestCustomDataIdentifierRequest

    public TestCustomDataIdentifierRequest()

• Method Detail

  • getIgnoreWords

    public List<String> getIgnoreWords()

    An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression contains any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4-90 UTF-8 characters. Ignore words are case sensitive.

    Returns:

    An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression contains any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4-90 UTF-8 characters. Ignore words are case sensitive.

  • setIgnoreWords

    public void setIgnoreWords(Collection<String> ignoreWords)

    An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression contains any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4-90 UTF-8 characters. Ignore words are case sensitive.

    Parameters:

    ignoreWords - An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression contains any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4-90 UTF-8 characters. Ignore words are case sensitive.

  • withIgnoreWords

    public TestCustomDataIdentifierRequest withIgnoreWords(String... ignoreWords)

    An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression contains any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4-90 UTF-8 characters. Ignore words are case sensitive.

    NOTE: This method appends the values to the existing list (if any). Use setIgnoreWords(java.util.Collection) or withIgnoreWords(java.util.Collection) if you want to override the existing values.

    Parameters:

    ignoreWords - An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression contains any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4-90 UTF-8 characters. Ignore words are case sensitive.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • withIgnoreWords

    public TestCustomDataIdentifierRequest withIgnoreWords(Collection<String> ignoreWords)

    An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression contains any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4-90 UTF-8 characters. Ignore words are case sensitive.

    Parameters:

    ignoreWords - An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression contains any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4-90 UTF-8 characters. Ignore words are case sensitive.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • getKeywords

    public List<String> getKeywords()

    An array that lists specific character sequences (keywords), one of which must precede and be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 3-90 UTF-8 characters. Keywords aren't case sensitive.

    Returns:

    An array that lists specific character sequences (keywords), one of which must precede and be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 3-90 UTF-8 characters. Keywords aren't case sensitive.

  • setKeywords

    public void setKeywords(Collection<String> keywords)

    An array that lists specific character sequences (keywords), one of which must precede and be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 3-90 UTF-8 characters. Keywords aren't case sensitive.

    Parameters:

    keywords - An array that lists specific character sequences (keywords), one of which must precede and be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 3-90 UTF-8 characters. Keywords aren't case sensitive.

  • withKeywords

    public TestCustomDataIdentifierRequest withKeywords(String... keywords)

    An array that lists specific character sequences (keywords), one of which must precede and be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 3-90 UTF-8 characters. Keywords aren't case sensitive.

    NOTE: This method appends the values to the existing list (if any). Use setKeywords(java.util.Collection) or withKeywords(java.util.Collection) if you want to override the existing values.

    Parameters:

    keywords - An array that lists specific character sequences (keywords), one of which must precede and be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 3-90 UTF-8 characters. Keywords aren't case sensitive.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • withKeywords

    public TestCustomDataIdentifierRequest withKeywords(Collection<String> keywords)

    An array that lists specific character sequences (keywords), one of which must precede and be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 3-90 UTF-8 characters. Keywords aren't case sensitive.

    Parameters:

    keywords - An array that lists specific character sequences (keywords), one of which must precede and be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 3-90 UTF-8 characters. Keywords aren't case sensitive.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setMaximumMatchDistance

    public void setMaximumMatchDistance(Integer maximumMatchDistance)

    The maximum number of characters that can exist between the end of at least one complete character sequence specified by the keywords array and the end of the text that matches the regex pattern. If a complete keyword precedes all the text that matches the pattern and the keyword is within the specified distance, Amazon Macie includes the result. The distance can be 1-300 characters. The default value is 50.

    Parameters:

    maximumMatchDistance - The maximum number of characters that can exist between the end of at least one complete character sequence specified by the keywords array and the end of the text that matches the regex pattern. If a complete keyword precedes all the text that matches the pattern and the keyword is within the specified distance, Amazon Macie includes the result. The distance can be 1-300 characters. The default value is 50.

  • getMaximumMatchDistance

    public Integer getMaximumMatchDistance()

    The maximum number of characters that can exist between the end of at least one complete character sequence specified by the keywords array and the end of the text that matches the regex pattern. If a complete keyword precedes all the text that matches the pattern and the keyword is within the specified distance, Amazon Macie includes the result. The distance can be 1-300 characters. The default value is 50.

    Returns:

    The maximum number of characters that can exist between the end of at least one complete character sequence specified by the keywords array and the end of the text that matches the regex pattern. If a complete keyword precedes all the text that matches the pattern and the keyword is within the specified distance, Amazon Macie includes the result. The distance can be 1-300 characters. The default value is 50.

  • withMaximumMatchDistance

    public TestCustomDataIdentifierRequest withMaximumMatchDistance(Integer maximumMatchDistance)

    The maximum number of characters that can exist between the end of at least one complete character sequence specified by the keywords array and the end of the text that matches the regex pattern. If a complete keyword precedes all the text that matches the pattern and the keyword is within the specified distance, Amazon Macie includes the result. The distance can be 1-300 characters. The default value is 50.

    Parameters:

    maximumMatchDistance - The maximum number of characters that can exist between the end of at least one complete character sequence specified by the keywords array and the end of the text that matches the regex pattern. If a complete keyword precedes all the text that matches the pattern and the keyword is within the specified distance, Amazon Macie includes the result. The distance can be 1-300 characters. The default value is 50.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setRegex

    public void setRegex(String regex)

    The regular expression (regex) that defines the pattern to match. The expression can contain as many as 512 characters.

    Parameters:

    regex - The regular expression (regex) that defines the pattern to match. The expression can contain as many as 512 characters.

  • getRegex

    public String getRegex()

    The regular expression (regex) that defines the pattern to match. The expression can contain as many as 512 characters.

    Returns:

    The regular expression (regex) that defines the pattern to match. The expression can contain as many as 512 characters.

  • withRegex

    public TestCustomDataIdentifierRequest withRegex(String regex)

    The regular expression (regex) that defines the pattern to match. The expression can contain as many as 512 characters.

    Parameters:

    regex - The regular expression (regex) that defines the pattern to match. The expression can contain as many as 512 characters.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • setSampleText

    public void setSampleText(String sampleText)

    The sample text to inspect by using the custom data identifier. The text can contain as many as 1,000 characters.

    Parameters:

    sampleText - The sample text to inspect by using the custom data identifier. The text can contain as many as 1,000 characters.

  • getSampleText

    public String getSampleText()

    The sample text to inspect by using the custom data identifier. The text can contain as many as 1,000 characters.

    Returns:

    The sample text to inspect by using the custom data identifier. The text can contain as many as 1,000 characters.

  • withSampleText

    public TestCustomDataIdentifierRequest withSampleText(String sampleText)

    The sample text to inspect by using the custom data identifier. The text can contain as many as 1,000 characters.

    Parameters:

    sampleText - The sample text to inspect by using the custom data identifier. The text can contain as many as 1,000 characters.

    Returns:

    Returns a reference to this object so that method calls can be chained together.

  • toString

    public 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

    Returns:

    A string representation of this object.

    See Also:

    Object.toString()

  • equals

    public boolean equals(Object obj)

    Overrides:

    equals in class Object

  • hashCode

    public int hashCode()

    Overrides:

    hashCode in class Object

  • clone

    public TestCustomDataIdentifierRequest clone()

    Description copied from class: AmazonWebServiceRequest
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

    Overrides:

    clone in class AmazonWebServiceRequest

    See Also:

    Object.clone()