UpdateRetentionPolicyByIdRequestBody (Box Java SDK)

Object
- NullableFieldTracker
- - SerializableObject
  - - UpdateRetentionPolicyByIdRequestBody

All Implemented Interfaces:: Serializable

public class UpdateRetentionPolicyByIdRequestBody
extends SerializableObject

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class UpdateRetentionPolicyByIdRequestBody.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`UpdateRetentionPolicyByIdRequestBody.Builder`

Field Summary

Fields
Modifier and Type	Field and Description
`protected Boolean`	`areOwnersNotified` Determines if owners and co-owners of items under the policy are notified when the retention duration is about to end.
`protected Boolean`	`canOwnerExtendRetention` Determines if the owner of items under the policy can extend the retention when the original retention duration is about to end.
`protected List<UserBase>`	`customNotificationRecipients` A list of users notified when the retention duration is about to end.
`protected String`	`description` The additional text description of the retention policy.
`protected String`	`dispositionAction` The disposition action of the retention policy.
`protected RetentionPolicyMaxExtensionLengthRequest`	`maxExtensionLength`
`protected String`	`policyName` The name for the retention policy.
`protected UpdateRetentionPolicyByIdRequestBodyRetentionLengthField`	`retentionLength` The length of the retention policy.
`protected String`	`retentionType` Specifies the retention type:
`protected String`	`status` Used to retire a retention policy.

Fields inherited from class NullableFieldTracker
explicitlySetNullableFields

Constructor Summary

Constructors
Modifier	Constructor and Description
	`UpdateRetentionPolicyByIdRequestBody()`
`protected`	`UpdateRetentionPolicyByIdRequestBody(UpdateRetentionPolicyByIdRequestBody.Builder builder)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`Boolean`	`getAreOwnersNotified()`
`Boolean`	`getCanOwnerExtendRetention()`
`List<UserBase>`	`getCustomNotificationRecipients()`
`String`	`getDescription()`
`String`	`getDispositionAction()`
`RetentionPolicyMaxExtensionLengthRequest`	`getMaxExtensionLength()`
`String`	`getPolicyName()`
`UpdateRetentionPolicyByIdRequestBodyRetentionLengthField`	`getRetentionLength()`
`String`	`getRetentionType()`
`String`	`getStatus()`
`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 String policyName
```
    The name for the retention policy.
  - description
```
protected String description
```
    The additional text description of the retention policy.
  - dispositionAction
```
protected String dispositionAction
```
    The disposition action of the retention policy. This action can be `permanently_delete`, which will cause the content retained by the policy to be permanently deleted, or `remove_retention`, which will lift the retention policy from the content, allowing it to be deleted by users, once the retention policy has expired. You can use `null` if you don't want to change `disposition_action`.
  - retentionType
```
protected String 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.
    When updating a retention policy, you can use `non-modifiable` type only. You can convert a `modifiable` policy to `non-modifiable`, but not the other way around.
  - retentionLength
```
protected UpdateRetentionPolicyByIdRequestBodyRetentionLengthField 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`.
  - status
```
protected String status
```
    Used to retire a retention policy.
    If not retiring a policy, do not include this parameter or set it to `null`.
  - canOwnerExtendRetention
```
protected Boolean canOwnerExtendRetention
```
    Determines if the owner of items under the policy can extend the retention when the original retention duration is about to end.
  - maxExtensionLength
```
protected RetentionPolicyMaxExtensionLengthRequest maxExtensionLength
```
  - areOwnersNotified
```
protected Boolean areOwnersNotified
```
    Determines if owners and co-owners of items under the policy are notified when the retention duration is about to end.
  - customNotificationRecipients
```
protected List<UserBase> customNotificationRecipients
```
    A list of users notified when the retention duration is about to end.
- Constructor Detail
  - UpdateRetentionPolicyByIdRequestBody
```
public UpdateRetentionPolicyByIdRequestBody()
```
  - UpdateRetentionPolicyByIdRequestBody
```
protected UpdateRetentionPolicyByIdRequestBody(UpdateRetentionPolicyByIdRequestBody.Builder builder)
```
- Method Detail
  - getPolicyName
```
public String getPolicyName()
```
  - getDescription
```
public String getDescription()
```
  - getDispositionAction
```
public String getDispositionAction()
```
  - getRetentionType
```
public String getRetentionType()
```
  - getRetentionLength
```
public UpdateRetentionPolicyByIdRequestBodyRetentionLengthField getRetentionLength()
```
  - getStatus
```
public String getStatus()
```
  - getCanOwnerExtendRetention
```
public Boolean getCanOwnerExtendRetention()
```
  - getMaxExtensionLength
```
public RetentionPolicyMaxExtensionLengthRequest getMaxExtensionLength()
```
  - getAreOwnersNotified
```
public Boolean getAreOwnersNotified()
```
  - getCustomNotificationRecipients
```
public List<UserBase> 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

Class UpdateRetentionPolicyByIdRequestBody

Nested Class Summary

Field Summary

Fields inherited from class NullableFieldTracker

Constructor Summary

Method Summary

Methods inherited from class SerializableObject

Methods inherited from class NullableFieldTracker

Methods inherited from class Object

Field Detail

policyName

description

dispositionAction

retentionType

retentionLength

status

canOwnerExtendRetention

maxExtensionLength

areOwnersNotified

customNotificationRecipients

Constructor Detail

UpdateRetentionPolicyByIdRequestBody

UpdateRetentionPolicyByIdRequestBody

Method Detail

getPolicyName

getDescription

getDispositionAction

getRetentionType

getRetentionLength

getStatus

getCanOwnerExtendRetention

getMaxExtensionLength

getAreOwnersNotified

getCustomNotificationRecipients

equals

hashCode

toString