Package com.oracle.bmc.datasafe.model

Class CheckSummary

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.datasafe.model.CheckSummary

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20181201")
public final class CheckSummary
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

The summary of the security rule to be evaluated by security assessment to create finding.
Note: Objects should always be created or deserialized using the CheckSummary.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the CheckSummary.Builder, which maintain a set of all explicitly set fields called CheckSummary.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CheckSummary.Builder
static class	CheckSummary.SuggestedSeverity	The severity of the check as suggested by Data Safe security assessment.

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
CheckSummary(String key, String title, String remarks, References references, String category, String oneline, CheckSummary.SuggestedSeverity suggestedSeverity)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static CheckSummary.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getCategory()	The category to which the check belongs to.
String	getKey()	A unique identifier for the check.
String	getOneline()	Provides a recommended approach to take to remediate the check reported.
References	getReferences()	Provides information on whether the check is related to a CIS Oracle Database Benchmark recommendation, STIG rule, GDPR Article/Recital or related to the Oracle Recommended Practice.
String	getRemarks()	The explanation of the issue in this check.
CheckSummary.SuggestedSeverity	getSuggestedSeverity()	The severity of the check as suggested by Data Safe security assessment.
String	getTitle()	The short title for the check.
int	hashCode()
CheckSummary.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CheckSummary

@Deprecated
@ConstructorProperties({"key","title","remarks","references","category","oneline","suggestedSeverity"})
public CheckSummary(String key,
                    String title,
                    String remarks,
                    References references,
                    String category,
                    String oneline,
                    CheckSummary.SuggestedSeverity suggestedSeverity)

Deprecated.

Method Detail

builder

public static CheckSummary.Builder builder()

Create a new builder.

toBuilder

public CheckSummary.Builder toBuilder()

getKey

public String getKey()

A unique identifier for the check.

Returns:

the value

getTitle

public String getTitle()

The short title for the check.

Returns:

the value

getRemarks

public String getRemarks()

The explanation of the issue in this check.

It explains the reason for the rule and, if a risk is reported, it may also explain the recommended actions for remediation.

Returns:

the value

getReferences

public References getReferences()

Provides information on whether the check is related to a CIS Oracle Database Benchmark recommendation, STIG rule, GDPR Article/Recital or related to the Oracle Recommended Practice.

Returns:

the value

getCategory

public String getCategory()

The category to which the check belongs to.

Returns:

the value

getOneline

public String getOneline()

Provides a recommended approach to take to remediate the check reported.

Returns:

the value

getSuggestedSeverity

public CheckSummary.SuggestedSeverity getSuggestedSeverity()

The severity of the check as suggested by Data Safe security assessment.

This will be the default severity in the template baseline security assessment.

Returns:

the value

toString

public String toString()

Overrides:

toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

hashCode

public int hashCode()

Overrides:

hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel