CreateFilterRequest (AWS SDK for Java

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

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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 ID of the detector belonging to the GuardDuty account that you want to create a filter for.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)` Indicates whether some other object is "equal to" this one by SDK fields.
`FindingCriteria`	`findingCriteria()` Represents the criteria to be used in the filter for querying findings.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`int`	`hashCode()`
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`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()` Take this object and create a builder that contains all of the current property values of this object.
`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
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - detectorId
```
public final String detectorId()
```
    The ID of the detector belonging to the GuardDuty account that you want to create a filter for.
    
    Returns:
    
    The ID of the detector belonging to the GuardDuty account that you want to create a filter for.
  - name
```
public final String name()
```
    The name of the filter. Minimum length of 3. Maximum length of 64. Valid characters include alphanumeric characters, dot (.), underscore (_), and dash (-). Spaces are not allowed.
    
    Returns:
    
    The name of the filter. Minimum length of 3. Maximum length of 64. Valid characters include alphanumeric characters, dot (.), underscore (_), and dash (-). Spaces are not allowed.
  - description
```
public final String description()
```
    The description of the filter.
    
    Returns:
    
    The description of the filter.
  - action
```
public final 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 final 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 final 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 final FindingCriteria findingCriteria()
```
    Represents the criteria to be used in the filter for querying findings.
    
    You can only use the following attributes to query findings:
    - accountId
    - region
    - confidence
    - id
    - resource.accessKeyDetails.accessKeyId
    - resource.accessKeyDetails.principalId
    - resource.accessKeyDetails.userName
    - resource.accessKeyDetails.userType
    - resource.instanceDetails.iamInstanceProfile.id
    - resource.instanceDetails.imageId
    - resource.instanceDetails.instanceId
    - resource.instanceDetails.outpostArn
    - resource.instanceDetails.networkInterfaces.ipv6Addresses
    - resource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress
    - resource.instanceDetails.networkInterfaces.publicDnsName
    - resource.instanceDetails.networkInterfaces.publicIp
    - resource.instanceDetails.networkInterfaces.securityGroups.groupId
    - resource.instanceDetails.networkInterfaces.securityGroups.groupName
    - resource.instanceDetails.networkInterfaces.subnetId
    - resource.instanceDetails.networkInterfaces.vpcId
    - resource.instanceDetails.tags.key
    - resource.instanceDetails.tags.value
    - resource.resourceType
    - service.action.actionType
    - service.action.awsApiCallAction.api
    - service.action.awsApiCallAction.callerType
    - service.action.awsApiCallAction.errorCode
    - service.action.awsApiCallAction.remoteIpDetails.city.cityName
    - service.action.awsApiCallAction.remoteIpDetails.country.countryName
    - service.action.awsApiCallAction.remoteIpDetails.ipAddressV4
    - service.action.awsApiCallAction.remoteIpDetails.organization.asn
    - service.action.awsApiCallAction.remoteIpDetails.organization.asnOrg
    - service.action.awsApiCallAction.serviceName
    - service.action.dnsRequestAction.domain
    - service.action.networkConnectionAction.blocked
    - service.action.networkConnectionAction.connectionDirection
    - service.action.networkConnectionAction.localPortDetails.port
    - service.action.networkConnectionAction.protocol
    - service.action.networkConnectionAction.localIpDetails.ipAddressV4
    - service.action.networkConnectionAction.remoteIpDetails.city.cityName
    - service.action.networkConnectionAction.remoteIpDetails.country.countryName
    - service.action.networkConnectionAction.remoteIpDetails.ipAddressV4
    - service.action.networkConnectionAction.remoteIpDetails.organization.asn
    - service.action.networkConnectionAction.remoteIpDetails.organization.asnOrg
    - service.action.networkConnectionAction.remotePortDetails.port
    - service.additionalInfo.threatListName
    - service.archived
      
      When this attribute is set to TRUE, only archived findings are listed. When it's set to FALSE, only unarchived findings are listed. When this attribute is not set, all existing findings are listed.
    - service.resourceRole
    - severity
    - type
    - updatedAt
      
      Type: ISO 8601 string format: YYYY-MM-DDTHH:MM:SS.SSSZ or YYYY-MM-DDTHH:MM:SSZ depending on whether the value contains milliseconds.
    Returns:
    Represents the criteria to be used in the filter for querying findings.
    
    You can only use the following attributes to query findings:
    
    accountId
    
    region
    
    confidence
    
    id
    
    resource.accessKeyDetails.accessKeyId
    
    resource.accessKeyDetails.principalId
    
    resource.accessKeyDetails.userName
    
    resource.accessKeyDetails.userType
    
    resource.instanceDetails.iamInstanceProfile.id
    
    resource.instanceDetails.imageId
    
    resource.instanceDetails.instanceId
    
    resource.instanceDetails.outpostArn
    
    resource.instanceDetails.networkInterfaces.ipv6Addresses
    
    resource.instanceDetails.networkInterfaces.privateIpAddresses.privateIpAddress
    
    resource.instanceDetails.networkInterfaces.publicDnsName
    
    resource.instanceDetails.networkInterfaces.publicIp
    
    resource.instanceDetails.networkInterfaces.securityGroups.groupId
    
    resource.instanceDetails.networkInterfaces.securityGroups.groupName
    
    resource.instanceDetails.networkInterfaces.subnetId
    
    resource.instanceDetails.networkInterfaces.vpcId
    
    resource.instanceDetails.tags.key
    
    resource.instanceDetails.tags.value
    
    resource.resourceType
    
    service.action.actionType
    
    service.action.awsApiCallAction.api
    
    service.action.awsApiCallAction.callerType
    
    service.action.awsApiCallAction.errorCode
    
    service.action.awsApiCallAction.remoteIpDetails.city.cityName
    
    service.action.awsApiCallAction.remoteIpDetails.country.countryName
    
    service.action.awsApiCallAction.remoteIpDetails.ipAddressV4
    
    service.action.awsApiCallAction.remoteIpDetails.organization.asn
    
    service.action.awsApiCallAction.remoteIpDetails.organization.asnOrg
    
    service.action.awsApiCallAction.serviceName
    
    service.action.dnsRequestAction.domain
    
    service.action.networkConnectionAction.blocked
    
    service.action.networkConnectionAction.connectionDirection
    
    service.action.networkConnectionAction.localPortDetails.port
    
    service.action.networkConnectionAction.protocol
    
    service.action.networkConnectionAction.localIpDetails.ipAddressV4
    
    service.action.networkConnectionAction.remoteIpDetails.city.cityName
    
    service.action.networkConnectionAction.remoteIpDetails.country.countryName
    
    service.action.networkConnectionAction.remoteIpDetails.ipAddressV4
    
    service.action.networkConnectionAction.remoteIpDetails.organization.asn
    
    service.action.networkConnectionAction.remoteIpDetails.organization.asnOrg
    
    service.action.networkConnectionAction.remotePortDetails.port
    
    service.additionalInfo.threatListName
    
    service.archived
    
    When this attribute is set to TRUE, only archived findings are listed. When it's set to FALSE, only unarchived findings are listed. When this attribute is not set, all existing findings are listed.
    
    service.resourceRole
    
    severity
    
    type
    
    updatedAt
    
    Type: ISO 8601 string format: YYYY-MM-DDTHH:MM:SS.SSSZ or YYYY-MM-DDTHH:MM:SSZ depending on whether the value contains milliseconds.
  - clientToken
```
public final String clientToken()
```
    The idempotency token for the create request.
    
    Returns:
    
    The idempotency token for the create request.
  - 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()
```
    The tags to be added to a new filter resource.
    
    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:
    
    The tags to be added to a new filter resource.
  - toBuilder
```
public CreateFilterRequest.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateFilterRequest.Builder,CreateFilterRequest>
    
    Specified by:
    
    toBuilder in class GuardDutyRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static CreateFilterRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateFilterRequest.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)
```
    Description copied from interface: SdkPojo
    
    Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.
    If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.
    
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
    
    Parameters:
    
    obj - the object to be compared with
    
    Returns:
    
    true if the other object equals to this object by sdk fields, false otherwise.
  - 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)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

AWS SDK for Java API Reference - 2.17.41

Class CreateFilterRequest

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

detectorId

name

description

action

actionAsString

rank

findingCriteria

clientToken

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields