CreateCustomDataIdentifierRequest (AWS Java SDK :: Services

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

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateCustomDataIdentifierRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateCustomDataIdentifierRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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()` 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).
`boolean`	`hasTags()` Returns true if the Tags 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`	`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()`
`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.

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
  - clientToken
```
public String clientToken()
```
    A unique, case-sensitive token that you provide to ensure the idempotency of the request.
    
    Returns:
    
    A unique, case-sensitive token that you provide to ensure the idempotency of the request.
  - description
```
public 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 the identifier's description, depending on the actions that they're allowed to perform in Amazon Macie.
    
    Returns:
    
    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 the identifier's description, depending on the actions that they're allowed to perform in Amazon Macie.
  - 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.
  - name
```
public 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 the identifier's name, depending on the actions that they're allowed to perform in Amazon Macie.
    
    Returns:
    
    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 the identifier's name, depending on the actions that they're allowed to perform in Amazon Macie.
  - 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.
  - hasTags
```
public boolean hasTags()
```
    Returns true if the Tags 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.
  - tags
```
public 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.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    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.
  - toBuilder
```
public CreateCustomDataIdentifierRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateCustomDataIdentifierRequest.Builder,CreateCustomDataIdentifierRequest>
    
    Specified by:
    
    toBuilder in class Macie2Request
  - builder
```
public static CreateCustomDataIdentifierRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateCustomDataIdentifierRequest.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

Class CreateCustomDataIdentifierRequest

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

clientToken

description

hasIgnoreWords

ignoreWords

hasKeywords

keywords

maximumMatchDistance

name

regex

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields