Package software.amazon.awssdk.services.securityhub.model

Class AutomationRulesFindingFilters

    • 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 Amazon Resource Name (ARN) for a third-party product that generated a finding in Security Hub.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

        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 Amazon Resource Name (ARN) for a third-party product that generated a finding in Security Hub.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

      • 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 was generated.

        Array Members: Minimum number of 1 item. Maximum number of 100 items.

        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 was generated.

        Array Members: Minimum number of 1 item. Maximum number of 100 items.

      • 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 product-specific identifier for a finding.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

        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 product-specific identifier for a finding.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

      • 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 that generated a finding.

        Array Members: Minimum number of 1 item. Maximum number of 100 items.

        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 that generated a finding.

        Array Members: Minimum number of 1 item. Maximum number of 100 items.

      • 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()

        One or more finding types in the format of namespace/category/classifier that classify a finding. For a list of namespaces, classifiers, and categories, see Types taxonomy for ASFF in the Security Hub User Guide.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

        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:
        One or more finding types in the format of namespace/category/classifier that classify a finding. For a list of namespaces, classifiers, and categories, see Types taxonomy for ASFF in the Security Hub User Guide.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

      • 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 potential security issue captured by a finding was first observed by the security findings product.

        This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

        • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

        • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

        • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

        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 potential security issue captured by a finding was first observed by the security findings product.

        This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

        • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

        • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

        • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

      • 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 potential security issue captured by a finding was most recently observed by the security findings product.

        This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

        • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

        • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

        • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

        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 potential security issue captured by a finding was most recently observed by the security findings product.

        This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

        • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

        • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

        • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

      • 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 this finding record was created.

        This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

        • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

        • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

        • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

        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 this finding record was created.

        This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

        • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

        • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

        • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

      • 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 finding record was most recently updated.

        This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

        • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

        • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

        • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

        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 finding record was most recently updated.

        This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

        • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

        • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

        • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

      • 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()

        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. A value of 0 means 0 percent confidence, and a value of 100 means 100 percent confidence. For example, a data exfiltration detection based on a statistical deviation of network traffic has low confidence because an actual exfiltration hasn't been verified. For more information, see Confidence in the Security Hub User Guide.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

        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:
        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. A value of 0 means 0 percent confidence, and a value of 100 means 100 percent confidence. For example, a data exfiltration detection based on a statistical deviation of network traffic has low confidence because an actual exfiltration hasn't been verified. For more information, see Confidence in the Security Hub User Guide.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

      • 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 that is assigned to the resources that are associated with a finding. Criticality is scored on a 0–100 basis, using a ratio scale that supports only full integers. A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources. For more information, see Criticality in the Security Hub User Guide.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

        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 that is assigned to the resources that are associated with a finding. Criticality is scored on a 0–100 basis, using a ratio scale that supports only full integers. A score of 0 means that the underlying resources have no criticality, and a score of 100 is reserved for the most critical resources. For more information, see Criticality in the Security Hub User Guide.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

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

        Array Members: Minimum number of 1 item. Maximum number of 100 items.

        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.

        Array Members: Minimum number of 1 item. Maximum number of 100 items.

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

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

        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.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

      • 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()

        Provides a URL that links to a page about the current finding in the finding product.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

        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:
        Provides a URL that links to a page about the current finding in the finding product.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

      • 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()

        Provides the name of the product that generated the finding. For control-based findings, the product name is Security Hub.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

        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:
        Provides the name of the product that generated the finding. For control-based findings, the product name is Security Hub.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

      • 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 company for the product that generated the finding. For control-based findings, the company is Amazon Web Services.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

        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 company for the product that generated the finding. For control-based findings, the company is Amazon Web Services.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

      • 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 severity value of the finding.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

        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 severity value of the finding.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

      • 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()

        The type of resource that the finding pertains to.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

        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:
        The type of resource that the finding pertains to.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

      • 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 identifier for the given resource type. For Amazon Web Services resources that are identified by Amazon Resource Names (ARNs), this is the ARN. For Amazon Web Services resources that lack ARNs, this is the identifier as defined by the Amazon Web Service that created the resource. For non-Amazon Web Services resources, this is a unique identifier that is associated with the resource.

        Array Members: Minimum number of 1 item. Maximum number of 100 items.

        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 identifier for the given resource type. For Amazon Web Services resources that are identified by Amazon Resource Names (ARNs), this is the ARN. For Amazon Web Services resources that lack ARNs, this is the identifier as defined by the Amazon Web Service that created the resource. For non-Amazon Web Services resources, this is a unique identifier that is associated with the resource.

        Array Members: Minimum number of 1 item. Maximum number of 100 items.

      • 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 partition in which the resource that the finding pertains to is located. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one partition.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

        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 partition in which the resource that the finding pertains to is located. A partition is a group of Amazon Web Services Regions. Each Amazon Web Services account is scoped to one partition.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

      • 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 Amazon Web Services Region where the resource that a finding pertains to is located.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

        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 Amazon Web Services Region where the resource that a finding pertains to is located.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

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

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

        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.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

      • 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()

        Custom fields and values about the resource that a finding pertains to.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

        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:
        Custom fields and values about the resource that a finding pertains to.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

      • 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()

        The result of a security check. This field is only used for findings generated from controls.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

        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:
        The result of a security check. This field is only used for findings generated from controls.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

      • 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 security control ID for which a finding was generated. Security control IDs are the same across standards.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

        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 security control ID for which a finding was generated. Security control IDs are the same across standards.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

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

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

        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.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

      • 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()

        Provides the veracity of a finding.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

        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:
        Provides the veracity of a finding.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

      • 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()

        Provides information about the status of the investigation into a finding.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

        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:
        Provides information about the status of the investigation into a finding.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

      • 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()

        Provides the current state of a finding.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

        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:
        Provides the current state of a finding.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

      • 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 for the product that generated a related finding.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

        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 for the product that generated a related finding.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

      • 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 product-generated identifier for a related finding.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

        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 product-generated identifier for a related finding.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

      • 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 user-defined note that's added to a finding.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

        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 user-defined note that's added to a finding.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

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

        This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

        • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

        • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

        • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

        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.

        This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:

        • YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)

        • YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)

        • YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)

        • YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

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

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

        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.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

      • 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 user-defined name and value string pairs added to a finding.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

        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 user-defined name and value string pairs added to a finding.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

      • 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 Amazon Resource Name (ARN) of the application that is related to a finding.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

        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 Amazon Resource Name (ARN) of the application that is related to a finding.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

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

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

        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.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

      • 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 was generated.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

        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 was generated.

        Array Members: Minimum number of 1 item. Maximum number of 20 items.

      • 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)