Finding (AWS Java SDK :: Services :: Code Guru Security 2.20.103 API)

java.lang.Object
- software.amazon.awssdk.services.codegurusecurity.model.Finding

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Finding.Builder,Finding>

@Generated(value="software.amazon.awssdk:codegen")
public final class Finding
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Finding.Builder,Finding>

Information about a finding that was detected in your code.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Finding.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Finding.Builder`	`builder()`
`Instant`	`createdAt()` The time when the finding was created.
`String`	`description()` A description of the finding.
`String`	`detectorId()` The identifier for the detector that detected the finding in your code.
`String`	`detectorName()` The name of the detector that identified the security vulnerability in your code.
`List<String>`	`detectorTags()` One or more tags or categorizations that are associated with a detector.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`generatorId()` The identifier for the component that generated a finding such as AWSCodeGuruSecurity or AWSInspector.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasDetectorTags()` For responses, this returns true if the service returned a value for the DetectorTags property.
`int`	`hashCode()`
`String`	`id()` The identifier for a finding.
`Remediation`	`remediation()` An object that contains the details about how to remediate a finding.
`Resource`	`resource()` The resource where Amazon CodeGuru Security detected a finding.
`String`	`ruleId()` The identifier for the rule that generated the finding.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Finding.Builder>`	`serializableBuilderClass()`
`Severity`	`severity()` The severity of the finding.
`String`	`severityAsString()` The severity of the finding.
`Status`	`status()` The status of the finding.
`String`	`statusAsString()` The status of the finding.
`String`	`title()` The title of the finding.
`Finding.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`type()` The type of finding.
`Instant`	`updatedAt()` The time when the finding was last updated.
`Vulnerability`	`vulnerability()` An object that describes the detected security vulnerability.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - createdAt
```
public final Instant createdAt()
```
    The time when the finding was created.
    
    Returns:
    
    The time when the finding was created.
  - description
```
public final String description()
```
    A description of the finding.
    
    Returns:
    
    A description of the finding.
  - detectorId
```
public final String detectorId()
```
    The identifier for the detector that detected the finding in your code. A detector is a defined rule based on industry standards and AWS best practices.
    
    Returns:
    
    The identifier for the detector that detected the finding in your code. A detector is a defined rule based on industry standards and AWS best practices.
  - detectorName
```
public final String detectorName()
```
    The name of the detector that identified the security vulnerability in your code.
    
    Returns:
    
    The name of the detector that identified the security vulnerability in your code.
  - hasDetectorTags
```
public final boolean hasDetectorTags()
```
    For responses, this returns true if the service returned a value for the DetectorTags 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.
  - detectorTags
```
public final List<String> detectorTags()
```
    One or more tags or categorizations that are associated with a detector. These tags are defined by type, programming language, or other classification such as maintainability or consistency.
    
    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 hasDetectorTags() method.
    
    Returns:
    
    One or more tags or categorizations that are associated with a detector. These tags are defined by type, programming language, or other classification such as maintainability or consistency.
  - generatorId
```
public final String generatorId()
```
    The identifier for the component that generated a finding such as AWSCodeGuruSecurity or AWSInspector.
    
    Returns:
    
    The identifier for the component that generated a finding such as AWSCodeGuruSecurity or AWSInspector.
  - id
```
public final String id()
```
    The identifier for a finding.
    
    Returns:
    
    The identifier for a finding.
  - remediation
```
public final Remediation remediation()
```
    An object that contains the details about how to remediate a finding.
    
    Returns:
    
    An object that contains the details about how to remediate a finding.
  - resource
```
public final Resource resource()
```
    The resource where Amazon CodeGuru Security detected a finding.
    
    Returns:
    
    The resource where Amazon CodeGuru Security detected a finding.
  - ruleId
```
public final String ruleId()
```
    The identifier for the rule that generated the finding.
    
    Returns:
    
    The identifier for the rule that generated the finding.
  - severity
```
public final Severity severity()
```
    The severity of the finding.
    
    If the service returns an enum value that is not available in the current SDK version, severity will return Severity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from severityAsString().
    
    Returns:
    
    The severity of the finding.
    
    See Also:
    
    Severity
  - severityAsString
```
public final String severityAsString()
```
    The severity of the finding.
    
    If the service returns an enum value that is not available in the current SDK version, severity will return Severity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from severityAsString().
    
    Returns:
    
    The severity of the finding.
    
    See Also:
    
    Severity
  - status
```
public final Status status()
```
    The status of the finding. A finding status can be open or closed.
    
    If the service returns an enum value that is not available in the current SDK version, status will return Status.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of the finding. A finding status can be open or closed.
    
    See Also:
    
    Status
  - statusAsString
```
public final String statusAsString()
```
    The status of the finding. A finding status can be open or closed.
    
    If the service returns an enum value that is not available in the current SDK version, status will return Status.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    The status of the finding. A finding status can be open or closed.
    
    See Also:
    
    Status
  - title
```
public final String title()
```
    The title of the finding.
    
    Returns:
    
    The title of the finding.
  - type
```
public final String type()
```
    The type of finding.
    
    Returns:
    
    The type of finding.
  - updatedAt
```
public final Instant updatedAt()
```
    The time when the finding was last updated. Findings are updated when you remediate them or when the finding code location changes.
    
    Returns:
    
    The time when the finding was last updated. Findings are updated when you remediate them or when the finding code location changes.
  - vulnerability
```
public final Vulnerability vulnerability()
```
    An object that describes the detected security vulnerability.
    
    Returns:
    
    An object that describes the detected security vulnerability.
  - toBuilder
```
public Finding.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Finding.Builder,Finding>
  - builder
```
public static Finding.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Finding.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Finding

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

createdAt

description

detectorId

detectorName

hasDetectorTags

detectorTags

generatorId

id

remediation

resource

ruleId

severity

severityAsString

status

statusAsString

title

type

updatedAt

vulnerability

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields