com.box.sdkgen.managers.retentionpolicies

Class CreateRetentionPolicyRequestBody

Object

NullableFieldTracker

SerializableObject

CreateRetentionPolicyRequestBody

All Implemented Interfaces:

Serializable

public class CreateRetentionPolicyRequestBody
extends SerializableObject

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateRetentionPolicyRequestBody.Builder

Field Summary

Fields

Modifier and Type	Field and Description
protected Boolean	areOwnersNotified Whether owner and co-owners of a file are notified when the policy nears expiration.
protected Boolean	canOwnerExtendRetention Whether the owner of a file will be allowed to extend the retention.
protected List<UserMini>	customNotificationRecipients A list of users notified when the retention policy duration is about to end.
protected String	description The additional text description of the retention policy.
protected EnumWrapper<CreateRetentionPolicyRequestBodyDispositionActionField>	dispositionAction The disposition action of the retention policy.
protected RetentionPolicyMaxExtensionLengthRequest	maxExtensionLength
protected String	policyName The name for the retention policy.
protected EnumWrapper<CreateRetentionPolicyRequestBodyPolicyTypeField>	policyType The type of the retention policy.
protected CreateRetentionPolicyRequestBodyRetentionLengthField	retentionLength The length of the retention policy.
protected EnumWrapper<CreateRetentionPolicyRequestBodyRetentionTypeField>	retentionType Specifies the retention type:

Fields inherited from class NullableFieldTracker

explicitlySetNullableFields

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CreateRetentionPolicyRequestBody(CreateRetentionPolicyRequestBody.Builder builder)
	CreateRetentionPolicyRequestBody(String policyName, CreateRetentionPolicyRequestBodyPolicyTypeField policyType, CreateRetentionPolicyRequestBodyDispositionActionField dispositionAction)
	CreateRetentionPolicyRequestBody(String policyName, CreateRetentionPolicyRequestBodyPolicyTypeField policyType, EnumWrapper<CreateRetentionPolicyRequestBodyDispositionActionField> dispositionAction)
	CreateRetentionPolicyRequestBody(String policyName, EnumWrapper<CreateRetentionPolicyRequestBodyPolicyTypeField> policyType, CreateRetentionPolicyRequestBodyDispositionActionField dispositionAction)
	CreateRetentionPolicyRequestBody(String policyName, EnumWrapper<CreateRetentionPolicyRequestBodyPolicyTypeField> policyType, EnumWrapper<CreateRetentionPolicyRequestBodyDispositionActionField> dispositionAction)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Boolean	getAreOwnersNotified()
Boolean	getCanOwnerExtendRetention()
List<UserMini>	getCustomNotificationRecipients()
String	getDescription()
EnumWrapper<CreateRetentionPolicyRequestBodyDispositionActionField>	getDispositionAction()
RetentionPolicyMaxExtensionLengthRequest	getMaxExtensionLength()
String	getPolicyName()
EnumWrapper<CreateRetentionPolicyRequestBodyPolicyTypeField>	getPolicyType()
CreateRetentionPolicyRequestBodyRetentionLengthField	getRetentionLength()
EnumWrapper<CreateRetentionPolicyRequestBodyRetentionTypeField>	getRetentionType()
int	hashCode()
String	toString()

Methods inherited from class SerializableObject

getRawData, setRawData

Methods inherited from class NullableFieldTracker

getExplicitlySetNullableFields, isFieldExplicitlySet, markNullableFieldAsSet, markNullableFieldsAsSet

Methods inherited from class Object

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

Field Detail

policyName

protected final String policyName

The name for the retention policy.

description

protected String description

The additional text description of the retention policy.

policyType

protected final EnumWrapper<CreateRetentionPolicyRequestBodyPolicyTypeField> policyType

The type of the retention policy. A retention policy type can either be `finite`, where a specific amount of time to retain the content is known upfront, or `indefinite`, where the amount of time to retain the content is still unknown.

dispositionAction

protected final EnumWrapper<CreateRetentionPolicyRequestBodyDispositionActionField> dispositionAction

The disposition action of the retention policy. `permanently_delete` deletes the content retained by the policy permanently. `remove_retention` lifts retention policy from the content, allowing it to be deleted by users once the retention policy has expired.

retentionLength

protected CreateRetentionPolicyRequestBodyRetentionLengthField retentionLength

The length of the retention policy. This value specifies the duration in days that the retention policy will be active for after being assigned to content. If the policy has a `policy_type` of `indefinite`, the `retention_length` will also be `indefinite`.

retentionType

protected EnumWrapper<CreateRetentionPolicyRequestBodyRetentionTypeField> retentionType

Specifies the retention type:

* `modifiable`: You can modify the retention policy. For example, you can add or remove folders, shorten or lengthen the policy duration, or delete the assignment. Use this type if your retention policy is not related to any regulatory purposes.

* `non_modifiable`: You can modify the retention policy only in a limited way: add a folder, lengthen the duration, retire the policy, change the disposition action or notification settings. You cannot perform other actions, such as deleting the assignment or shortening the policy duration. Use this type to ensure compliance with regulatory retention policies.

canOwnerExtendRetention

protected Boolean canOwnerExtendRetention

Whether the owner of a file will be allowed to extend the retention.

maxExtensionLength

protected RetentionPolicyMaxExtensionLengthRequest maxExtensionLength

areOwnersNotified

protected Boolean areOwnersNotified

Whether owner and co-owners of a file are notified when the policy nears expiration.

customNotificationRecipients

protected List<UserMini> customNotificationRecipients

A list of users notified when the retention policy duration is about to end.

Constructor Detail

CreateRetentionPolicyRequestBody

public CreateRetentionPolicyRequestBody(String policyName,
                                        CreateRetentionPolicyRequestBodyPolicyTypeField policyType,
                                        CreateRetentionPolicyRequestBodyDispositionActionField dispositionAction)

CreateRetentionPolicyRequestBody

public CreateRetentionPolicyRequestBody(String policyName,
                                        CreateRetentionPolicyRequestBodyPolicyTypeField policyType,
                                        EnumWrapper<CreateRetentionPolicyRequestBodyDispositionActionField> dispositionAction)

CreateRetentionPolicyRequestBody

public CreateRetentionPolicyRequestBody(String policyName,
                                        EnumWrapper<CreateRetentionPolicyRequestBodyPolicyTypeField> policyType,
                                        CreateRetentionPolicyRequestBodyDispositionActionField dispositionAction)

CreateRetentionPolicyRequestBody

public CreateRetentionPolicyRequestBody(String policyName,
                                        EnumWrapper<CreateRetentionPolicyRequestBodyPolicyTypeField> policyType,
                                        EnumWrapper<CreateRetentionPolicyRequestBodyDispositionActionField> dispositionAction)

CreateRetentionPolicyRequestBody

protected CreateRetentionPolicyRequestBody(CreateRetentionPolicyRequestBody.Builder builder)

Method Detail

getPolicyName

public String getPolicyName()

getDescription

public String getDescription()

getPolicyType

public EnumWrapper<CreateRetentionPolicyRequestBodyPolicyTypeField> getPolicyType()

getDispositionAction

public EnumWrapper<CreateRetentionPolicyRequestBodyDispositionActionField> getDispositionAction()

getRetentionLength

public CreateRetentionPolicyRequestBodyRetentionLengthField getRetentionLength()

getRetentionType

public EnumWrapper<CreateRetentionPolicyRequestBodyRetentionTypeField> getRetentionType()

getCanOwnerExtendRetention

public Boolean getCanOwnerExtendRetention()

getMaxExtensionLength

public RetentionPolicyMaxExtensionLengthRequest getMaxExtensionLength()

getAreOwnersNotified

public Boolean getAreOwnersNotified()

getCustomNotificationRecipients

public List<UserMini> getCustomNotificationRecipients()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object