ListFindingsRequest (AWS Java SDK :: Services :: Amazon GuardDuty 2.21.2 API)

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

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ListFindingsRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static ListFindingsRequest.Builder`	`builder()`
`String`	`detectorId()` The ID of the detector that specifies the GuardDuty service whose findings you want to list.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`FindingCriteria`	`findingCriteria()` Represents the criteria used for querying findings.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Integer`	`maxResults()` You can use this parameter to indicate the maximum number of items you want in the response.
`String`	`nextToken()` You can use this parameter when paginating results.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ListFindingsRequest.Builder>`	`serializableBuilderClass()`
`SortCriteria`	`sortCriteria()` Represents the criteria used for sorting findings.
`ListFindingsRequest.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 final String detectorId()
```
    The ID of the detector that specifies the GuardDuty service whose findings you want to list.
    
    Returns:
    
    The ID of the detector that specifies the GuardDuty service whose findings you want to list.
  - findingCriteria
```
public final FindingCriteria findingCriteria()
```
    Represents the criteria used for querying findings. Valid values include:
    - JSON field name
    - 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.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.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.dnsRequestAction.domainWithSuffix
    - service.action.networkConnectionAction.blocked
    - service.action.networkConnectionAction.connectionDirection
    - service.action.networkConnectionAction.localPortDetails.port
    - service.action.networkConnectionAction.protocol
    - 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: Timestamp in Unix Epoch millisecond format: 1486685375000
    Returns:
    Represents the criteria used for querying findings. Valid values include:
    
    JSON field name
    
    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.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.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.dnsRequestAction.domainWithSuffix
    
    service.action.networkConnectionAction.blocked
    
    service.action.networkConnectionAction.connectionDirection
    
    service.action.networkConnectionAction.localPortDetails.port
    
    service.action.networkConnectionAction.protocol
    
    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: Timestamp in Unix Epoch millisecond format: 1486685375000
  - sortCriteria
```
public final SortCriteria sortCriteria()
```
    Represents the criteria used for sorting findings.
    
    Returns:
    
    Represents the criteria used for sorting findings.
  - maxResults
```
public final Integer maxResults()
```
    You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50.
    
    Returns:
    
    You can use this parameter to indicate the maximum number of items you want in the response. The default value is 50. The maximum value is 50.
  - nextToken
```
public final String nextToken()
```
    You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
    
    Returns:
    
    You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.
  - toBuilder
```
public ListFindingsRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ListFindingsRequest.Builder,ListFindingsRequest>
    
    Specified by:
    
    toBuilder in class GuardDutyRequest
  - builder
```
public static ListFindingsRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ListFindingsRequest.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

Class ListFindingsRequest

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

findingCriteria

sortCriteria

maxResults

nextToken

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields