com.amazonaws.services.macie2.model

Class CreateCustomDataIdentifierRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.macie2.model.CreateCustomDataIdentifierRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateCustomDataIdentifierRequest
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
CreateCustomDataIdentifierRequest()

Method Summary

Modifier and Type	Method and Description
CreateCustomDataIdentifierRequest	addTagsEntry(String key, String value) Add a single Tags entry
CreateCustomDataIdentifierRequest	clearTagsEntries() Removes all the entries added into Tags.
CreateCustomDataIdentifierRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getClientToken() A unique, case-sensitive token that you provide to ensure the idempotency of the request.
String	getDescription() A custom description of the custom data identifier.
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 be within proximity (maximumMatchDistance) of the regular expression to match.
Integer	getMaximumMatchDistance() 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	getName() A custom name for the custom data identifier.
String	getRegex() The regular expression (regex) that defines the pattern to match.
Map<String,String>	getTags() A map of key-value pairs that specifies the tags to associate with the custom data identifier.
int	hashCode()
void	setClientToken(String clientToken) A unique, case-sensitive token that you provide to ensure the idempotency of the request.
void	setDescription(String description) A custom description of the custom data identifier.
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 be within proximity (maximumMatchDistance) of the regular expression to match.
void	setMaximumMatchDistance(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.
void	setName(String name) A custom name for the custom data identifier.
void	setRegex(String regex) The regular expression (regex) that defines the pattern to match.
void	setTags(Map<String,String> tags) A map of key-value pairs that specifies the tags to associate with the custom data identifier.
String	toString() Returns a string representation of this object.
CreateCustomDataIdentifierRequest	withClientToken(String clientToken) A unique, case-sensitive token that you provide to ensure the idempotency of the request.
CreateCustomDataIdentifierRequest	withDescription(String description) A custom description of the custom data identifier.
CreateCustomDataIdentifierRequest	withIgnoreWords(Collection<String> ignoreWords) An array that lists specific character sequences (ignore words) to exclude from the results.
CreateCustomDataIdentifierRequest	withIgnoreWords(String... ignoreWords) An array that lists specific character sequences (ignore words) to exclude from the results.
CreateCustomDataIdentifierRequest	withKeywords(Collection<String> keywords) An array that lists specific character sequences (keywords), one of which must be within proximity (maximumMatchDistance) of the regular expression to match.
CreateCustomDataIdentifierRequest	withKeywords(String... keywords) An array that lists specific character sequences (keywords), one of which must be within proximity (maximumMatchDistance) of the regular expression to match.
CreateCustomDataIdentifierRequest	withMaximumMatchDistance(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.
CreateCustomDataIdentifierRequest	withName(String name) A custom name for the custom data identifier.
CreateCustomDataIdentifierRequest	withRegex(String regex) The regular expression (regex) that defines the pattern to match.
CreateCustomDataIdentifierRequest	withTags(Map<String,String> tags) A map of key-value pairs that specifies the tags to associate with 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

CreateCustomDataIdentifierRequest

public CreateCustomDataIdentifierRequest()

Method Detail

setClientToken

public void setClientToken(String clientToken)

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

Parameters:

clientToken - A unique, case-sensitive token that you provide to ensure the idempotency of the request.

getClientToken

public String getClientToken()

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.

withClientToken

public CreateCustomDataIdentifierRequest withClientToken(String clientToken)

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

Parameters:

clientToken - A unique, case-sensitive token that you provide to ensure the idempotency of the request.

Returns:

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

setDescription

public void setDescription(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.

Parameters:

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.

getDescription

public String getDescription()

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.

withDescription

public CreateCustomDataIdentifierRequest withDescription(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.

Parameters:

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:

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

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

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.

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

Parameters:

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.

withIgnoreWords

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

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

Returns:

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

withIgnoreWords

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

Parameters:

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.

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 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 characters. Keywords aren't case sensitive.

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 3 - 90 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 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 characters. Keywords aren't case sensitive.

Parameters:

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 characters. Keywords aren't case sensitive.

withKeywords

public CreateCustomDataIdentifierRequest withKeywords(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 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 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 characters. Keywords aren't case sensitive.

Returns:

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

withKeywords

public CreateCustomDataIdentifierRequest withKeywords(Collection<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 characters. Keywords aren't case sensitive.

Parameters:

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

Parameters:

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.

getMaximumMatchDistance

public Integer getMaximumMatchDistance()

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.

withMaximumMatchDistance

public CreateCustomDataIdentifierRequest withMaximumMatchDistance(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.

Parameters:

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:

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

setName

public void setName(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.

Parameters:

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.

getName

public String getName()

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.

withName

public CreateCustomDataIdentifierRequest withName(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.

Parameters:

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:

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

getTags

public Map<String,String> getTags()

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.

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.

setTags

public void setTags(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.

Parameters:

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.

withTags

public CreateCustomDataIdentifierRequest withTags(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.

Parameters:

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.

Returns:

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

addTagsEntry

public CreateCustomDataIdentifierRequest addTagsEntry(String key,
                                                      String value)

Add a single Tags entry

See Also:

withTags(java.util.Map<java.lang.String, java.lang.String>)

clearTagsEntries

public CreateCustomDataIdentifierRequest clearTagsEntries()

Removes all the entries added into Tags.

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 CreateCustomDataIdentifierRequest 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()