Skip to content

retentionpolicies.md

Latest commit

 

History

History
158 lines (95 loc) · 4.29 KB

retentionpolicies.md

File metadata and controls

158 lines (95 loc) · 4.29 KB

RetentionPoliciesManager

List retention policies

Retrieves all of the retention policies for an enterprise.

This operation is performed by calling function getRetentionPolicies.

See the endpoint docs at API Reference.

client.getRetentionPolicies().getRetentionPolicies()

Arguments

  • queryParams GetRetentionPoliciesQueryParams
    • Query parameters of getRetentionPolicies method
  • headers GetRetentionPoliciesHeaders
    • Headers of getRetentionPolicies method

Returns

This function returns a value of type RetentionPolicies.

Returns a list retention policies in the enterprise.

Create retention policy

Creates a retention policy.

This operation is performed by calling function createRetentionPolicy.

See the endpoint docs at API Reference.

client.getRetentionPolicies().createRetentionPolicy(new CreateRetentionPolicyRequestBody.Builder(retentionPolicyName, CreateRetentionPolicyRequestBodyPolicyTypeField.FINITE, CreateRetentionPolicyRequestBodyDispositionActionField.REMOVE_RETENTION).description(retentionDescription).retentionLength("1").retentionType(CreateRetentionPolicyRequestBodyRetentionTypeField.MODIFIABLE).canOwnerExtendRetention(true).areOwnersNotified(true).build())

Arguments

  • requestBody CreateRetentionPolicyRequestBody
    • Request body of createRetentionPolicy method
  • headers CreateRetentionPolicyHeaders
    • Headers of createRetentionPolicy method

Returns

This function returns a value of type RetentionPolicy.

Returns a new retention policy object.

Get retention policy

Retrieves a retention policy.

This operation is performed by calling function getRetentionPolicyById.

See the endpoint docs at API Reference.

client.getRetentionPolicies().getRetentionPolicyById(retentionPolicy.getId())

Arguments

  • retentionPolicyId String
    • The ID of the retention policy. Example: "982312"
  • queryParams GetRetentionPolicyByIdQueryParams
    • Query parameters of getRetentionPolicyById method
  • headers GetRetentionPolicyByIdHeaders
    • Headers of getRetentionPolicyById method

Returns

This function returns a value of type RetentionPolicy.

Returns the retention policy object.

Update retention policy

Updates a retention policy.

This operation is performed by calling function updateRetentionPolicyById.

See the endpoint docs at API Reference.

client.getRetentionPolicies().updateRetentionPolicyById(retentionPolicy.getId(), new UpdateRetentionPolicyByIdRequestBody.Builder().policyName(updatedRetentionPolicyName).build())

Arguments

  • retentionPolicyId String
    • The ID of the retention policy. Example: "982312"
  • requestBody UpdateRetentionPolicyByIdRequestBody
    • Request body of updateRetentionPolicyById method
  • headers UpdateRetentionPolicyByIdHeaders
    • Headers of updateRetentionPolicyById method

Returns

This function returns a value of type RetentionPolicy.

Returns the updated retention policy object.

Delete retention policy

Permanently deletes a retention policy.

This operation is performed by calling function deleteRetentionPolicyById.

See the endpoint docs at API Reference.

client.getRetentionPolicies().deleteRetentionPolicyById(retentionPolicy.getId())

Arguments

  • retentionPolicyId String
    • The ID of the retention policy. Example: "982312"
  • headers DeleteRetentionPolicyByIdHeaders
    • Headers of deleteRetentionPolicyById method

Returns

This function returns a value of type void.

Returns an empty response when the policy has been deleted.