com.oracle.bmc.datasafe.model

Class AuditProfile.Builder

java.lang.Object

com.oracle.bmc.datasafe.model.AuditProfile.Builder

Enclosing class:

AuditProfile

public static class AuditProfile.Builder
extends Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
AuditProfile.Builder	auditCollectedVolume(Long auditCollectedVolume) Indicates number of audit records collected by Data Safe in the current calendar month.
AuditProfile.Builder	auditTrails(List<AuditTrail> auditTrails) Indicates the list of available audit trails on the target.
AuditProfile	build()
AuditProfile.Builder	compartmentId(String compartmentId) The OCID of the compartment that contains the audit.
AuditProfile.Builder	copy(AuditProfile model)
AuditProfile.Builder	definedTags(Map<String,Map<String,Object>> definedTags) Defined tags for this resource.
AuditProfile.Builder	description(String description) The description of the audit profile.
AuditProfile.Builder	displayName(String displayName) The display name of the audit profile.
AuditProfile.Builder	freeformTags(Map<String,String> freeformTags) Free-form tags for this resource.
AuditProfile.Builder	id(String id) The OCID of the audit profile.
AuditProfile.Builder	isOverrideGlobalRetentionSetting(Boolean isOverrideGlobalRetentionSetting) Indicates whether audit retention settings like online and offline months is set at the target level overriding the global audit retention settings.
AuditProfile.Builder	isPaidUsageEnabled(Boolean isPaidUsageEnabled) Indicates if you want to continue collecting audit records beyond the free limit of one million audit records per month per target database, potentially incurring additional charges.
AuditProfile.Builder	lifecycleDetails(String lifecycleDetails) Details about the current state of the audit profile in Data Safe.
AuditProfile.Builder	lifecycleState(AuditProfileLifecycleState lifecycleState) The current state of the audit profile.
AuditProfile.Builder	offlineMonths(Integer offlineMonths) Indicates the number of months the audit records will be stored offline in the Data Safe audit archive.
AuditProfile.Builder	onlineMonths(Integer onlineMonths) Indicates the number of months the audit records will be stored online in Oracle Data Safe audit repository for immediate reporting and analysis.
AuditProfile.Builder	systemTags(Map<String,Map<String,Object>> systemTags) System tags for this resource.
AuditProfile.Builder	targetId(String targetId) The OCID of the Data Safe target for which the audit profile is created.
AuditProfile.Builder	timeCreated(Date timeCreated) The date and time the audit profile was created, in the format defined by RFC3339.
AuditProfile.Builder	timeUpdated(Date timeUpdated) The date and time the audit profile was updated, in the format defined by RFC3339.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

id

public AuditProfile.Builder id(String id)

The OCID of the audit profile.

Parameters:

id - the value to set

Returns:

this builder

compartmentId

public AuditProfile.Builder compartmentId(String compartmentId)

The OCID of the compartment that contains the audit.

Parameters:

compartmentId - the value to set

Returns:

this builder

displayName

public AuditProfile.Builder displayName(String displayName)

The display name of the audit profile.

Parameters:

displayName - the value to set

Returns:

this builder

timeCreated

public AuditProfile.Builder timeCreated(Date timeCreated)

The date and time the audit profile was created, in the format defined by RFC3339.

Parameters:

timeCreated - the value to set

Returns:

this builder

timeUpdated

public AuditProfile.Builder timeUpdated(Date timeUpdated)

The date and time the audit profile was updated, in the format defined by RFC3339.

Parameters:

timeUpdated - the value to set

Returns:

this builder

lifecycleState

public AuditProfile.Builder lifecycleState(AuditProfileLifecycleState lifecycleState)

The current state of the audit profile.

Parameters:

lifecycleState - the value to set

Returns:

this builder

lifecycleDetails

public AuditProfile.Builder lifecycleDetails(String lifecycleDetails)

Details about the current state of the audit profile in Data Safe.

Parameters:

lifecycleDetails - the value to set

Returns:

this builder

targetId

public AuditProfile.Builder targetId(String targetId)

The OCID of the Data Safe target for which the audit profile is created.

Parameters:

targetId - the value to set

Returns:

this builder

description

public AuditProfile.Builder description(String description)

The description of the audit profile.

Parameters:

description - the value to set

Returns:

this builder

auditTrails

public AuditProfile.Builder auditTrails(List<AuditTrail> auditTrails)

Indicates the list of available audit trails on the target.

Parameters:

auditTrails - the value to set

Returns:

this builder

isPaidUsageEnabled

public AuditProfile.Builder isPaidUsageEnabled(Boolean isPaidUsageEnabled)

Indicates if you want to continue collecting audit records beyond the free limit of one million audit records per month per target database, potentially incurring additional charges. The default value is inherited from the global settings. You can change at the global level or at the target level.

Parameters:

isPaidUsageEnabled - the value to set

Returns:

this builder

onlineMonths

public AuditProfile.Builder onlineMonths(Integer onlineMonths)

Indicates the number of months the audit records will be stored online in Oracle Data Safe audit repository for immediate reporting and analysis. Minimum: 1; Maximum:12 months

Parameters:

onlineMonths - the value to set

Returns:

this builder

offlineMonths

public AuditProfile.Builder offlineMonths(Integer offlineMonths)

Indicates the number of months the audit records will be stored offline in the Data Safe audit archive. Minimum: 0; Maximum: 72 months. If you have a requirement to store the audit data even longer in archive, please contact the Oracle Support.

Parameters:

offlineMonths - the value to set

Returns:

this builder

auditCollectedVolume

public AuditProfile.Builder auditCollectedVolume(Long auditCollectedVolume)

Indicates number of audit records collected by Data Safe in the current calendar month. Audit records for the Data Safe service account are excluded and are not counted towards your monthly free limit.

Parameters:

auditCollectedVolume - the value to set

Returns:

this builder

isOverrideGlobalRetentionSetting

public AuditProfile.Builder isOverrideGlobalRetentionSetting(Boolean isOverrideGlobalRetentionSetting)

Indicates whether audit retention settings like online and offline months is set at the target level overriding the global audit retention settings.

Parameters:

isOverrideGlobalRetentionSetting - the value to set

Returns:

this builder

freeformTags

public AuditProfile.Builder freeformTags(Map<String,String> freeformTags)

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags

Example: {"Department": "Finance"}

Parameters:

freeformTags - the value to set

Returns:

this builder

definedTags

public AuditProfile.Builder definedTags(Map<String,Map<String,Object>> definedTags)

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags

Example: {"Operations": {"CostCenter": "42"}}

Parameters:

definedTags - the value to set

Returns:

this builder

systemTags

public AuditProfile.Builder systemTags(Map<String,Map<String,Object>> systemTags)

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"orcl-cloud": {"free-tier-retained": "true"}}

Parameters:

systemTags - the value to set

Returns:

this builder

build

public AuditProfile build()

copy

public AuditProfile.Builder copy(AuditProfile model)