com.docusign.esign.model.EnvelopePurgeConfiguration Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of docusign-esign-java Show documentation
The official DocuSign eSignature JAVA client is based on version 2 of the DocuSign REST API and provides libraries for JAVA application integration. It is recommended that you use this version of the library for new development.
There is a newer version: 6.0.0
Show newest version
package com.docusign.esign.model;

import com.fasterxml.jackson.annotation.JsonProperty;
import io.swagger.v3.oas.annotations.media.Schema;
import java.util.Objects;

/**
 * Contains information about the current envelope purge configuration for an account, which enables
 * account administrators to purge documents from completed and voided envelopes after a set number
 * of days (`retentionDays`). .
 */
@Schema(
    description =
        "Contains information about the current envelope purge configuration for an account, which enables account administrators to purge documents from completed and voided envelopes after a set number of days (`retentionDays`). ")
public class EnvelopePurgeConfiguration {
  @JsonProperty("purgeEnvelopes")
  private String purgeEnvelopes = null;

  @JsonProperty("redactPII")
  private String redactPII = null;

  @JsonProperty("removeTabsAndEnvelopeAttachments")
  private String removeTabsAndEnvelopeAttachments = null;

  @JsonProperty("retentionDays")
  private String retentionDays = null;

  /**
   * purgeEnvelopes.
   *
   * @return EnvelopePurgeConfiguration
   */
  public EnvelopePurgeConfiguration purgeEnvelopes(String purgeEnvelopes) {
    this.purgeEnvelopes = purgeEnvelopes;
    return this;
  }

  /**
   * .
   *
   * @return purgeEnvelopes
   */
  @Schema(description = "")
  public String getPurgeEnvelopes() {
    return purgeEnvelopes;
  }

  /** setPurgeEnvelopes. */
  public void setPurgeEnvelopes(String purgeEnvelopes) {
    this.purgeEnvelopes = purgeEnvelopes;
  }

  /**
   * redactPII.
   *
   * @return EnvelopePurgeConfiguration
   */
  public EnvelopePurgeConfiguration redactPII(String redactPII) {
    this.redactPII = redactPII;
    return this;
  }

  /**
   * .
   *
   * @return redactPII
   */
  @Schema(description = "")
  public String getRedactPII() {
    return redactPII;
  }

  /** setRedactPII. */
  public void setRedactPII(String redactPII) {
    this.redactPII = redactPII;
  }

  /**
   * removeTabsAndEnvelopeAttachments.
   *
   * @return EnvelopePurgeConfiguration
   */
  public EnvelopePurgeConfiguration removeTabsAndEnvelopeAttachments(
      String removeTabsAndEnvelopeAttachments) {
    this.removeTabsAndEnvelopeAttachments = removeTabsAndEnvelopeAttachments;
    return this;
  }

  /**
   * .
   *
   * @return removeTabsAndEnvelopeAttachments
   */
  @Schema(description = "")
  public String getRemoveTabsAndEnvelopeAttachments() {
    return removeTabsAndEnvelopeAttachments;
  }

  /** setRemoveTabsAndEnvelopeAttachments. */
  public void setRemoveTabsAndEnvelopeAttachments(String removeTabsAndEnvelopeAttachments) {
    this.removeTabsAndEnvelopeAttachments = removeTabsAndEnvelopeAttachments;
  }

  /**
   * retentionDays.
   *
   * @return EnvelopePurgeConfiguration
   */
  public EnvelopePurgeConfiguration retentionDays(String retentionDays) {
    this.retentionDays = retentionDays;
    return this;
  }

  /**
   * .
   *
   * @return retentionDays
   */
  @Schema(description = "")
  public String getRetentionDays() {
    return retentionDays;
  }

  /** setRetentionDays. */
  public void setRetentionDays(String retentionDays) {
    this.retentionDays = retentionDays;
  }

  /**
   * Compares objects.
   *
   * @return true or false depending on comparison result.
   */
  @Override
  public boolean equals(java.lang.Object o) {
    if (this == o) {
      return true;
    }
    if (o == null || getClass() != o.getClass()) {
      return false;
    }
    EnvelopePurgeConfiguration envelopePurgeConfiguration = (EnvelopePurgeConfiguration) o;
    return Objects.equals(this.purgeEnvelopes, envelopePurgeConfiguration.purgeEnvelopes)
        && Objects.equals(this.redactPII, envelopePurgeConfiguration.redactPII)
        && Objects.equals(
            this.removeTabsAndEnvelopeAttachments,
            envelopePurgeConfiguration.removeTabsAndEnvelopeAttachments)
        && Objects.equals(this.retentionDays, envelopePurgeConfiguration.retentionDays);
  }

  /** Returns the HashCode. */
  @Override
  public int hashCode() {
    return Objects.hash(purgeEnvelopes, redactPII, removeTabsAndEnvelopeAttachments, retentionDays);
  }

  /** Converts the given object to string. */
  @Override
  public String toString() {
    StringBuilder sb = new StringBuilder();
    sb.append("class EnvelopePurgeConfiguration {\n");

    sb.append("    purgeEnvelopes: ").append(toIndentedString(purgeEnvelopes)).append("\n");
    sb.append("    redactPII: ").append(toIndentedString(redactPII)).append("\n");
    sb.append("    removeTabsAndEnvelopeAttachments: ")
        .append(toIndentedString(removeTabsAndEnvelopeAttachments))
        .append("\n");
    sb.append("    retentionDays: ").append(toIndentedString(retentionDays)).append("\n");
    sb.append("}");
    return sb.toString();
  }

  /**
   * Convert the given object to string with each line indented by 4 spaces (except the first line).
   */
  private String toIndentedString(java.lang.Object o) {
    if (o == null) {
      return "null";
    }
    return o.toString().replace("\n", "\n    ");
  }
}