com.box.sdkgen.managers.legalholdpolicies

Class CreateLegalHoldPolicyRequestBody

Object

NullableFieldTracker

SerializableObject

CreateLegalHoldPolicyRequestBody

All Implemented Interfaces:

Serializable

public class CreateLegalHoldPolicyRequestBody
extends SerializableObject

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateLegalHoldPolicyRequestBody.Builder

Field Summary

Fields

Modifier and Type	Field and Description
protected String	description A description for the policy.
protected OffsetDateTime	filterEndedAt The filter end date.
protected OffsetDateTime	filterStartedAt The filter start date.
protected Boolean	isOngoing Whether new assignments under this policy should continue applying to files even after initialization.
protected String	policyName The name of the policy.

Fields inherited from class NullableFieldTracker

explicitlySetNullableFields

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CreateLegalHoldPolicyRequestBody(CreateLegalHoldPolicyRequestBody.Builder builder)
	CreateLegalHoldPolicyRequestBody(String policyName)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getDescription()
OffsetDateTime	getFilterEndedAt()
OffsetDateTime	getFilterStartedAt()
Boolean	getIsOngoing()
String	getPolicyName()
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 of the policy.

description

protected String description

A description for the policy.

filterStartedAt

protected OffsetDateTime filterStartedAt

The filter start date.

When this policy is applied using a `custodian` legal hold assignments, it will only apply to file versions created or uploaded inside of the date range. Other assignment types, such as folders and files, will ignore the date filter.

Required if `is_ongoing` is set to `false`.

filterEndedAt

protected OffsetDateTime filterEndedAt

The filter end date.

When this policy is applied using a `custodian` legal hold assignments, it will only apply to file versions created or uploaded inside of the date range. Other assignment types, such as folders and files, will ignore the date filter.

Required if `is_ongoing` is set to `false`.

isOngoing

protected Boolean isOngoing

Whether new assignments under this policy should continue applying to files even after initialization.

When this policy is applied using a legal hold assignment, it will continue applying the policy to any new file versions even after it has been applied.

For example, if a legal hold assignment is placed on a user today, and that user uploads a file tomorrow, that file will get held. This will continue until the policy is retired.

Required if no filter dates are set.

Constructor Detail

CreateLegalHoldPolicyRequestBody

public CreateLegalHoldPolicyRequestBody(String policyName)

CreateLegalHoldPolicyRequestBody

protected CreateLegalHoldPolicyRequestBody(CreateLegalHoldPolicyRequestBody.Builder builder)

Method Detail

getPolicyName

public String getPolicyName()

getDescription

public String getDescription()

getFilterStartedAt

public OffsetDateTime getFilterStartedAt()

getFilterEndedAt

public OffsetDateTime getFilterEndedAt()

getIsOngoing

public Boolean getIsOngoing()

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