Class AwsSecurityFindingFilters

    • Method Detail

      • hasProductArn

        public final boolean hasProductArn()
        For responses, this returns true if the service returned a value for the ProductArn 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.
      • productArn

        public final List<StringFilter> productArn()

        The ARN generated by Security Hub that uniquely identifies a third-party company (security findings provider) after this provider's product (solution that generates findings) is registered with Security Hub.

        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 hasProductArn() method.

        Returns:
        The ARN generated by Security Hub that uniquely identifies a third-party company (security findings provider) after this provider's product (solution that generates findings) is registered with Security Hub.
      • hasAwsAccountId

        public final boolean hasAwsAccountId()
        For responses, this returns true if the service returned a value for the AwsAccountId 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.
      • awsAccountId

        public final List<StringFilter> awsAccountId()

        The Amazon Web Services account ID in which a finding is generated.

        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 hasAwsAccountId() method.

        Returns:
        The Amazon Web Services account ID in which a finding is generated.
      • hasId

        public final boolean hasId()
        For responses, this returns true if the service returned a value for the Id 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.
      • id

        public final List<StringFilter> id()

        The security findings provider-specific identifier for a finding.

        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 hasId() method.

        Returns:
        The security findings provider-specific identifier for a finding.
      • hasGeneratorId

        public final boolean hasGeneratorId()
        For responses, this returns true if the service returned a value for the GeneratorId 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.
      • generatorId

        public final List<StringFilter> generatorId()

        The identifier for the solution-specific component (a discrete unit of logic) that generated a finding. In various security findings providers' solutions, this generator can be called a rule, a check, a detector, a plugin, etc.

        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 hasGeneratorId() method.

        Returns:
        The identifier for the solution-specific component (a discrete unit of logic) that generated a finding. In various security findings providers' solutions, this generator can be called a rule, a check, a detector, a plugin, etc.
      • hasRegion

        public final boolean hasRegion()
        For responses, this returns true if the service returned a value for the Region 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.
      • region

        public final List<StringFilter> region()

        The Region from which the finding was generated.

        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 hasRegion() method.

        Returns:
        The Region from which the finding was generated.
      • hasType

        public final boolean hasType()
        For responses, this returns true if the service returned a value for the Type 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.
      • type

        public final List<StringFilter> type()

        A finding type in the format of namespace/category/classifier that classifies a finding.

        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 hasType() method.

        Returns:
        A finding type in the format of namespace/category/classifier that classifies a finding.
      • hasFirstObservedAt

        public final boolean hasFirstObservedAt()
        For responses, this returns true if the service returned a value for the FirstObservedAt 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.
      • firstObservedAt

        public final List<DateFilter> firstObservedAt()

        A timestamp that indicates when the security findings provider first observed the potential security issue that a finding captured.

        For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

        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 hasFirstObservedAt() method.

        Returns:
        A timestamp that indicates when the security findings provider first observed the potential security issue that a finding captured.

        For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

      • hasLastObservedAt

        public final boolean hasLastObservedAt()
        For responses, this returns true if the service returned a value for the LastObservedAt 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.
      • lastObservedAt

        public final List<DateFilter> lastObservedAt()

        A timestamp that indicates when the security findings provider most recently observed a change in the resource that is involved in the finding.

        For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

        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 hasLastObservedAt() method.

        Returns:
        A timestamp that indicates when the security findings provider most recently observed a change in the resource that is involved in the finding.

        For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

      • hasCreatedAt

        public final boolean hasCreatedAt()
        For responses, this returns true if the service returned a value for the CreatedAt 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.
      • createdAt

        public final List<DateFilter> createdAt()

        A timestamp that indicates when the security findings provider created the potential security issue that a finding reflects.

        For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

        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 hasCreatedAt() method.

        Returns:
        A timestamp that indicates when the security findings provider created the potential security issue that a finding reflects.

        For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

      • hasUpdatedAt

        public final boolean hasUpdatedAt()
        For responses, this returns true if the service returned a value for the UpdatedAt 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.
      • updatedAt

        public final List<DateFilter> updatedAt()

        A timestamp that indicates when the security findings provider last updated the finding record.

        For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

        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 hasUpdatedAt() method.

        Returns:
        A timestamp that indicates when the security findings provider last updated the finding record.

        For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

      • hasSeverityProduct

        @Deprecated
        public final boolean hasSeverityProduct()
        Deprecated.
        This filter is deprecated. Instead, use FindingProviderSeverityOriginal.
        For responses, this returns true if the service returned a value for the SeverityProduct 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.
      • severityProduct

        @Deprecated
        public final List<NumberFilter> severityProduct()
        Deprecated.
        This filter is deprecated. Instead, use FindingProviderSeverityOriginal.

        The native severity as defined by the security findings provider's solution that generated the finding.

        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 hasSeverityProduct() method.

        Returns:
        The native severity as defined by the security findings provider's solution that generated the finding.
      • hasSeverityNormalized

        @Deprecated
        public final boolean hasSeverityNormalized()
        Deprecated.
        This filter is deprecated. Instead, use SeverityLabel or FindingProviderFieldsSeverityLabel.
        For responses, this returns true if the service returned a value for the SeverityNormalized 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.
      • severityNormalized

        @Deprecated
        public final List<NumberFilter> severityNormalized()
        Deprecated.
        This filter is deprecated. Instead, use SeverityLabel or FindingProviderFieldsSeverityLabel.

        The normalized severity of a finding.

        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 hasSeverityNormalized() method.

        Returns:
        The normalized severity of a finding.
      • hasSeverityLabel

        public final boolean hasSeverityLabel()
        For responses, this returns true if the service returned a value for the SeverityLabel 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.
      • severityLabel

        public final List<StringFilter> severityLabel()

        The label of a finding's severity.

        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 hasSeverityLabel() method.

        Returns:
        The label of a finding's severity.
      • hasConfidence

        public final boolean hasConfidence()
        For responses, this returns true if the service returned a value for the Confidence 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.
      • confidence

        public final List<NumberFilter> confidence()

        A finding's confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify.

        Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.

        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 hasConfidence() method.

        Returns:
        A finding's confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify.

        Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.

      • hasCriticality

        public final boolean hasCriticality()
        For responses, this returns true if the service returned a value for the Criticality 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.
      • criticality

        public final List<NumberFilter> criticality()

        The level of importance assigned to the resources associated with the finding.

        A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.

        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 hasCriticality() method.

        Returns:
        The level of importance assigned to the resources associated with the finding.

        A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.

      • hasTitle

        public final boolean hasTitle()
        For responses, this returns true if the service returned a value for the Title 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.
      • title

        public final List<StringFilter> title()

        A finding's title.

        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 hasTitle() method.

        Returns:
        A finding's title.
      • hasDescription

        public final boolean hasDescription()
        For responses, this returns true if the service returned a value for the Description 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.
      • description

        public final List<StringFilter> description()

        A finding's description.

        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 hasDescription() method.

        Returns:
        A finding's description.
      • hasRecommendationText

        public final boolean hasRecommendationText()
        For responses, this returns true if the service returned a value for the RecommendationText 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.
      • recommendationText

        public final List<StringFilter> recommendationText()

        The recommendation of what to do about the issue described in a finding.

        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 hasRecommendationText() method.

        Returns:
        The recommendation of what to do about the issue described in a finding.
      • hasSourceUrl

        public final boolean hasSourceUrl()
        For responses, this returns true if the service returned a value for the SourceUrl 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.
      • sourceUrl

        public final List<StringFilter> sourceUrl()

        A URL that links to a page about the current finding in the security findings provider's solution.

        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 hasSourceUrl() method.

        Returns:
        A URL that links to a page about the current finding in the security findings provider's solution.
      • hasProductFields

        public final boolean hasProductFields()
        For responses, this returns true if the service returned a value for the ProductFields 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.
      • productFields

        public final List<MapFilter> productFields()

        A data type where security findings providers can include additional solution-specific details that aren't part of the defined AwsSecurityFinding format.

        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 hasProductFields() method.

        Returns:
        A data type where security findings providers can include additional solution-specific details that aren't part of the defined AwsSecurityFinding format.
      • hasProductName

        public final boolean hasProductName()
        For responses, this returns true if the service returned a value for the ProductName 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.
      • productName

        public final List<StringFilter> productName()

        The name of the solution (product) that generates findings.

        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 hasProductName() method.

        Returns:
        The name of the solution (product) that generates findings.
      • hasCompanyName

        public final boolean hasCompanyName()
        For responses, this returns true if the service returned a value for the CompanyName 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.
      • companyName

        public final List<StringFilter> companyName()

        The name of the findings provider (company) that owns the solution (product) that generates findings.

        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 hasCompanyName() method.

        Returns:
        The name of the findings provider (company) that owns the solution (product) that generates findings.
      • hasUserDefinedFields

        public final boolean hasUserDefinedFields()
        For responses, this returns true if the service returned a value for the UserDefinedFields 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.
      • userDefinedFields

        public final List<MapFilter> userDefinedFields()

        A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.

        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 hasUserDefinedFields() method.

        Returns:
        A list of name/value string pairs associated with the finding. These are custom, user-defined fields added to a finding.
      • hasMalwareName

        public final boolean hasMalwareName()
        For responses, this returns true if the service returned a value for the MalwareName 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.
      • malwareName

        public final List<StringFilter> malwareName()

        The name of the malware that was observed.

        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 hasMalwareName() method.

        Returns:
        The name of the malware that was observed.
      • hasMalwareType

        public final boolean hasMalwareType()
        For responses, this returns true if the service returned a value for the MalwareType 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.
      • malwareType

        public final List<StringFilter> malwareType()

        The type of the malware that was observed.

        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 hasMalwareType() method.

        Returns:
        The type of the malware that was observed.
      • hasMalwarePath

        public final boolean hasMalwarePath()
        For responses, this returns true if the service returned a value for the MalwarePath 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.
      • malwarePath

        public final List<StringFilter> malwarePath()

        The filesystem path of the malware that was observed.

        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 hasMalwarePath() method.

        Returns:
        The filesystem path of the malware that was observed.
      • hasMalwareState

        public final boolean hasMalwareState()
        For responses, this returns true if the service returned a value for the MalwareState 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.
      • malwareState

        public final List<StringFilter> malwareState()

        The state of the malware that was observed.

        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 hasMalwareState() method.

        Returns:
        The state of the malware that was observed.
      • hasNetworkDirection

        public final boolean hasNetworkDirection()
        For responses, this returns true if the service returned a value for the NetworkDirection 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.
      • networkDirection

        public final List<StringFilter> networkDirection()

        Indicates the direction of network traffic associated with a finding.

        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 hasNetworkDirection() method.

        Returns:
        Indicates the direction of network traffic associated with a finding.
      • hasNetworkProtocol

        public final boolean hasNetworkProtocol()
        For responses, this returns true if the service returned a value for the NetworkProtocol 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.
      • networkProtocol

        public final List<StringFilter> networkProtocol()

        The protocol of network-related information about a finding.

        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 hasNetworkProtocol() method.

        Returns:
        The protocol of network-related information about a finding.
      • hasNetworkSourceIpV4

        public final boolean hasNetworkSourceIpV4()
        For responses, this returns true if the service returned a value for the NetworkSourceIpV4 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.
      • networkSourceIpV4

        public final List<IpFilter> networkSourceIpV4()

        The source IPv4 address of network-related information about a finding.

        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 hasNetworkSourceIpV4() method.

        Returns:
        The source IPv4 address of network-related information about a finding.
      • hasNetworkSourceIpV6

        public final boolean hasNetworkSourceIpV6()
        For responses, this returns true if the service returned a value for the NetworkSourceIpV6 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.
      • networkSourceIpV6

        public final List<IpFilter> networkSourceIpV6()

        The source IPv6 address of network-related information about a finding.

        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 hasNetworkSourceIpV6() method.

        Returns:
        The source IPv6 address of network-related information about a finding.
      • hasNetworkSourcePort

        public final boolean hasNetworkSourcePort()
        For responses, this returns true if the service returned a value for the NetworkSourcePort 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.
      • networkSourcePort

        public final List<NumberFilter> networkSourcePort()

        The source port of network-related information about a finding.

        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 hasNetworkSourcePort() method.

        Returns:
        The source port of network-related information about a finding.
      • hasNetworkSourceDomain

        public final boolean hasNetworkSourceDomain()
        For responses, this returns true if the service returned a value for the NetworkSourceDomain 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.
      • networkSourceDomain

        public final List<StringFilter> networkSourceDomain()

        The source domain of network-related information about a finding.

        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 hasNetworkSourceDomain() method.

        Returns:
        The source domain of network-related information about a finding.
      • hasNetworkSourceMac

        public final boolean hasNetworkSourceMac()
        For responses, this returns true if the service returned a value for the NetworkSourceMac 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.
      • networkSourceMac

        public final List<StringFilter> networkSourceMac()

        The source media access control (MAC) address of network-related information about a finding.

        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 hasNetworkSourceMac() method.

        Returns:
        The source media access control (MAC) address of network-related information about a finding.
      • hasNetworkDestinationIpV4

        public final boolean hasNetworkDestinationIpV4()
        For responses, this returns true if the service returned a value for the NetworkDestinationIpV4 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.
      • networkDestinationIpV4

        public final List<IpFilter> networkDestinationIpV4()

        The destination IPv4 address of network-related information about a finding.

        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 hasNetworkDestinationIpV4() method.

        Returns:
        The destination IPv4 address of network-related information about a finding.
      • hasNetworkDestinationIpV6

        public final boolean hasNetworkDestinationIpV6()
        For responses, this returns true if the service returned a value for the NetworkDestinationIpV6 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.
      • networkDestinationIpV6

        public final List<IpFilter> networkDestinationIpV6()

        The destination IPv6 address of network-related information about a finding.

        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 hasNetworkDestinationIpV6() method.

        Returns:
        The destination IPv6 address of network-related information about a finding.
      • hasNetworkDestinationPort

        public final boolean hasNetworkDestinationPort()
        For responses, this returns true if the service returned a value for the NetworkDestinationPort 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.
      • networkDestinationPort

        public final List<NumberFilter> networkDestinationPort()

        The destination port of network-related information about a finding.

        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 hasNetworkDestinationPort() method.

        Returns:
        The destination port of network-related information about a finding.
      • hasNetworkDestinationDomain

        public final boolean hasNetworkDestinationDomain()
        For responses, this returns true if the service returned a value for the NetworkDestinationDomain 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.
      • networkDestinationDomain

        public final List<StringFilter> networkDestinationDomain()

        The destination domain of network-related information about a finding.

        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 hasNetworkDestinationDomain() method.

        Returns:
        The destination domain of network-related information about a finding.
      • hasProcessName

        public final boolean hasProcessName()
        For responses, this returns true if the service returned a value for the ProcessName 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.
      • processName

        public final List<StringFilter> processName()

        The name of the process.

        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 hasProcessName() method.

        Returns:
        The name of the process.
      • hasProcessPath

        public final boolean hasProcessPath()
        For responses, this returns true if the service returned a value for the ProcessPath 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.
      • processPath

        public final List<StringFilter> processPath()

        The path to the process executable.

        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 hasProcessPath() method.

        Returns:
        The path to the process executable.
      • hasProcessPid

        public final boolean hasProcessPid()
        For responses, this returns true if the service returned a value for the ProcessPid 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.
      • processPid

        public final List<NumberFilter> processPid()

        The process ID.

        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 hasProcessPid() method.

        Returns:
        The process ID.
      • hasProcessParentPid

        public final boolean hasProcessParentPid()
        For responses, this returns true if the service returned a value for the ProcessParentPid 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.
      • processParentPid

        public final List<NumberFilter> processParentPid()

        The parent process ID. This field accepts positive integers between O and 2147483647.

        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 hasProcessParentPid() method.

        Returns:
        The parent process ID. This field accepts positive integers between O and 2147483647.
      • hasProcessLaunchedAt

        public final boolean hasProcessLaunchedAt()
        For responses, this returns true if the service returned a value for the ProcessLaunchedAt 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.
      • processLaunchedAt

        public final List<DateFilter> processLaunchedAt()

        A timestamp that identifies when the process was launched.

        For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

        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 hasProcessLaunchedAt() method.

        Returns:
        A timestamp that identifies when the process was launched.

        For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

      • hasProcessTerminatedAt

        public final boolean hasProcessTerminatedAt()
        For responses, this returns true if the service returned a value for the ProcessTerminatedAt 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.
      • processTerminatedAt

        public final List<DateFilter> processTerminatedAt()

        A timestamp that identifies when the process was terminated.

        For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

        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 hasProcessTerminatedAt() method.

        Returns:
        A timestamp that identifies when the process was terminated.

        For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

      • hasThreatIntelIndicatorType

        public final boolean hasThreatIntelIndicatorType()
        For responses, this returns true if the service returned a value for the ThreatIntelIndicatorType 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.
      • threatIntelIndicatorType

        public final List<StringFilter> threatIntelIndicatorType()

        The type of a threat intelligence indicator.

        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 hasThreatIntelIndicatorType() method.

        Returns:
        The type of a threat intelligence indicator.
      • hasThreatIntelIndicatorValue

        public final boolean hasThreatIntelIndicatorValue()
        For responses, this returns true if the service returned a value for the ThreatIntelIndicatorValue 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.
      • threatIntelIndicatorValue

        public final List<StringFilter> threatIntelIndicatorValue()

        The value of a threat intelligence indicator.

        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 hasThreatIntelIndicatorValue() method.

        Returns:
        The value of a threat intelligence indicator.
      • hasThreatIntelIndicatorCategory

        public final boolean hasThreatIntelIndicatorCategory()
        For responses, this returns true if the service returned a value for the ThreatIntelIndicatorCategory 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.
      • threatIntelIndicatorCategory

        public final List<StringFilter> threatIntelIndicatorCategory()

        The category of a threat intelligence indicator.

        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 hasThreatIntelIndicatorCategory() method.

        Returns:
        The category of a threat intelligence indicator.
      • hasThreatIntelIndicatorLastObservedAt

        public final boolean hasThreatIntelIndicatorLastObservedAt()
        For responses, this returns true if the service returned a value for the ThreatIntelIndicatorLastObservedAt 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.
      • threatIntelIndicatorLastObservedAt

        public final List<DateFilter> threatIntelIndicatorLastObservedAt()

        A timestamp that identifies the last observation of a threat intelligence indicator.

        For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

        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 hasThreatIntelIndicatorLastObservedAt() method.

        Returns:
        A timestamp that identifies the last observation of a threat intelligence indicator.

        For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

      • hasThreatIntelIndicatorSource

        public final boolean hasThreatIntelIndicatorSource()
        For responses, this returns true if the service returned a value for the ThreatIntelIndicatorSource 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.
      • threatIntelIndicatorSource

        public final List<StringFilter> threatIntelIndicatorSource()

        The source of the threat intelligence.

        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 hasThreatIntelIndicatorSource() method.

        Returns:
        The source of the threat intelligence.
      • hasThreatIntelIndicatorSourceUrl

        public final boolean hasThreatIntelIndicatorSourceUrl()
        For responses, this returns true if the service returned a value for the ThreatIntelIndicatorSourceUrl 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.
      • threatIntelIndicatorSourceUrl

        public final List<StringFilter> threatIntelIndicatorSourceUrl()

        The URL for more details from the source of the threat intelligence.

        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 hasThreatIntelIndicatorSourceUrl() method.

        Returns:
        The URL for more details from the source of the threat intelligence.
      • hasResourceType

        public final boolean hasResourceType()
        For responses, this returns true if the service returned a value for the ResourceType 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.
      • resourceType

        public final List<StringFilter> resourceType()

        Specifies the type of the resource that details are provided for.

        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 hasResourceType() method.

        Returns:
        Specifies the type of the resource that details are provided for.
      • hasResourceId

        public final boolean hasResourceId()
        For responses, this returns true if the service returned a value for the ResourceId 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.
      • resourceId

        public final List<StringFilter> resourceId()

        The canonical identifier for the given resource type.

        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 hasResourceId() method.

        Returns:
        The canonical identifier for the given resource type.
      • hasResourcePartition

        public final boolean hasResourcePartition()
        For responses, this returns true if the service returned a value for the ResourcePartition 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.
      • resourcePartition

        public final List<StringFilter> resourcePartition()

        The canonical Amazon Web Services partition name that the Region is assigned to.

        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 hasResourcePartition() method.

        Returns:
        The canonical Amazon Web Services partition name that the Region is assigned to.
      • hasResourceRegion

        public final boolean hasResourceRegion()
        For responses, this returns true if the service returned a value for the ResourceRegion 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.
      • resourceRegion

        public final List<StringFilter> resourceRegion()

        The canonical Amazon Web Services external Region name where this resource is located.

        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 hasResourceRegion() method.

        Returns:
        The canonical Amazon Web Services external Region name where this resource is located.
      • hasResourceTags

        public final boolean hasResourceTags()
        For responses, this returns true if the service returned a value for the ResourceTags 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.
      • resourceTags

        public final List<MapFilter> resourceTags()

        A list of Amazon Web Services tags associated with a resource at the time the finding was processed.

        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 hasResourceTags() method.

        Returns:
        A list of Amazon Web Services tags associated with a resource at the time the finding was processed.
      • hasResourceAwsEc2InstanceType

        public final boolean hasResourceAwsEc2InstanceType()
        For responses, this returns true if the service returned a value for the ResourceAwsEc2InstanceType 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.
      • resourceAwsEc2InstanceType

        public final List<StringFilter> resourceAwsEc2InstanceType()

        The instance type of the instance.

        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 hasResourceAwsEc2InstanceType() method.

        Returns:
        The instance type of the instance.
      • hasResourceAwsEc2InstanceImageId

        public final boolean hasResourceAwsEc2InstanceImageId()
        For responses, this returns true if the service returned a value for the ResourceAwsEc2InstanceImageId 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.
      • resourceAwsEc2InstanceImageId

        public final List<StringFilter> resourceAwsEc2InstanceImageId()

        The Amazon Machine Image (AMI) ID of the instance.

        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 hasResourceAwsEc2InstanceImageId() method.

        Returns:
        The Amazon Machine Image (AMI) ID of the instance.
      • hasResourceAwsEc2InstanceIpV4Addresses

        public final boolean hasResourceAwsEc2InstanceIpV4Addresses()
        For responses, this returns true if the service returned a value for the ResourceAwsEc2InstanceIpV4Addresses 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.
      • resourceAwsEc2InstanceIpV4Addresses

        public final List<IpFilter> resourceAwsEc2InstanceIpV4Addresses()

        The IPv4 addresses associated with the instance.

        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 hasResourceAwsEc2InstanceIpV4Addresses() method.

        Returns:
        The IPv4 addresses associated with the instance.
      • hasResourceAwsEc2InstanceIpV6Addresses

        public final boolean hasResourceAwsEc2InstanceIpV6Addresses()
        For responses, this returns true if the service returned a value for the ResourceAwsEc2InstanceIpV6Addresses 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.
      • resourceAwsEc2InstanceIpV6Addresses

        public final List<IpFilter> resourceAwsEc2InstanceIpV6Addresses()

        The IPv6 addresses associated with the instance.

        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 hasResourceAwsEc2InstanceIpV6Addresses() method.

        Returns:
        The IPv6 addresses associated with the instance.
      • hasResourceAwsEc2InstanceKeyName

        public final boolean hasResourceAwsEc2InstanceKeyName()
        For responses, this returns true if the service returned a value for the ResourceAwsEc2InstanceKeyName 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.
      • resourceAwsEc2InstanceKeyName

        public final List<StringFilter> resourceAwsEc2InstanceKeyName()

        The key name associated with the instance.

        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 hasResourceAwsEc2InstanceKeyName() method.

        Returns:
        The key name associated with the instance.
      • hasResourceAwsEc2InstanceIamInstanceProfileArn

        public final boolean hasResourceAwsEc2InstanceIamInstanceProfileArn()
        For responses, this returns true if the service returned a value for the ResourceAwsEc2InstanceIamInstanceProfileArn 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.
      • resourceAwsEc2InstanceIamInstanceProfileArn

        public final List<StringFilter> resourceAwsEc2InstanceIamInstanceProfileArn()

        The IAM profile ARN of the instance.

        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 hasResourceAwsEc2InstanceIamInstanceProfileArn() method.

        Returns:
        The IAM profile ARN of the instance.
      • hasResourceAwsEc2InstanceVpcId

        public final boolean hasResourceAwsEc2InstanceVpcId()
        For responses, this returns true if the service returned a value for the ResourceAwsEc2InstanceVpcId 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.
      • resourceAwsEc2InstanceVpcId

        public final List<StringFilter> resourceAwsEc2InstanceVpcId()

        The identifier of the VPC that the instance was launched in.

        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 hasResourceAwsEc2InstanceVpcId() method.

        Returns:
        The identifier of the VPC that the instance was launched in.
      • hasResourceAwsEc2InstanceSubnetId

        public final boolean hasResourceAwsEc2InstanceSubnetId()
        For responses, this returns true if the service returned a value for the ResourceAwsEc2InstanceSubnetId 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.
      • resourceAwsEc2InstanceSubnetId

        public final List<StringFilter> resourceAwsEc2InstanceSubnetId()

        The identifier of the subnet that the instance was launched in.

        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 hasResourceAwsEc2InstanceSubnetId() method.

        Returns:
        The identifier of the subnet that the instance was launched in.
      • hasResourceAwsEc2InstanceLaunchedAt

        public final boolean hasResourceAwsEc2InstanceLaunchedAt()
        For responses, this returns true if the service returned a value for the ResourceAwsEc2InstanceLaunchedAt 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.
      • resourceAwsEc2InstanceLaunchedAt

        public final List<DateFilter> resourceAwsEc2InstanceLaunchedAt()

        The date and time the instance was launched.

        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 hasResourceAwsEc2InstanceLaunchedAt() method.

        Returns:
        The date and time the instance was launched.
      • hasResourceAwsS3BucketOwnerId

        public final boolean hasResourceAwsS3BucketOwnerId()
        For responses, this returns true if the service returned a value for the ResourceAwsS3BucketOwnerId 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.
      • resourceAwsS3BucketOwnerId

        public final List<StringFilter> resourceAwsS3BucketOwnerId()

        The canonical user ID of the owner of the S3 bucket.

        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 hasResourceAwsS3BucketOwnerId() method.

        Returns:
        The canonical user ID of the owner of the S3 bucket.
      • hasResourceAwsS3BucketOwnerName

        public final boolean hasResourceAwsS3BucketOwnerName()
        For responses, this returns true if the service returned a value for the ResourceAwsS3BucketOwnerName 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.
      • resourceAwsS3BucketOwnerName

        public final List<StringFilter> resourceAwsS3BucketOwnerName()

        The display name of the owner of the S3 bucket.

        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 hasResourceAwsS3BucketOwnerName() method.

        Returns:
        The display name of the owner of the S3 bucket.
      • hasResourceAwsIamAccessKeyUserName

        @Deprecated
        public final boolean hasResourceAwsIamAccessKeyUserName()
        Deprecated.
        This filter is deprecated. Instead, use ResourceAwsIamAccessKeyPrincipalName.
        For responses, this returns true if the service returned a value for the ResourceAwsIamAccessKeyUserName 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.
      • resourceAwsIamAccessKeyUserName

        @Deprecated
        public final List<StringFilter> resourceAwsIamAccessKeyUserName()
        Deprecated.
        This filter is deprecated. Instead, use ResourceAwsIamAccessKeyPrincipalName.

        The user associated with the IAM access key related to a finding.

        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 hasResourceAwsIamAccessKeyUserName() method.

        Returns:
        The user associated with the IAM access key related to a finding.
      • hasResourceAwsIamAccessKeyPrincipalName

        public final boolean hasResourceAwsIamAccessKeyPrincipalName()
        For responses, this returns true if the service returned a value for the ResourceAwsIamAccessKeyPrincipalName 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.
      • resourceAwsIamAccessKeyPrincipalName

        public final List<StringFilter> resourceAwsIamAccessKeyPrincipalName()

        The name of the principal that is associated with an IAM access key.

        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 hasResourceAwsIamAccessKeyPrincipalName() method.

        Returns:
        The name of the principal that is associated with an IAM access key.
      • hasResourceAwsIamAccessKeyStatus

        public final boolean hasResourceAwsIamAccessKeyStatus()
        For responses, this returns true if the service returned a value for the ResourceAwsIamAccessKeyStatus 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.
      • resourceAwsIamAccessKeyStatus

        public final List<StringFilter> resourceAwsIamAccessKeyStatus()

        The status of the IAM access key related to a finding.

        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 hasResourceAwsIamAccessKeyStatus() method.

        Returns:
        The status of the IAM access key related to a finding.
      • hasResourceAwsIamAccessKeyCreatedAt

        public final boolean hasResourceAwsIamAccessKeyCreatedAt()
        For responses, this returns true if the service returned a value for the ResourceAwsIamAccessKeyCreatedAt 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.
      • resourceAwsIamAccessKeyCreatedAt

        public final List<DateFilter> resourceAwsIamAccessKeyCreatedAt()

        The creation date/time of the IAM access key related to a finding.

        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 hasResourceAwsIamAccessKeyCreatedAt() method.

        Returns:
        The creation date/time of the IAM access key related to a finding.
      • hasResourceAwsIamUserUserName

        public final boolean hasResourceAwsIamUserUserName()
        For responses, this returns true if the service returned a value for the ResourceAwsIamUserUserName 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.
      • resourceAwsIamUserUserName

        public final List<StringFilter> resourceAwsIamUserUserName()

        The name of an IAM user.

        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 hasResourceAwsIamUserUserName() method.

        Returns:
        The name of an IAM user.
      • hasResourceContainerName

        public final boolean hasResourceContainerName()
        For responses, this returns true if the service returned a value for the ResourceContainerName 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.
      • resourceContainerName

        public final List<StringFilter> resourceContainerName()

        The name of the container related to a finding.

        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 hasResourceContainerName() method.

        Returns:
        The name of the container related to a finding.
      • hasResourceContainerImageId

        public final boolean hasResourceContainerImageId()
        For responses, this returns true if the service returned a value for the ResourceContainerImageId 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.
      • resourceContainerImageId

        public final List<StringFilter> resourceContainerImageId()

        The identifier of the image related to a finding.

        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 hasResourceContainerImageId() method.

        Returns:
        The identifier of the image related to a finding.
      • hasResourceContainerImageName

        public final boolean hasResourceContainerImageName()
        For responses, this returns true if the service returned a value for the ResourceContainerImageName 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.
      • resourceContainerImageName

        public final List<StringFilter> resourceContainerImageName()

        The name of the image related to a finding.

        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 hasResourceContainerImageName() method.

        Returns:
        The name of the image related to a finding.
      • hasResourceContainerLaunchedAt

        public final boolean hasResourceContainerLaunchedAt()
        For responses, this returns true if the service returned a value for the ResourceContainerLaunchedAt 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.
      • resourceContainerLaunchedAt

        public final List<DateFilter> resourceContainerLaunchedAt()

        A timestamp that identifies when the container was started.

        For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

        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 hasResourceContainerLaunchedAt() method.

        Returns:
        A timestamp that identifies when the container was started.

        For more information about the validation and formatting of timestamp fields in Security Hub, see Timestamps.

      • hasResourceDetailsOther

        public final boolean hasResourceDetailsOther()
        For responses, this returns true if the service returned a value for the ResourceDetailsOther 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.
      • resourceDetailsOther

        public final List<MapFilter> resourceDetailsOther()

        The details of a resource that doesn't have a specific subfield for the resource type defined.

        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 hasResourceDetailsOther() method.

        Returns:
        The details of a resource that doesn't have a specific subfield for the resource type defined.
      • hasComplianceStatus

        public final boolean hasComplianceStatus()
        For responses, this returns true if the service returned a value for the ComplianceStatus 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.
      • complianceStatus

        public final List<StringFilter> complianceStatus()

        Exclusive to findings that are generated as the result of a check run against a specific rule in a supported standard, such as CIS Amazon Web Services Foundations. Contains security standard-related finding details.

        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 hasComplianceStatus() method.

        Returns:
        Exclusive to findings that are generated as the result of a check run against a specific rule in a supported standard, such as CIS Amazon Web Services Foundations. Contains security standard-related finding details.
      • hasVerificationState

        public final boolean hasVerificationState()
        For responses, this returns true if the service returned a value for the VerificationState 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.
      • verificationState

        public final List<StringFilter> verificationState()

        The veracity of a finding.

        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 hasVerificationState() method.

        Returns:
        The veracity of a finding.
      • hasWorkflowState

        public final boolean hasWorkflowState()
        For responses, this returns true if the service returned a value for the WorkflowState 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.
      • workflowState

        public final List<StringFilter> workflowState()

        The workflow state of a finding.

        Note that this field is deprecated. To search for a finding based on its workflow status, use WorkflowStatus.

        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 hasWorkflowState() method.

        Returns:
        The workflow state of a finding.

        Note that this field is deprecated. To search for a finding based on its workflow status, use WorkflowStatus.

      • hasWorkflowStatus

        public final boolean hasWorkflowStatus()
        For responses, this returns true if the service returned a value for the WorkflowStatus 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.
      • workflowStatus

        public final List<StringFilter> workflowStatus()

        The status of the investigation into a finding. Allowed values are the following.

        • NEW - The initial state of a finding, before it is reviewed.

          Security Hub also resets the workflow status from NOTIFIED or RESOLVED to NEW in the following cases:

          • RecordState changes from ARCHIVED to ACTIVE.

          • Compliance.Status changes from PASSED to either WARNING, FAILED, or NOT_AVAILABLE.

        • NOTIFIED - Indicates that the resource owner has been notified about the security issue. Used when the initial reviewer is not the resource owner, and needs intervention from the resource owner.

          If one of the following occurs, the workflow status is changed automatically from NOTIFIED to NEW:

          • RecordState changes from ARCHIVED to ACTIVE.

          • Compliance.Status changes from PASSED to FAILED, WARNING, or NOT_AVAILABLE.

        • SUPPRESSED - Indicates that you reviewed the finding and don't believe that any action is needed.

          The workflow status of a SUPPRESSED finding does not change if RecordState changes from ARCHIVED to ACTIVE.

        • RESOLVED - The finding was reviewed and remediated and is now considered resolved.

          The finding remains RESOLVED unless one of the following occurs:

          • RecordState changes from ARCHIVED to ACTIVE.

          • Compliance.Status changes from PASSED to FAILED, WARNING, or NOT_AVAILABLE.

          In those cases, the workflow status is automatically reset to NEW.

          For findings from controls, if Compliance.Status is PASSED, then Security Hub automatically sets the workflow status to RESOLVED.

        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 hasWorkflowStatus() method.

        Returns:
        The status of the investigation into a finding. Allowed values are the following.

        • NEW - The initial state of a finding, before it is reviewed.

          Security Hub also resets the workflow status from NOTIFIED or RESOLVED to NEW in the following cases:

          • RecordState changes from ARCHIVED to ACTIVE.

          • Compliance.Status changes from PASSED to either WARNING, FAILED, or NOT_AVAILABLE.

        • NOTIFIED - Indicates that the resource owner has been notified about the security issue. Used when the initial reviewer is not the resource owner, and needs intervention from the resource owner.

          If one of the following occurs, the workflow status is changed automatically from NOTIFIED to NEW:

          • RecordState changes from ARCHIVED to ACTIVE.

          • Compliance.Status changes from PASSED to FAILED, WARNING, or NOT_AVAILABLE.

        • SUPPRESSED - Indicates that you reviewed the finding and don't believe that any action is needed.

          The workflow status of a SUPPRESSED finding does not change if RecordState changes from ARCHIVED to ACTIVE.

        • RESOLVED - The finding was reviewed and remediated and is now considered resolved.

          The finding remains RESOLVED unless one of the following occurs:

          • RecordState changes from ARCHIVED to ACTIVE.

          • Compliance.Status changes from PASSED to FAILED, WARNING, or NOT_AVAILABLE.

          In those cases, the workflow status is automatically reset to NEW.

          For findings from controls, if Compliance.Status is PASSED, then Security Hub automatically sets the workflow status to RESOLVED.

      • hasRecordState

        public final boolean hasRecordState()
        For responses, this returns true if the service returned a value for the RecordState 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.
      • recordState

        public final List<StringFilter> recordState()

        The updated record state for the finding.

        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 hasRecordState() method.

        Returns:
        The updated record state for the finding.
      • hasRelatedFindingsProductArn

        public final boolean hasRelatedFindingsProductArn()
        For responses, this returns true if the service returned a value for the RelatedFindingsProductArn 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.
      • relatedFindingsProductArn

        public final List<StringFilter> relatedFindingsProductArn()

        The ARN of the solution that generated a related finding.

        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 hasRelatedFindingsProductArn() method.

        Returns:
        The ARN of the solution that generated a related finding.
      • hasRelatedFindingsId

        public final boolean hasRelatedFindingsId()
        For responses, this returns true if the service returned a value for the RelatedFindingsId 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.
      • relatedFindingsId

        public final List<StringFilter> relatedFindingsId()

        The solution-generated identifier for a related finding.

        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 hasRelatedFindingsId() method.

        Returns:
        The solution-generated identifier for a related finding.
      • hasNoteText

        public final boolean hasNoteText()
        For responses, this returns true if the service returned a value for the NoteText 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.
      • noteText

        public final List<StringFilter> noteText()

        The text of a note.

        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 hasNoteText() method.

        Returns:
        The text of a note.
      • hasNoteUpdatedAt

        public final boolean hasNoteUpdatedAt()
        For responses, this returns true if the service returned a value for the NoteUpdatedAt 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.
      • noteUpdatedAt

        public final List<DateFilter> noteUpdatedAt()

        The timestamp of when the note was updated.

        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 hasNoteUpdatedAt() method.

        Returns:
        The timestamp of when the note was updated.
      • hasNoteUpdatedBy

        public final boolean hasNoteUpdatedBy()
        For responses, this returns true if the service returned a value for the NoteUpdatedBy 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.
      • noteUpdatedBy

        public final List<StringFilter> noteUpdatedBy()

        The principal that created a note.

        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 hasNoteUpdatedBy() method.

        Returns:
        The principal that created a note.
      • hasKeyword

        @Deprecated
        public final boolean hasKeyword()
        Deprecated.
        The Keyword property is deprecated.
        For responses, this returns true if the service returned a value for the Keyword 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.
      • keyword

        @Deprecated
        public final List<KeywordFilter> keyword()
        Deprecated.
        The Keyword property is deprecated.

        A keyword for a finding.

        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 hasKeyword() method.

        Returns:
        A keyword for a finding.
      • hasFindingProviderFieldsConfidence

        public final boolean hasFindingProviderFieldsConfidence()
        For responses, this returns true if the service returned a value for the FindingProviderFieldsConfidence 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.
      • findingProviderFieldsConfidence

        public final List<NumberFilter> findingProviderFieldsConfidence()

        The finding provider value for the finding confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify.

        Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.

        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 hasFindingProviderFieldsConfidence() method.

        Returns:
        The finding provider value for the finding confidence. Confidence is defined as the likelihood that a finding accurately identifies the behavior or issue that it was intended to identify.

        Confidence is scored on a 0-100 basis using a ratio scale, where 0 means zero percent confidence and 100 means 100 percent confidence.

      • hasFindingProviderFieldsCriticality

        public final boolean hasFindingProviderFieldsCriticality()
        For responses, this returns true if the service returned a value for the FindingProviderFieldsCriticality 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.
      • findingProviderFieldsCriticality

        public final List<NumberFilter> findingProviderFieldsCriticality()

        The finding provider value for the level of importance assigned to the resources associated with the findings.

        A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.

        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 hasFindingProviderFieldsCriticality() method.

        Returns:
        The finding provider value for the level of importance assigned to the resources associated with the findings.

        A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources.

      • hasFindingProviderFieldsRelatedFindingsId

        public final boolean hasFindingProviderFieldsRelatedFindingsId()
        For responses, this returns true if the service returned a value for the FindingProviderFieldsRelatedFindingsId 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.
      • findingProviderFieldsRelatedFindingsId

        public final List<StringFilter> findingProviderFieldsRelatedFindingsId()

        The finding identifier of a related finding that is identified by the finding provider.

        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 hasFindingProviderFieldsRelatedFindingsId() method.

        Returns:
        The finding identifier of a related finding that is identified by the finding provider.
      • hasFindingProviderFieldsRelatedFindingsProductArn

        public final boolean hasFindingProviderFieldsRelatedFindingsProductArn()
        For responses, this returns true if the service returned a value for the FindingProviderFieldsRelatedFindingsProductArn 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.
      • findingProviderFieldsRelatedFindingsProductArn

        public final List<StringFilter> findingProviderFieldsRelatedFindingsProductArn()

        The ARN of the solution that generated a related finding that is identified by the finding provider.

        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 hasFindingProviderFieldsRelatedFindingsProductArn() method.

        Returns:
        The ARN of the solution that generated a related finding that is identified by the finding provider.
      • hasFindingProviderFieldsSeverityLabel

        public final boolean hasFindingProviderFieldsSeverityLabel()
        For responses, this returns true if the service returned a value for the FindingProviderFieldsSeverityLabel 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.
      • findingProviderFieldsSeverityLabel

        public final List<StringFilter> findingProviderFieldsSeverityLabel()

        The finding provider value for the severity label.

        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 hasFindingProviderFieldsSeverityLabel() method.

        Returns:
        The finding provider value for the severity label.
      • hasFindingProviderFieldsSeverityOriginal

        public final boolean hasFindingProviderFieldsSeverityOriginal()
        For responses, this returns true if the service returned a value for the FindingProviderFieldsSeverityOriginal 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.
      • findingProviderFieldsSeverityOriginal

        public final List<StringFilter> findingProviderFieldsSeverityOriginal()

        The finding provider's original value for the severity.

        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 hasFindingProviderFieldsSeverityOriginal() method.

        Returns:
        The finding provider's original value for the severity.
      • hasFindingProviderFieldsTypes

        public final boolean hasFindingProviderFieldsTypes()
        For responses, this returns true if the service returned a value for the FindingProviderFieldsTypes 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.
      • findingProviderFieldsTypes

        public final List<StringFilter> findingProviderFieldsTypes()

        One or more finding types that the finding provider assigned to the finding. Uses the format of namespace/category/classifier that classify a finding.

        Valid namespace values are: Software and Configuration Checks | TTPs | Effects | Unusual Behaviors | Sensitive Data Identifications

        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 hasFindingProviderFieldsTypes() method.

        Returns:
        One or more finding types that the finding provider assigned to the finding. Uses the format of namespace/category/classifier that classify a finding.

        Valid namespace values are: Software and Configuration Checks | TTPs | Effects | Unusual Behaviors | Sensitive Data Identifications

      • hasSample

        public final boolean hasSample()
        For responses, this returns true if the service returned a value for the Sample 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.
      • sample

        public final List<BooleanFilter> sample()

        Indicates whether or not sample findings are included in the filter results.

        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 hasSample() method.

        Returns:
        Indicates whether or not sample findings are included in the filter results.
      • hasComplianceSecurityControlId

        public final boolean hasComplianceSecurityControlId()
        For responses, this returns true if the service returned a value for the ComplianceSecurityControlId 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.
      • complianceSecurityControlId

        public final List<StringFilter> complianceSecurityControlId()

        The unique identifier of a control across standards. Values for this field typically consist of an Amazon Web Services service and a number, such as APIGateway.5.

        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 hasComplianceSecurityControlId() method.

        Returns:
        The unique identifier of a control across standards. Values for this field typically consist of an Amazon Web Services service and a number, such as APIGateway.5.
      • hasComplianceAssociatedStandardsId

        public final boolean hasComplianceAssociatedStandardsId()
        For responses, this returns true if the service returned a value for the ComplianceAssociatedStandardsId 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.
      • complianceAssociatedStandardsId

        public final List<StringFilter> complianceAssociatedStandardsId()

        The unique identifier of a standard in which a control is enabled. This field consists of the resource portion of the Amazon Resource Name (ARN) returned for a standard in the DescribeStandards API response.

        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 hasComplianceAssociatedStandardsId() method.

        Returns:
        The unique identifier of a standard in which a control is enabled. This field consists of the resource portion of the Amazon Resource Name (ARN) returned for a standard in the DescribeStandards API response.
      • hasVulnerabilitiesExploitAvailable

        public final boolean hasVulnerabilitiesExploitAvailable()
        For responses, this returns true if the service returned a value for the VulnerabilitiesExploitAvailable 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.
      • vulnerabilitiesExploitAvailable

        public final List<StringFilter> vulnerabilitiesExploitAvailable()

        Indicates whether a software vulnerability in your environment has a known exploit. You can filter findings by this field only if you use Security Hub and Amazon Inspector.

        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 hasVulnerabilitiesExploitAvailable() method.

        Returns:
        Indicates whether a software vulnerability in your environment has a known exploit. You can filter findings by this field only if you use Security Hub and Amazon Inspector.
      • hasVulnerabilitiesFixAvailable

        public final boolean hasVulnerabilitiesFixAvailable()
        For responses, this returns true if the service returned a value for the VulnerabilitiesFixAvailable 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.
      • vulnerabilitiesFixAvailable

        public final List<StringFilter> vulnerabilitiesFixAvailable()

        Indicates whether a vulnerability is fixed in a newer version of the affected software packages. You can filter findings by this field only if you use Security Hub and Amazon Inspector.

        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 hasVulnerabilitiesFixAvailable() method.

        Returns:
        Indicates whether a vulnerability is fixed in a newer version of the affected software packages. You can filter findings by this field only if you use Security Hub and Amazon Inspector.
      • hasComplianceSecurityControlParametersName

        public final boolean hasComplianceSecurityControlParametersName()
        For responses, this returns true if the service returned a value for the ComplianceSecurityControlParametersName 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.
      • complianceSecurityControlParametersName

        public final List<StringFilter> complianceSecurityControlParametersName()

        The name of a security control parameter.

        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 hasComplianceSecurityControlParametersName() method.

        Returns:
        The name of a security control parameter.
      • hasComplianceSecurityControlParametersValue

        public final boolean hasComplianceSecurityControlParametersValue()
        For responses, this returns true if the service returned a value for the ComplianceSecurityControlParametersValue 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.
      • complianceSecurityControlParametersValue

        public final List<StringFilter> complianceSecurityControlParametersValue()

        The current value of a security control parameter.

        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 hasComplianceSecurityControlParametersValue() method.

        Returns:
        The current value of a security control parameter.
      • hasAwsAccountName

        public final boolean hasAwsAccountName()
        For responses, this returns true if the service returned a value for the AwsAccountName 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.
      • awsAccountName

        public final List<StringFilter> awsAccountName()

        The name of the Amazon Web Services account in which a finding is generated.

        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 hasAwsAccountName() method.

        Returns:
        The name of the Amazon Web Services account in which a finding is generated.
      • hasResourceApplicationName

        public final boolean hasResourceApplicationName()
        For responses, this returns true if the service returned a value for the ResourceApplicationName 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.
      • resourceApplicationName

        public final List<StringFilter> resourceApplicationName()

        The name of the application that is related to a finding.

        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 hasResourceApplicationName() method.

        Returns:
        The name of the application that is related to a finding.
      • hasResourceApplicationArn

        public final boolean hasResourceApplicationArn()
        For responses, this returns true if the service returned a value for the ResourceApplicationArn 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.
      • resourceApplicationArn

        public final List<StringFilter> resourceApplicationArn()

        The ARN of the application that is related to a finding.

        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 hasResourceApplicationArn() method.

        Returns:
        The ARN of the application that is related to a finding.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)