Package com.unboundid.ldap.sdk.unboundidds.tasks

Class RemoveAttributeTypeTaskProperties

java.lang.Object
com.unboundid.ldap.sdk.unboundidds.tasks.RemoveAttributeTypeTaskProperties
All Implemented Interfaces:
Serializable
@Mutable @ThreadSafety(level=NOT_THREADSAFE) public final class RemoveAttributeTypeTaskProperties extends Object implements Serializable
This class defines a set of properties that may be used when creating a RemoveAttributeTypeTask.
NOTE: This class, and other classes within the com.unboundid.ldap.sdk.unboundidds package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.
See Also:

  • Constructor Details

    • RemoveAttributeTypeTaskProperties

      public RemoveAttributeTypeTaskProperties(@NotNull String attributeType)
      Creates a new set of remove attribute type task properties. It will use default values for all general task properties.
      Parameters:
      attributeType - The name or OID of the attribute type to remove from the server schema.

    • RemoveAttributeTypeTaskProperties

      public RemoveAttributeTypeTaskProperties(@NotNull RemoveAttributeTypeTaskProperties properties)
      Creates a new set of remove attribute type task properties as a copy of the provided properties.
      Parameters:
      properties - The remove attribute type task properties to duplicate.

    • RemoveAttributeTypeTaskProperties

      public RemoveAttributeTypeTaskProperties(@NotNull RemoveAttributeTypeTask task)
      Creates a new set of remove attribute type task properties set from the provided task instance.
      Parameters:
      task - The remove attribute type task instance from which the properties should be set.

  • Method Details

    • getAttributeType

      @NotNull public String getAttributeType()
      Retrieves the name or OID of the attribute type to remove from the server schema.
      Returns:
      The name or OID of the attribute type to remove from the server schema.

    • setAttributeType

      public void setAttributeType(@NotNull String attributeType)
      Specifies the name or OID of the attribute type to remove from the server schema.
      Parameters:
      attributeType - The name or OID of the attribute type to remove from the server schema.

    • getTaskID

      @Nullable public String getTaskID()
      Retrieves the task ID that should be used for the task.
      Returns:
      The task ID that should be used for the task, or null if a random UUID should be generated for use as the task ID.

    • setTaskID

      public void setTaskID(@Nullable String taskID)
      Specifies the task ID that should be used for the task.
      Parameters:
      taskID - The task ID that should be used for the task. It may be null if a random UUID should be generated for use as the task ID.

    • getScheduledStartTime

      @Nullable public Date getScheduledStartTime()
      Retrieves the earliest time that the task should be eligible to start running.
      Returns:
      The earliest time that the task should be eligible to start running, or null if the task should be eligible to start immediately (or as soon as all of its dependencies have been satisfied).

    • setScheduledStartTime

      public void setScheduledStartTime(@Nullable Date scheduledStartTime)
      Specifies the earliest time that the task should be eligible to start running.
      Parameters:
      scheduledStartTime - The earliest time that the task should be eligible to start running. It may be null if the task should be eligible to start immediately (or as soon as all of its dependencies have been satisfied).

    • getDependencyIDs

      @NotNull public List<String> getDependencyIDs()
      Retrieves the task IDs for any tasks that must complete before the new remove attribute type task will be eligible to start running.
      Returns:
      The task IDs for any tasks that must complete before the new remove attribute type task will be eligible to start running, or an empty list if the new task should not depend on any other tasks.

    • setDependencyIDs

      public void setDependencyIDs(@Nullable List<String> dependencyIDs)
      Specifies the task IDs for any tasks that must complete before the new remove attribute type task will be eligible to start running.
      Parameters:
      dependencyIDs - The task IDs for any tasks that must complete before the new remove attribute type task will be eligible to start running. It may be null or empty if the new task should not depend on any other tasks.

    • getFailedDependencyAction

      @Nullable public FailedDependencyAction getFailedDependencyAction()
      Retrieves the action that the server should take if any of the tasks on which the new task depends did not complete successfully.
      Returns:
      The action that the server should take if any of the tasks on which the new task depends did not complete successfully, or null if the property should not be specified when creating the task (and the server should choose an appropriate failed dependency action).

    • setFailedDependencyAction

      public void setFailedDependencyAction(@Nullable FailedDependencyAction failedDependencyAction)
      Specifies the action that the server should take if any of the tasks on which the new task depends did not complete successfully.
      Parameters:
      failedDependencyAction - The action that the server should take if any of the tasks on which the new task depends did not complete successfully. It may be null if the property should not be specified when creating the task (and the server should choose an appropriate failed dependency action).

    • getNotifyOnStart

      @NotNull public List<String> getNotifyOnStart()
      Retrieves the addresses to email whenever the task starts running.
      Returns:
      The addresses to email whenever the task starts running, or an empty list if no email notification should be sent when starting the task.

    • setNotifyOnStart

      public void setNotifyOnStart(@Nullable List<String> notifyOnStart)
      Specifies the addresses to email whenever the task starts running.
      Parameters:
      notifyOnStart - The addresses to email whenever the task starts running. It amy be null or empty if no email notification should be sent when starting the task.

    • getNotifyOnCompletion

      @NotNull public List<String> getNotifyOnCompletion()
      Retrieves the addresses to email whenever the task completes, regardless of its success or failure.
      Returns:
      The addresses to email whenever the task completes, or an empty list if no email notification should be sent when the task completes.

    • setNotifyOnCompletion

      public void setNotifyOnCompletion(@Nullable List<String> notifyOnCompletion)
      Specifies the addresses to email whenever the task completes, regardless of its success or failure.
      Parameters:
      notifyOnCompletion - The addresses to email whenever the task completes. It amy be null or empty if no email notification should be sent when the task completes.

    • getNotifyOnSuccess

      @NotNull public List<String> getNotifyOnSuccess()
      Retrieves the addresses to email if the task completes successfully.
      Returns:
      The addresses to email if the task completes successfully, or an empty list if no email notification should be sent on successful completion.

    • setNotifyOnSuccess

      public void setNotifyOnSuccess(@Nullable List<String> notifyOnSuccess)
      Specifies the addresses to email if the task completes successfully.
      Parameters:
      notifyOnSuccess - The addresses to email if the task completes successfully. It amy be null or empty if no email notification should be sent on successful completion.

    • getNotifyOnError

      @NotNull public List<String> getNotifyOnError()
      Retrieves the addresses to email if the task does not complete successfully.
      Returns:
      The addresses to email if the task does not complete successfully, or an empty list if no email notification should be sent on an unsuccessful completion.

    • setNotifyOnError

      public void setNotifyOnError(@Nullable List<String> notifyOnError)
      Specifies the addresses to email if the task does not complete successfully.
      Parameters:
      notifyOnError - The addresses to email if the task does not complete successfully. It amy be null or empty if no email notification should be sent on an unsuccessful completion.

    • getAlertOnStart

      @Nullable public Boolean getAlertOnStart()
      Retrieves the flag that indicates whether the server should send an administrative alert notification when the task starts running.
      Returns:
      The flag that indicates whether the server should send an administrative alert notification when the task starts running, or null if the property should not be specified when the task is created (and the server will default to not sending any alert).

    • setAlertOnStart

      public void setAlertOnStart(@Nullable Boolean alertOnStart)
      Specifies the flag that indicates whether the server should send an administrative alert notification when the task starts running.
      Parameters:
      alertOnStart - The flag that indicates whether the server should send an administrative alert notification when the task starts running, It may be null if the property should not be specified when the task is created (and the server will default to not sending any alert).

    • getAlertOnSuccess

      @Nullable public Boolean getAlertOnSuccess()
      Retrieves the flag that indicates whether the server should send an administrative alert notification if the task completes successfully.
      Returns:
      The flag that indicates whether the server should send an administrative alert notification if the task completes successfully, or null if the property should not be specified when the task is created (and the server will default to not sending any alert).

    • setAlertOnSuccess

      public void setAlertOnSuccess(@Nullable Boolean alertOnSuccess)
      Specifies the flag that indicates whether the server should send an administrative alert notification if the task completes successfully.
      Parameters:
      alertOnSuccess - The flag that indicates whether the server should send an administrative alert notification if the task completes successfully, It may be null if the property should not be specified when the task is created (and the server will default to not sending any alert).

    • getAlertOnError

      @Nullable public Boolean getAlertOnError()
      Retrieves the flag that indicates whether the server should send an administrative alert notification if the task does not complete successfully.
      Returns:
      The flag that indicates whether the server should send an administrative alert notification if the task does not complete successfully, or null if the property should not be specified when the task is created (and the server will default to not sending any alert).

    • setAlertOnError

      public void setAlertOnError(@Nullable Boolean alertOnError)
      Specifies the flag that indicates whether the server should send an administrative alert notification if the task does not complete successfully.
      Parameters:
      alertOnError - The flag that indicates whether the server should send an administrative alert notification if the task does not complete successfully, It may be null if the property should not be specified when the task is created (and the server will default to not sending any alert).

    • toString

      @NotNull public String toString()
      Retrieves a string representation of this remove attribute type task properties object.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this remove attribute type task properties object.

    • toString

      public void toString(@NotNull StringBuilder buffer)
      Appends a string representation of this remove attribute type task properties object to the provided buffer.
      Parameters:
      buffer - The buffer to which the string representation will be appended. It must not be null.