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.TestCustomDataIdentifierRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<TestCustomDataIdentifierRequest.Builder,TestCustomDataIdentifierRequest>

@Generated("software.amazon.awssdk:codegen")
public final class TestCustomDataIdentifierRequest
extends Macie2Request
implements ToCopyableBuilder<TestCustomDataIdentifierRequest.Builder,TestCustomDataIdentifierRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface TestCustomDataIdentifierRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static TestCustomDataIdentifierRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasIgnoreWords()`	For responses, this returns true if the service returned a value for the IgnoreWords property.
`boolean`	`hasKeywords()`	For responses, this returns true if the service returned a value for the Keywords property.
`List<String>`	`ignoreWords()`	An array that lists specific character sequences (ignore words) to exclude from the results.
`List<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.
`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.
`String`	`regex()`	The regular expression (regex) that defines the pattern to match.
`String`	`sampleText()`	The sample text to inspect by using the custom data identifier.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends TestCustomDataIdentifierRequest.Builder>`	`serializableBuilderClass()`
`TestCustomDataIdentifierRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - hasIgnoreWords
```
public final boolean hasIgnoreWords()
```
    For responses, this returns true if the service returned a value for the IgnoreWords 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.
  - ignoreWords
```
public final List<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.
    
    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 hasIgnoreWords() method.
    
    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.
  - hasKeywords
```
public final boolean hasKeywords()
```
    For responses, this returns true if the service returned a value for the Keywords 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.
  - keywords
```
public final List<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.
    
    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 hasKeywords() method.
    
    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.
  - maximumMatchDistance
```
public final 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.
    
    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.
  - regex
```
public final String regex()
```
    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.
  - sampleText
```
public final String sampleText()
```
    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.
  - toBuilder
```
public TestCustomDataIdentifierRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<TestCustomDataIdentifierRequest.Builder,TestCustomDataIdentifierRequest>
    
    Specified by:
    
    toBuilder in class Macie2Request
  - builder
```
public static TestCustomDataIdentifierRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends TestCustomDataIdentifierRequest.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class TestCustomDataIdentifierRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

hasIgnoreWords

ignoreWords

hasKeywords

keywords

maximumMatchDistance

regex

sampleText

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields