software.amazon.awssdk.services.macie2.model

Class CreateAllowListRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateAllowListRequest.Builder,CreateAllowListRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateAllowListRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateAllowListRequest.Builder	builder()
String	clientToken() A unique, case-sensitive token that you provide to ensure the idempotency of the request.
AllowListCriteria	criteria() The criteria that specify the text or text pattern to ignore.
String	description() A custom description of the allow list.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	name() A custom name for the allow list.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateAllowListRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags() A map of key-value pairs that specifies the tags to associate with the allow list.
CreateAllowListRequest.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 final 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.

criteria

public final AllowListCriteria criteria()

The criteria that specify the text or text pattern to ignore. The criteria can be the location and name of an S3 object that lists specific text to ignore (s3WordsList), or a regular expression (regex) that defines a text pattern to ignore.

Returns:

The criteria that specify the text or text pattern to ignore. The criteria can be the location and name of an S3 object that lists specific text to ignore (s3WordsList), or a regular expression (regex) that defines a text pattern to ignore.

description

public final String description()

A custom description of the allow list. The description can contain as many as 512 characters.

Returns:

A custom description of the allow list. The description can contain as many as 512 characters.

name

public final String name()

A custom name for the allow list. The name can contain as many as 128 characters.

Returns:

A custom name for the allow list. The name can contain as many as 128 characters.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags 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.

tags

public final Map<String,String> tags()

A map of key-value pairs that specifies the tags to associate with the allow list.

An allow list 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.

Returns:

A map of key-value pairs that specifies the tags to associate with the allow list.

An allow list 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 CreateAllowListRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateAllowListRequest.Builder,CreateAllowListRequest>

Specified by:

toBuilder in class Macie2Request

builder

public static CreateAllowListRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateAllowListRequest.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