software.amazon.awssdk.services.macie2.model

Class TestCustomDataIdentifierRequest

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(value="software.amazon.awssdk:codegen")
public final class TestCustomDataIdentifierRequest
extends Macie2Request
implements ToCopyableBuilder<TestCustomDataIdentifierRequest.Builder,TestCustomDataIdentifierRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	TestCustomDataIdentifierRequest.Builder

Method Summary

Modifier and Type	Method and 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() Returns true if the IgnoreWords property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasKeywords() Returns true if the Keywords property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
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 be within proximity (maximumMatchDistance) of the regular expression to match.
Integer	maximumMatchDistance() The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the keywords array.
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 boolean hasIgnoreWords()

Returns true if the IgnoreWords property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

ignoreWords

public 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 is the same as 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 characters. Ignore words are case sensitive.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasIgnoreWords() to see if a value was sent in this field.

Returns:

An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression is the same as 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 characters. Ignore words are case sensitive.

hasKeywords

public boolean hasKeywords()

Returns true if the Keywords property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

keywords

public List<String> keywords()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasKeywords() to see if a value was sent in this field.

Returns:

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

maximumMatchDistance

public Integer maximumMatchDistance()

The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the keywords array. Macie includes or excludes a result based on the proximity of a keyword to text that matches the regex pattern. The distance can be 1 - 300 characters. The default value is 50.

Returns:

The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the keywords array. Macie includes or excludes a result based on the proximity of a keyword to text that matches the regex pattern. The distance can be 1 - 300 characters. The default value is 50.

regex

public 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 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 int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo