Class ExportTaskProperties
- java.lang.Object
-
- com.unboundid.ldap.sdk.unboundidds.tasks.ExportTaskProperties
-
@Mutable @ThreadSafety(level=NOT_THREADSAFE) public final class ExportTaskProperties extends java.lang.Object
This class defines a set of properties that may be used in conjunction with an LDIF export administrative task.
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.
-
-
Constructor Summary
Constructors Constructor Description ExportTaskProperties(ExportTask task)
Creates a new set of export task properties from the settings for the provided task.ExportTaskProperties(ExportTaskProperties properties)
Creates a new set of export task properties as a copy of the provided set of properties.ExportTaskProperties(java.lang.String backendID, java.lang.String ldifFile)
Creates a new set of export task properties without default values for all properties except those specified.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
appendToLDIF()
Indicates whether to append to an existing LDIF file rather than overwriting it.boolean
compress()
Indicates whether the LDIF file should be compressed.boolean
encrypt()
Indicates whether the LDIF file should be encrypted.java.lang.Boolean
getAlertOnError()
Retrieves the flag that indicates whether the server should send an administrative alert notification if the task does not complete successfully.java.lang.Boolean
getAlertOnStart()
Retrieves the flag that indicates whether the server should send an administrative alert notification when the task starts running.java.lang.Boolean
getAlertOnSuccess()
Retrieves the flag that indicates whether the server should send an administrative alert notification if the task completes successfully.java.lang.String
getBackendID()
Retrieves the backend ID of the backend to be exported.java.util.List<java.lang.String>
getDependencyIDs()
Retrieves the task IDs for any tasks that must complete before the new collect support data task will be eligible to start running.java.lang.String
getEncryptionPassphraseFile()
Retrieves the path to a file containing the passphrase to use to generate the encryption key.java.lang.String
getEncryptionSettingsDefinitionID()
Retrieves the ID of the encryption settings definition to use to generate the encryption key.java.util.List<java.lang.String>
getExcludeAttributes()
Retrieves the names of the attributes to exclude from the exported entries.java.util.List<java.lang.String>
getExcludeBranches()
Retrieves the set of base DNs for the subtrees to exclude from the export.java.util.List<java.lang.String>
getExcludeFilters()
Retrieves a set of filter strings to use to identify entries to exclude from the export.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.java.util.List<java.lang.String>
getIncludeAttributes()
Retrieves the names of the attributes to include in the exported entries.java.util.List<java.lang.String>
getIncludeBranches()
Retrieves the set of base DNs for the subtrees to include in the export.java.util.List<java.lang.String>
getIncludeFilters()
Retrieves a set of filter strings to use to identify entries to include in the export.java.lang.String
getLDIFFile()
Retrieves the path to the LDIF file to be written.java.lang.Integer
getMaxMegabytesPerSecond()
Retrieves the maximum rate at which the LDIF file should be written, in megabytes per second.java.util.List<java.lang.String>
getNotifyOnCompletion()
Retrieves the addresses to email whenever the task completes, regardless of its success or failure.java.util.List<java.lang.String>
getNotifyOnError()
Retrieves the addresses to email if the task does not complete successfully.java.util.List<java.lang.String>
getNotifyOnStart()
Retrieves the addresses to email whenever the task starts running.java.util.List<java.lang.String>
getNotifyOnSuccess()
Retrieves the addresses to email if the task completes successfully.java.util.List<java.lang.String>
getPostExportTaskProcessors()
Retrieves a list containing the names or DNs of any post-LDIF-export task processors that should be invoked for the export.java.util.Date
getScheduledStartTime()
Retrieves the earliest time that the task should be eligible to start running.java.lang.String
getTaskID()
Retrieves the task ID that should be used for the task.int
getWrapColumn()
Retrieves the column at which long lines should be wrapped.void
setAlertOnError(java.lang.Boolean alertOnError)
Specifies the flag that indicates whether the server should send an administrative alert notification if the task does not complete successfully.void
setAlertOnStart(java.lang.Boolean alertOnStart)
Specifies the flag that indicates whether the server should send an administrative alert notification when the task starts running.void
setAlertOnSuccess(java.lang.Boolean alertOnSuccess)
Specifies the flag that indicates whether the server should send an administrative alert notification if the task completes successfully.void
setAppendToLDIF(boolean appendToLDIF)
Specifies whether to append to an existing LDIF file rather than overwriting it.void
setBackendID(java.lang.String backendID)
Specifies the backend ID of the backend to be exported.void
setCompress(boolean compress)
Specifies whether the LDIF file should be compressed.void
setDependencyIDs(java.util.List<java.lang.String> dependencyIDs)
Specifies the task IDs for any tasks that must complete before the new collect support data task will be eligible to start running.void
setEncrypt(boolean encrypt)
Specifies whether the LDIF file should be encrypted.void
setEncryptionPassphraseFile(java.lang.String encryptionPassphraseFile)
Specifies the path to a file containing the passphrase to use to generate the encryption key.void
setEncryptionSettingsDefinitionID(java.lang.String encryptionSettingsDefinitionID)
Specifies the ID of the encryption settings definition to use to generate the encryption key.void
setExcludeAttributes(java.util.List<java.lang.String> excludeAttributes)
Specifies the names of the attributes to exclude from the exported entries.void
setExcludeBranches(java.util.List<java.lang.String> excludeBranches)
Specifies the set of base DNs for the subtrees to exclude from the export.void
setExcludeFilters(java.util.List<java.lang.String> excludeFilters)
Specifies a set of filter strings to use to identify entries to exclude from the export.void
setFailedDependencyAction(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.void
setIncludeAttributes(java.util.List<java.lang.String> includeAttributes)
Specifies the names of the attributes to include in the exported entries.void
setIncludeBranches(java.util.List<java.lang.String> includeBranches)
Specifies the set of base DNs for the subtrees to include in the export.void
setIncludeFilters(java.util.List<java.lang.String> includeFilters)
Specifies a set of filter strings to use to identify entries to include in the export.void
setLDIFFile(java.lang.String ldifFile)
Specifies the path to the LDIF file to be written.void
setMaxMegabytesPerSecond(java.lang.Integer maxMegabytesPerSecond)
Specifies the maximum rate at which the LDIF file should be written, in megabytes per second.void
setNotifyOnCompletion(java.util.List<java.lang.String> notifyOnCompletion)
Specifies the addresses to email whenever the task completes, regardless of its success or failure.void
setNotifyOnError(java.util.List<java.lang.String> notifyOnError)
Specifies the addresses to email if the task does not complete successfully.void
setNotifyOnStart(java.util.List<java.lang.String> notifyOnStart)
Specifies the addresses to email whenever the task starts running.void
setNotifyOnSuccess(java.util.List<java.lang.String> notifyOnSuccess)
Specifies the addresses to email if the task completes successfully.void
setPostExportTaskProcessors(java.util.List<java.lang.String> postExportTaskProcessors)
Specifies a list containing the names or DNs of any post-LDIF-export task processors that should be invoked for the export.void
setScheduledStartTime(java.util.Date scheduledStartTime)
Specifies the earliest time that the task should be eligible to start running.void
setSign(boolean sign)
Specifies whether the LDIF file should be cryptographically signed.void
setTaskID(java.lang.String taskID)
Specifies the task ID that should be used for the task.void
setWrapColumn(int wrapColumn)
Specifies the column at which long lines should be wrapped.boolean
sign()
Indicates whether the LDIF file should be cryptographically signed.java.lang.String
toString()
Retrieves a string representation of this collect support data task properties object.void
toString(java.lang.StringBuilder buffer)
Appends a string representation of this collect support data task properties object to the provided buffer.
-
-
-
Constructor Detail
-
ExportTaskProperties
public ExportTaskProperties(@NotNull java.lang.String backendID, @NotNull java.lang.String ldifFile)
Creates a new set of export task properties without default values for all properties except those specified.- Parameters:
backendID
- The backend ID of the backend containing the data to export. It must not benull
.ldifFile
- The path to the LDIF file to create. It may be an absolute path or a path relative to the server install root. It must not benull
.
-
ExportTaskProperties
public ExportTaskProperties(@NotNull ExportTaskProperties properties)
Creates a new set of export task properties as a copy of the provided set of properties.- Parameters:
properties
- The export task properties that should be used to create the new export task properties object. It must not benull
.
-
ExportTaskProperties
public ExportTaskProperties(@NotNull ExportTask task)
Creates a new set of export task properties from the settings for the provided task.- Parameters:
task
- The export task to use to create the task properties.
-
-
Method Detail
-
getBackendID
@NotNull public java.lang.String getBackendID()
Retrieves the backend ID of the backend to be exported.- Returns:
- The backend ID of the backend to be exported.
-
setBackendID
public void setBackendID(@NotNull java.lang.String backendID)
Specifies the backend ID of the backend to be exported.- Parameters:
backendID
- The backend ID of the backend to be exported. It must not benull
.
-
getLDIFFile
@NotNull public java.lang.String getLDIFFile()
Retrieves the path to the LDIF file to be written.- Returns:
- The path to the LDIF file to be written.
-
setLDIFFile
public void setLDIFFile(@NotNull java.lang.String ldifFile)
Specifies the path to the LDIF file to be written.- Parameters:
ldifFile
- The path to the LDIF file to be written. It may be an absolute path or one that is relative to the server root. It must not benull
.
-
appendToLDIF
public boolean appendToLDIF()
Indicates whether to append to an existing LDIF file rather than overwriting it.- Returns:
true
if the export should append to an existing LDIF file, orfalse
if the existing file should be overwritten.
-
setAppendToLDIF
public void setAppendToLDIF(boolean appendToLDIF)
Specifies whether to append to an existing LDIF file rather than overwriting it.- Parameters:
appendToLDIF
- Indicates whether to append to an existing LDIF file rather than overwriting it.
-
getIncludeBranches
@NotNull public java.util.List<java.lang.String> getIncludeBranches()
Retrieves the set of base DNs for the subtrees to include in the export.- Returns:
- The set of base DNs for the subtrees to include in the export, or an empty list if no include base DNs should be specified.
-
setIncludeBranches
public void setIncludeBranches(@Nullable java.util.List<java.lang.String> includeBranches)
Specifies the set of base DNs for the subtrees to include in the export.- Parameters:
includeBranches
- The set of base DNs for the subtrees to include in the export. It may benull
or empty if no include branches should be specified.
-
getExcludeBranches
@NotNull public java.util.List<java.lang.String> getExcludeBranches()
Retrieves the set of base DNs for the subtrees to exclude from the export.- Returns:
- The set of base DNs for the subtrees to exclude from the export, or an empty list if no exclude base DNs should be specified.
-
setExcludeBranches
public void setExcludeBranches(@Nullable java.util.List<java.lang.String> excludeBranches)
Specifies the set of base DNs for the subtrees to exclude from the export.- Parameters:
excludeBranches
- The set of base DNs for the subtrees to exclude from the export. It may benull
or empty if no exclude branches should be specified.
-
getIncludeFilters
@NotNull public java.util.List<java.lang.String> getIncludeFilters()
Retrieves a set of filter strings to use to identify entries to include in the export.- Returns:
- A set of filter strings to use to identify entries to include in the export, or an empty list if no include filters should be specified.
-
setIncludeFilters
public void setIncludeFilters(@Nullable java.util.List<java.lang.String> includeFilters)
Specifies a set of filter strings to use to identify entries to include in the export.- Parameters:
includeFilters
- A set of filter strings to use to identify entries to include in the export. It may benull
or empty if no include filters should be specified.
-
getExcludeFilters
@NotNull public java.util.List<java.lang.String> getExcludeFilters()
Retrieves a set of filter strings to use to identify entries to exclude from the export.- Returns:
- A set of filter strings to use to identify entries to exclude from the export, or an empty list if no exclude filters should be specified.
-
setExcludeFilters
public void setExcludeFilters(@Nullable java.util.List<java.lang.String> excludeFilters)
Specifies a set of filter strings to use to identify entries to exclude from the export.- Parameters:
excludeFilters
- A set of filter strings to use to identify entries to exclude from the export. It may benull
or empty if no exclude filters should be specified.
-
getIncludeAttributes
@NotNull public java.util.List<java.lang.String> getIncludeAttributes()
Retrieves the names of the attributes to include in the exported entries.- Returns:
- The names of the attributes to include in the exported entries, or an empty list if no include attributes should be specified.
-
setIncludeAttributes
public void setIncludeAttributes(@Nullable java.util.List<java.lang.String> includeAttributes)
Specifies the names of the attributes to include in the exported entries.- Parameters:
includeAttributes
- The names of the attributes to include in the exported entries. It may benull
or empty if no include attributes should be specified.
-
getExcludeAttributes
@NotNull public java.util.List<java.lang.String> getExcludeAttributes()
Retrieves the names of the attributes to exclude from the exported entries.- Returns:
- The names of the attributes to exclude from the exported entries, or an empty list if no exclude attributes should be specified.
-
setExcludeAttributes
public void setExcludeAttributes(@Nullable java.util.List<java.lang.String> excludeAttributes)
Specifies the names of the attributes to exclude from the exported entries.- Parameters:
excludeAttributes
- The names of the attributes to exclude from the exported entries. It may benull
or empty if no exclude attributes should be specified.
-
getWrapColumn
public int getWrapColumn()
Retrieves the column at which long lines should be wrapped.- Returns:
- The column at which long lines should be wrapped, or -1 if long lines should not be wrapped.
-
setWrapColumn
public void setWrapColumn(int wrapColumn)
Specifies the column at which long lines should be wrapped.- Parameters:
wrapColumn
- The column at which long lines should be wrapped. It may be less than or equal to zero if long lines should not be wrapped.
-
compress
public boolean compress()
Indicates whether the LDIF file should be compressed.- Returns:
true
if the LDIF file should be compressed, orfalse
if not.
-
setCompress
public void setCompress(boolean compress)
Specifies whether the LDIF file should be compressed.- Parameters:
compress
- Indicates whether the LDIF file should be compressed.
-
encrypt
public boolean encrypt()
Indicates whether the LDIF file should be encrypted.- Returns:
true
if the LDIF file should be encrypted, orfalse
if not.
-
setEncrypt
public void setEncrypt(boolean encrypt)
Specifies whether the LDIF file should be encrypted.- Parameters:
encrypt
- Indicates whether the LDIF file should be encrypted.
-
getEncryptionPassphraseFile
@Nullable public java.lang.String getEncryptionPassphraseFile()
Retrieves the path to a file containing the passphrase to use to generate the encryption key.- Returns:
- The path to a file containing the passphrase to use to generate
the encryption key, or
null
if the LDIF file should not be encrypted or if it should be encrypted with a key obtained through some other means.
-
setEncryptionPassphraseFile
public void setEncryptionPassphraseFile(@Nullable java.lang.String encryptionPassphraseFile)
Specifies the path to a file containing the passphrase to use to generate the encryption key.- Parameters:
encryptionPassphraseFile
- The path to a file containing the passphrase to use to generate the encryption key. It may benull
if the LDIF file should not be encrypted or if it should be encrypted with a key obtained through some other means.
-
getEncryptionSettingsDefinitionID
@Nullable public java.lang.String getEncryptionSettingsDefinitionID()
Retrieves the ID of the encryption settings definition to use to generate the encryption key.- Returns:
- The ID of the encryption settings definition to use to generate
the encryption key, or
null
if the LDIF file should not be encrypted, if it should be encrypted with the server's preferred encryption settings definition, or if it should be encrypted with a key obtained through some other means.
-
setEncryptionSettingsDefinitionID
public void setEncryptionSettingsDefinitionID(@Nullable java.lang.String encryptionSettingsDefinitionID)
Specifies the ID of the encryption settings definition to use to generate the encryption key.- Parameters:
encryptionSettingsDefinitionID
- The ID of the encryption settings definition to use to generate the encryption key. It may benull
if the LDIF file should not be encrypted, if it should be encrypted with the server's preferred encryption settings definition, or if it should be encrypted with a key obtained through some other means.
-
sign
public boolean sign()
Indicates whether the LDIF file should be cryptographically signed.- Returns:
true
if the LDIF file should be cryptographically signed, orfalse
if not.
-
setSign
public void setSign(boolean sign)
Specifies whether the LDIF file should be cryptographically signed.- Parameters:
sign
- Indicates whether the LDIF file should be cryptographically signed.
-
getMaxMegabytesPerSecond
@Nullable public java.lang.Integer getMaxMegabytesPerSecond()
Retrieves the maximum rate at which the LDIF file should be written, in megabytes per second.- Returns:
- The maximum rate at which the LDIF file should be written, in
megabytes per second, or
null
if no rate limiting should be used.
-
setMaxMegabytesPerSecond
public void setMaxMegabytesPerSecond(@Nullable java.lang.Integer maxMegabytesPerSecond)
Specifies the maximum rate at which the LDIF file should be written, in megabytes per second.- Parameters:
maxMegabytesPerSecond
- The maximum rate at which the LDIF file should be written, in megabytes per second. A value ofnull
, or one that is less than or equal to zero, indicates that no rate limiting should be used.
-
getPostExportTaskProcessors
@NotNull public java.util.List<java.lang.String> getPostExportTaskProcessors()
Retrieves a list containing the names or DNs of any post-LDIF-export task processors that should be invoked for the export.- Returns:
- A list containing the names or DNs of any post-LDIF-export task processors that should be invoked for the export.
-
setPostExportTaskProcessors
public void setPostExportTaskProcessors(@Nullable java.util.List<java.lang.String> postExportTaskProcessors)
Specifies a list containing the names or DNs of any post-LDIF-export task processors that should be invoked for the export.- Parameters:
postExportTaskProcessors
- A list containing the names or DNs of any post-LDIF-export task processors that should be invoked for the export. It may benull
or empty if no post-LDIF-export task processors should be invoked.
-
getTaskID
@Nullable public java.lang.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 java.lang.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 benull
if a random UUID should be generated for use as the task ID.
-
getScheduledStartTime
@Nullable public java.util.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 java.util.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 benull
if the task should be eligible to start immediately (or as soon as all of its dependencies have been satisfied).
-
getDependencyIDs
@NotNull public java.util.List<java.lang.String> getDependencyIDs()
Retrieves the task IDs for any tasks that must complete before the new collect support data task will be eligible to start running.- Returns:
- The task IDs for any tasks that must complete before the new collect support data 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 java.util.List<java.lang.String> dependencyIDs)
Specifies the task IDs for any tasks that must complete before the new collect support data task will be eligible to start running.- Parameters:
dependencyIDs
- The task IDs for any tasks that must complete before the new collect support data task will be eligible to start running. It may benull
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 benull
if the property should not be specified when creating the task (and the server should choose an appropriate failed dependency action).
-
getNotifyOnStart
@NotNull public java.util.List<java.lang.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 java.util.List<java.lang.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 benull
or empty if no email notification should be sent when starting the task.
-
getNotifyOnCompletion
@NotNull public java.util.List<java.lang.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 java.util.List<java.lang.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 benull
or empty if no email notification should be sent when the task completes.
-
getNotifyOnSuccess
@NotNull public java.util.List<java.lang.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 java.util.List<java.lang.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 benull
or empty if no email notification should be sent on successful completion.
-
getNotifyOnError
@NotNull public java.util.List<java.lang.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 java.util.List<java.lang.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 benull
or empty if no email notification should be sent on an unsuccessful completion.
-
getAlertOnStart
@Nullable public java.lang.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 java.lang.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 benull
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 java.lang.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 java.lang.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 benull
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 java.lang.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 java.lang.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 benull
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 java.lang.String toString()
Retrieves a string representation of this collect support data task properties object.- Overrides:
toString
in classjava.lang.Object
- Returns:
- A string representation of this collect support data task properties object.
-
-