Package com.oracle.bmc.cloudguard.model

Class ComplianceDocument

java.lang.Object

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

com.oracle.bmc.cloudguard.model.ComplianceDocument

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

A compliance document that exists in the tenancy.
Note: Objects should always be created or deserialized using the ComplianceDocument.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 ComplianceDocument.Builder, which maintain a set of all explicitly set fields called ComplianceDocument.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	ComplianceDocument.Builder
static class	ComplianceDocument.LifecycleState	The current lifecycle state of the compliance document.

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
ComplianceDocument(String id, String name, Date timeCreated, ComplianceDocument.LifecycleState lifecycleState, String documentFileName, Integer version, String type, String platform, Date timeUpdated, String saasServiceName)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static ComplianceDocument.Builder	builder()	Create a new builder.
boolean	equals(Object o)
String	getDocumentFileName()	The file name of the compliance document.
String	getId()	The OCID of the compliance document, which is assigned when you create the document as an Oracle Cloud Infrastructure resource and is immutable.
ComplianceDocument.LifecycleState	getLifecycleState()	The current lifecycle state of the compliance document.
String	getName()	A friendly name or title for the compliance document.
String	getPlatform()	The information technology infrastructure platform, or set of services, to which the compliance document belongs.
String	getSaasServiceName()	The saas service name to which compliance document belongs.
Date	getTimeCreated()	The date and time the compliance document was created, expressed in RFC 3339 timestamp format.
Date	getTimeUpdated()	The date and time the compliance document was last updated, expressed in RFC 3339 timestamp format.
String	getType()	The type of compliance document.
Integer	getVersion()	The version number of the compliance document.
int	hashCode()
ComplianceDocument.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

ComplianceDocument

@Deprecated
@ConstructorProperties({"id","name","timeCreated","lifecycleState","documentFileName","version","type","platform","timeUpdated","saasServiceName"})
public ComplianceDocument(String id,
                          String name,
                          Date timeCreated,
                          ComplianceDocument.LifecycleState lifecycleState,
                          String documentFileName,
                          Integer version,
                          String type,
                          String platform,
                          Date timeUpdated,
                          String saasServiceName)

Deprecated.

Method Detail

builder

public static ComplianceDocument.Builder builder()

Create a new builder.

toBuilder

public ComplianceDocument.Builder toBuilder()

getId

public String getId()

The OCID of the compliance document, which is assigned when you create the document as an Oracle Cloud Infrastructure resource and is immutable.

Returns:

the value

getName

public String getName()

A friendly name or title for the compliance document.

You cannot update this value later. Avoid entering confidential information.

Returns:

the value

getTimeCreated

public Date getTimeCreated()

The date and time the compliance document was created, expressed in RFC 3339 timestamp format.

Returns:

the value

getLifecycleState

public ComplianceDocument.LifecycleState getLifecycleState()

The current lifecycle state of the compliance document.

Returns:

the value

getDocumentFileName

public String getDocumentFileName()

The file name of the compliance document.

Returns:

the value

getVersion

public Integer getVersion()

The version number of the compliance document.

Returns:

the value

getType

public String getType()

The type of compliance document.

For definitions of supported types of compliance documents, see Types of Compliance Documents.

Returns:

the value

getPlatform

public String getPlatform()

The information technology infrastructure platform, or set of services, to which the compliance document belongs.

A platform can also be described as an environment or a business pillar. For definitions of supported environments, see Types of Environments.

Returns:

the value

getTimeUpdated

public Date getTimeUpdated()

The date and time the compliance document was last updated, expressed in RFC 3339 timestamp format.

Returns:

the value

getSaasServiceName

public String getSaasServiceName()

The saas service name to which compliance document belongs.

For other types such as ‘OCI’ / ‘PaaS’ this value will be null.

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