Package software.amazon.awssdk.services.codegurusecurity.model

Class FilePath

java.lang.Object

software.amazon.awssdk.services.codegurusecurity.model.FilePath

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<FilePath.Builder,FilePath>

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

Information about the location of security vulnerabilities that Amazon CodeGuru Security detected in your code.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	FilePath.Builder

Method Summary

Modifier and Type	Method	Description
static FilePath.Builder	builder()
List<CodeLine>	codeSnippet()	A list of CodeLine objects that describe where the security vulnerability appears in your code.
Integer	endLine()	The last line number of the code snippet where the security vulnerability appears in your code.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCodeSnippet()	For responses, this returns true if the service returned a value for the CodeSnippet property.
int	hashCode()
String	name()	The name of the file.
String	path()	The path to the resource with the security vulnerability.
List<SdkField<?>>	sdkFields()
static Class<? extends FilePath.Builder>	serializableBuilderClass()
Integer	startLine()	The first line number of the code snippet where the security vulnerability appears in your code.
FilePath.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

hasCodeSnippet

public final boolean hasCodeSnippet()

For responses, this returns true if the service returned a value for the CodeSnippet 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.

codeSnippet

public final List<CodeLine> codeSnippet()

A list of CodeLine objects that describe where the security vulnerability appears in your code.

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

Returns:

A list of CodeLine objects that describe where the security vulnerability appears in your code.

endLine

public final Integer endLine()

The last line number of the code snippet where the security vulnerability appears in your code.

Returns:

The last line number of the code snippet where the security vulnerability appears in your code.

name

public final String name()

The name of the file.

Returns:

The name of the file.

path

public final String path()

The path to the resource with the security vulnerability.

Returns:

The path to the resource with the security vulnerability.

startLine

public final Integer startLine()

The first line number of the code snippet where the security vulnerability appears in your code.

Returns:

The first line number of the code snippet where the security vulnerability appears in your code.

toBuilder

public FilePath.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<FilePath.Builder,FilePath>

builder

public static FilePath.Builder builder()

serializableBuilderClass

public static Class<? extends FilePath.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