software.amazon.awssdk.services.guardduty.model

Class CreateFilterRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.guardduty.model.GuardDutyRequest

software.amazon.awssdk.services.guardduty.model.CreateFilterRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateFilterRequest.Builder,CreateFilterRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateFilterRequest.Builder

Method Summary

Modifier and Type	Method and Description
FilterAction	action() Specifies the action that is to be applied to the findings that match the filter.
String	actionAsString() Specifies the action that is to be applied to the findings that match the filter.
static CreateFilterRequest.Builder	builder()
String	clientToken() The idempotency token for the create request.
String	description() The description of the filter.
String	detectorId() The unique ID of the detector of the GuardDuty account for which you want to create a filter.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FindingCriteria	findingCriteria() Represents the criteria to be used in the filter for querying findings.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	name() The name of the filter.
Integer	rank() Specifies the position of the filter in the list of current filters.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateFilterRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags() The tags to be added to a new filter resource.
CreateFilterRequest.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

detectorId

public String detectorId()

The unique ID of the detector of the GuardDuty account for which you want to create a filter.

Returns:

The unique ID of the detector of the GuardDuty account for which you want to create a filter.

name

public String name()

The name of the filter.

Returns:

The name of the filter.

description

public String description()

The description of the filter.

Returns:

The description of the filter.

action

public FilterAction action()

Specifies the action that is to be applied to the findings that match the filter.

If the service returns an enum value that is not available in the current SDK version, action will return FilterAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().

Returns:

Specifies the action that is to be applied to the findings that match the filter.

See Also:

FilterAction

actionAsString

public String actionAsString()

Specifies the action that is to be applied to the findings that match the filter.

If the service returns an enum value that is not available in the current SDK version, action will return FilterAction.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from actionAsString().

Returns:

Specifies the action that is to be applied to the findings that match the filter.

See Also:

FilterAction

rank

public Integer rank()

Specifies the position of the filter in the list of current filters. Also specifies the order in which this filter is applied to the findings.

Returns:

Specifies the position of the filter in the list of current filters. Also specifies the order in which this filter is applied to the findings.

findingCriteria

public FindingCriteria findingCriteria()

Represents the criteria to be used in the filter for querying findings.

Returns:

Represents the criteria to be used in the filter for querying findings.

clientToken

public String clientToken()

The idempotency token for the create request.

Returns:

The idempotency token for the create request.

tags

public Map<String,String> tags()

The tags to be added to a new filter resource.

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

Returns:

The tags to be added to a new filter resource.

toBuilder

public CreateFilterRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateFilterRequest.Builder,CreateFilterRequest>

Specified by:

toBuilder in class GuardDutyRequest

builder

public static CreateFilterRequest.Builder builder()

serializableBuilderClass

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