Class AutomationRulesFindingFieldsUpdate

    • Method Detail

      • note

        public final NoteUpdate note()
        Returns the value of the Note property for this object.
        Returns:
        The value of the Note property for this object.
      • severity

        public final SeverityUpdate severity()
        Returns the value of the Severity property for this object.
        Returns:
        The value of the Severity property for this object.
      • verificationStateAsString

        public final String verificationStateAsString()

        The rule action updates the VerificationState field of a finding.

        If the service returns an enum value that is not available in the current SDK version, verificationState will return VerificationState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from verificationStateAsString().

        Returns:
        The rule action updates the VerificationState field of a finding.
        See Also:
        VerificationState
      • confidence

        public final Integer confidence()

        The rule action updates the Confidence field of a finding.

        Returns:
        The rule action updates the Confidence field of a finding.
      • criticality

        public final Integer criticality()

        The rule action updates the Criticality field of a finding.

        Returns:
        The rule action updates the Criticality field of a finding.
      • hasTypes

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

        public final List<String> types()

        The rule action updates the Types field 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 hasTypes() method.

        Returns:
        The rule action updates the Types field of a finding.
      • 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 Map<String,​String> userDefinedFields()

        The rule action updates the UserDefinedFields field 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 hasUserDefinedFields() method.

        Returns:
        The rule action updates the UserDefinedFields field of a finding.
      • workflow

        public final WorkflowUpdate workflow()
        Returns the value of the Workflow property for this object.
        Returns:
        The value of the Workflow property for this object.
      • hasRelatedFindings

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

        public final List<RelatedFinding> relatedFindings()

        The rule action updates the RelatedFindings field 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 hasRelatedFindings() method.

        Returns:
        The rule action updates the RelatedFindings field of 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)