Package software.amazon.awssdk.services.guardduty.model

Interface ListFindingsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<ListFindingsRequest.Builder,ListFindingsRequest>, GuardDutyRequest.Builder, SdkBuilder<ListFindingsRequest.Builder,ListFindingsRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ListFindingsRequest
public static interface ListFindingsRequest.Builder extends GuardDutyRequest.Builder, SdkPojo, CopyableBuilder<ListFindingsRequest.Builder,ListFindingsRequest>

  • Method Details

    • detectorId

      ListFindingsRequest.Builder detectorId(String detectorId)

      The ID of the detector that specifies the GuardDuty service whose findings you want to list.

      Parameters:
      detectorId - The ID of the detector that specifies the GuardDuty service whose findings you want to list.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • findingCriteria

      ListFindingsRequest.Builder findingCriteria(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

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • findingCriteria

      default ListFindingsRequest.Builder findingCriteria(Consumer<FindingCriteria.Builder> 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

      This is a convenience method that creates an instance of the FindingCriteria.Builder avoiding the need to create one manually via FindingCriteria.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to findingCriteria(FindingCriteria).

      Parameters:
      findingCriteria - a consumer that will call methods on FindingCriteria.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sortCriteria

      ListFindingsRequest.Builder sortCriteria(SortCriteria sortCriteria)

      Represents the criteria used for sorting findings.

      Parameters:
      sortCriteria - Represents the criteria used for sorting findings.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sortCriteria

      default ListFindingsRequest.Builder sortCriteria(Consumer<SortCriteria.Builder> sortCriteria)

      Represents the criteria used for sorting findings.

      This is a convenience method that creates an instance of the SortCriteria.Builder avoiding the need to create one manually via SortCriteria.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to sortCriteria(SortCriteria).

      Parameters:
      sortCriteria - a consumer that will call methods on SortCriteria.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxResults

      ListFindingsRequest.Builder maxResults(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      ListFindingsRequest.Builder nextToken(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      ListFindingsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      ListFindingsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.