@Generated(value="software.amazon.awssdk:codegen") public final class CreateCustomDataIdentifierRequest extends Macie2Request implements ToCopyableBuilder<CreateCustomDataIdentifierRequest.Builder,CreateCustomDataIdentifierRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateCustomDataIdentifierRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static CreateCustomDataIdentifierRequest.Builder |
builder() |
String |
clientToken()
A unique, case-sensitive token that you provide to ensure the idempotency of the request.
|
String |
description()
A custom description of the custom data identifier.
|
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.
|
boolean |
hasSeverityLevels()
For responses, this returns true if the service returned a value for the SeverityLevels property.
|
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags 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 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 regular expression and the
character sequences specified by the keywords array.
|
String |
name()
A custom name for the custom data identifier.
|
String |
regex()
The regular expression (regex) that defines the pattern to match.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateCustomDataIdentifierRequest.Builder> |
serializableBuilderClass() |
List<SeverityLevel> |
severityLevels()
The severity to assign to findings that the custom data identifier produces, based on the number of occurrences
of text that matches the custom data identifier's detection criteria.
|
Map<String,String> |
tags()
A map of key-value pairs that specifies the tags to associate with the custom data identifier.
|
CreateCustomDataIdentifierRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String clientToken()
A unique, case-sensitive token that you provide to ensure the idempotency of the request.
public final String description()
A custom description of the custom data identifier. The description can contain as many as 512 characters.
We strongly recommend that you avoid including any sensitive data in the description of a custom data identifier. Other users of your account might be able to see this description, depending on the actions that they're allowed to perform in Amazon Macie.
We strongly recommend that you avoid including any sensitive data in the description of a custom data identifier. Other users of your account might be able to see this description, depending on the actions that they're allowed to perform in Amazon Macie.
public final boolean hasIgnoreWords()
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.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.
public final boolean hasKeywords()
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.public final 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 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.
public final Integer maximumMatchDistance()
The maximum number of characters that can exist between text that matches the regular expression and the character sequences specified by the keywords array. Amazon Macie includes or excludes a result based on the proximity of a keyword to text that matches the regular expression. The distance can be 1-300 characters. The default value is 50.
public final String name()
A custom name for the custom data identifier. The name can contain as many as 128 characters.
We strongly recommend that you avoid including any sensitive data in the name of a custom data identifier. Other users of your account might be able to see this name, depending on the actions that they're allowed to perform in Amazon Macie.
We strongly recommend that you avoid including any sensitive data in the name of a custom data identifier. Other users of your account might be able to see this name, depending on the actions that they're allowed to perform in Amazon Macie.
public final String regex()
The regular expression (regex) that defines the pattern to match. The expression can contain as many as 512 characters.
public final boolean hasSeverityLevels()
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.public final List<SeverityLevel> severityLevels()
The severity to assign to findings that the custom data identifier produces, based on the number of occurrences of text that matches the custom data identifier's detection criteria. You can specify as many as three SeverityLevel objects in this array, one for each severity: LOW, MEDIUM, or HIGH. If you specify more than one, the occurrences thresholds must be in ascending order by severity, moving from LOW to HIGH. For example, 1 for LOW, 50 for MEDIUM, and 100 for HIGH. If an S3 object contains fewer occurrences than the lowest specified threshold, Amazon Macie doesn't create a finding.
If you don't specify any values for this array, Macie creates findings for S3 objects that contain at least one occurrence of text that matches the detection criteria, and Macie assigns the MEDIUM severity to those findings.
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 hasSeverityLevels() method.
If you don't specify any values for this array, Macie creates findings for S3 objects that contain at least one occurrence of text that matches the detection criteria, and Macie assigns the MEDIUM severity to those findings.
public final boolean hasTags()
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.public final Map<String,String> tags()
A map of key-value pairs that specifies the tags to associate with the custom data identifier.
A custom data identifier can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
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 hasTags() method.
A custom data identifier can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
public CreateCustomDataIdentifierRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<CreateCustomDataIdentifierRequest.Builder,CreateCustomDataIdentifierRequest>toBuilder in class Macie2Requestpublic static CreateCustomDataIdentifierRequest.Builder builder()
public static Class<? extends CreateCustomDataIdentifierRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2021. All rights reserved.