Class CollectSupportDataTaskProperties
- java.lang.Object
-
- com.unboundid.ldap.sdk.unboundidds.tasks.CollectSupportDataTaskProperties
-
- All Implemented Interfaces:
java.io.Serializable
@Mutable @ThreadSafety(level=NOT_THREADSAFE) public final class CollectSupportDataTaskProperties extends java.lang.Object implements java.io.Serializable
This class defines a set of properties that may be used when creating aCollectSupportDataTask
.
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:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description CollectSupportDataTaskProperties()
Creates a new set of collect support data task properties without any of the properties set (so that the server will use default values for all of them).CollectSupportDataTaskProperties(CollectSupportDataTask task)
Creates a new set of collect support data task properties set from the provided task instance.CollectSupportDataTaskProperties(CollectSupportDataTaskProperties properties)
Creates a new set of collect support data task properties as a copy of the provided properties.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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
getComment()
Retrieves an additional comment that should be included in the support data archive.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 on the server filesystem to a file that contains the passphrase to use to encrypt the support data archive.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.lang.Boolean
getIncludeBinaryFiles()
Retrieves the value of a flag that indicates whether the support data archive may include binary files.java.lang.Boolean
getIncludeExpensiveData()
Retrieves the value of a flag that indicates whether the support data archive may include data that is potentially expensive to collect and could affect the performance or responsiveness of the server.java.lang.Boolean
getIncludeExtensionSource()
Retrieves the value of a flag that indicates whether the support data archive should include source code (if available) for any third-party extensions installed in the server.java.lang.Boolean
getIncludeReplicationStateDump()
Retrieves the value of a flag that indicates whether the support data archive may include a replication state dump, which may be several megabytes in size.java.lang.Integer
getJStackCount()
Retrieves the number of times that the jstack utility should be invoked to obtain stack traces from all threads in the server.java.lang.String
getLogDuration()
Retrieves a string representation of the duration (up until the time that the collect support data task is invoked) of log content that should be included in the support data archive.java.lang.Long
getLogDurationMillis()
Retrieves a parsed value of the log duration in milliseconds.java.lang.Integer
getLogFileHeadCollectionSizeKB()
Retrieves the amount of data in kilobytes to capture from the beginning of each log file that should be included in the support data archive.java.lang.Integer
getLogFileTailCollectionSizeKB()
Retrieves the amount of data in kilobytes to capture from the end of each log file that should be included in the support data archive.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.lang.String
getOutputPath()
Retrieves the path on the server filesystem to which the support data archive should be written.java.lang.Integer
getReportCount()
Retrieves the number of intervals that should be captured from tools that use interval-based sampling (e.g., vmstat, iostat, mpstat, etc.).java.lang.Integer
getReportIntervalSeconds()
Retrieves the interval duration in seconds that should be used for tools that use interval-based sampling (e.g., vmstat, iostat, mpstat, etc.).java.lang.String
getRetainPreviousSupportDataArchiveAge()
Retrieves the minimum age of existing support data archives that should be retained.java.lang.Long
getRetainPreviousSupportDataArchiveAgeMillis()
Retrieves a parsed value of the retain previous support data archive age in milliseconds.java.lang.Integer
getRetainPreviousSupportDataArchiveCount()
Retrieves the minimum number of existing support data archives that should be retained.java.util.Date
getScheduledStartTime()
Retrieves the earliest time that the task should be eligible to start running.CollectSupportDataSecurityLevel
getSecurityLevel()
Retrieves the security level that should be used to indicate which data should be obscured, redacted, or omitted from the support data archive.java.lang.String
getTaskID()
Retrieves the task ID that should be used for the task.java.lang.Boolean
getUseSequentialMode()
Retrieves the value of a flag that indicates whether the server should collect items for the support data archive in sequential mode rather than in parallel.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
setComment(java.lang.String comment)
Specifies an additional comment that should be included in the support data archive.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
setEncryptionPassphraseFile(java.lang.String encryptionPassphraseFile)
Specifies the path on the server filesystem to a file that contains the passphrase to use to encrypt the support data archive.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
setIncludeBinaryFiles(java.lang.Boolean includeBinaryFiles)
Specifies the value of a flag that that indicates whether the support data archive may include binary files.void
setIncludeExpensiveData(java.lang.Boolean includeExpensiveData)
Specifies the value of a flag that indicates whether the support data archive may include data that is potentially expensive to collect and could affect the performance or responsiveness of the server.void
setIncludeExtensionSource(java.lang.Boolean includeExtensionSource)
Specifies the value of a flag that indicates whether the support data archive should include source code (if available) for any third-party extensions installed in the server.void
setIncludeReplicationStateDump(java.lang.Boolean includeReplicationStateDump)
Specifies the value of a flag that indicates whether the support data archive may include a replication state dump, which may be several megabytes in size.void
setJStackCount(java.lang.Integer jstackCount)
Specifies the number of times that the jstack utility should be invoked to obtain stack traces from all threads in the server.void
setLogDuration(java.lang.String logDuration)
Specifies the string representation of the duration (up until the time that the collect support data task is invoked) of log content that should be included in the support data archive.void
setLogDurationMillis(java.lang.Long logDurationMillis)
Specifies the duration in milliseconds (up until the time that the collect support data task is invoked) of log content that should be included in the support data archive.void
setLogFileHeadCollectionSizeKB(java.lang.Integer logFileHeadCollectionSizeKB)
Specifies the amount of data in kilobytes to capture from the beginning of each log file that should be included in the support data archive.void
setLogFileTailCollectionSizeKB(java.lang.Integer logFileTailCollectionSizeKB)
Specifies the amount of data in kilobytes to capture from the end of each log file that should be included in the support data archive.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
setOutputPath(java.lang.String outputPath)
Specifies the path on the server filesystem to which the support data ' archive should be written.void
setReportCount(java.lang.Integer reportCount)
Specifies the number of intervals that should be captured form tools that use interval-based sampling (e.g., vmstat, iostat, mpstat, etc.).void
setReportIntervalSeconds(java.lang.Integer reportIntervalSeconds)
Specifies the interval duration in seconds that should be used for tools that use interval-based sampling (e.g., vmstat, iostat, mpstat, etc.).void
setRetainPreviousSupportDataArchiveAge(java.lang.String retainPreviousSupportDataArchiveAge)
Specifies the minimum age of existing support data archives that should be retained.void
setRetainPreviousSupportDataArchiveAgeMillis(java.lang.Long retainPreviousSupportDataArchiveAgeMillis)
Specifies the minimum age in milliseconds of existing support data archives that should be retained.void
setRetainPreviousSupportDataArchiveCount(java.lang.Integer retainPreviousSupportDataArchiveCount)
Specifies the minimum number of existing support data archives that should be retained.void
setScheduledStartTime(java.util.Date scheduledStartTime)
Specifies the earliest time that the task should be eligible to start running.void
setSecurityLevel(CollectSupportDataSecurityLevel securityLevel)
Specifies the security level that should be used to indicate which data should be obscured, redacted, or omitted from the support data archive.void
setTaskID(java.lang.String taskID)
Specifies the task ID that should be used for the task.void
setUseSequentialMode(java.lang.Boolean useSequentialMode)
Specifies the value of a flag that indicates whether the server should collect items for the support data archive in sequential mode rather than in parallel.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
-
CollectSupportDataTaskProperties
public CollectSupportDataTaskProperties()
Creates a new set of collect support data task properties without any of the properties set (so that the server will use default values for all of them).
-
CollectSupportDataTaskProperties
public CollectSupportDataTaskProperties(@NotNull CollectSupportDataTaskProperties properties)
Creates a new set of collect support data task properties as a copy of the provided properties.- Parameters:
properties
- The collect support data task properties to duplicate.
-
CollectSupportDataTaskProperties
public CollectSupportDataTaskProperties(@NotNull CollectSupportDataTask task)
Creates a new set of collect support data task properties set from the provided task instance.- Parameters:
task
- The collect support data task instance from which the properties should be set.
-
-
Method Detail
-
getOutputPath
@Nullable public java.lang.String getOutputPath()
Retrieves the path on the server filesystem to which the support data archive should be written.- Returns:
- The path on the server filesystem to which the support data
archive should be written, or
null
if no value has been specified for the property.
-
setOutputPath
public void setOutputPath(@Nullable java.lang.String outputPath)
Specifies the path on the server filesystem to which the support data ' archive should be written. If this is provided, then the value may be one of the following:- If the path refers to a file that exists, then the file will be overwritten with the new support data archive.
- If the path refers to a directory that exists, then the support data archive will be written into that directory with a name generated by the server.
- If the path refers to a file that does not exist, then its parent directory must exist, and the support data archive will be written with the specified path and name.
- Parameters:
outputPath
- The path on the server filesystem to which the support data archive should be written. It may benull
if the server should choose the path and name for the output file.
-
getEncryptionPassphraseFile
@Nullable public java.lang.String getEncryptionPassphraseFile()
Retrieves the path on the server filesystem to a file that contains the passphrase to use to encrypt the support data archive.- Returns:
- The path on the server filesystem to a file that contains the
passphrase to use to encrypt the support data archive, or
null
if no value has been specified for the property, and the support data archive should not be encrypted.
-
setEncryptionPassphraseFile
public void setEncryptionPassphraseFile(@Nullable java.lang.String encryptionPassphraseFile)
Specifies the path on the server filesystem to a file that contains the passphrase to use to encrypt the support data archive. If this is provided, then this must refer to a file that exists and that contains exactly one line whose entire content is the desired encryption passphrase.- Parameters:
encryptionPassphraseFile
- The path on the server filesystem to a file that contains the passphrase to use to encrypt the support data archive. It may benull
if the support data archive should not be encrypted.
-
getIncludeExpensiveData
@Nullable public java.lang.Boolean getIncludeExpensiveData()
Retrieves the value of a flag that indicates whether the support data archive may include data that is potentially expensive to collect and could affect the performance or responsiveness of the server.- Returns:
- The value of a flag that indicates whether the support data
archive may include data that is potentially expensive to collect,
or
null
if the property should not be specified when the task is created (in which case the server will use a default behavior of excluding expensive data).
-
setIncludeExpensiveData
public void setIncludeExpensiveData(@Nullable java.lang.Boolean includeExpensiveData)
Specifies the value of a flag that indicates whether the support data archive may include data that is potentially expensive to collect and could affect the performance or responsiveness of the server.- Parameters:
includeExpensiveData
- The value of a flag that indicates whether the support data archive may include data that is potentially expensive to collect. It may benull
if the flag should not be specified when the task is created (in which case the server will use a default behavior of excluding expensive data).
-
getIncludeReplicationStateDump
@Nullable public java.lang.Boolean getIncludeReplicationStateDump()
Retrieves the value of a flag that indicates whether the support data archive may include a replication state dump, which may be several megabytes in size.- Returns:
- The value of a flag that indicates whether the support data
archive may include a replication state dump, or
null
if the property should not be specified when the task is created (in which case the server will use a default behavior of excluding the state dump).
-
setIncludeReplicationStateDump
public void setIncludeReplicationStateDump(@Nullable java.lang.Boolean includeReplicationStateDump)
Specifies the value of a flag that indicates whether the support data archive may include a replication state dump, which may be several megabytes in size.- Parameters:
includeReplicationStateDump
- The value of a flag that indicates whether the support data archive may include a replication state dump. It may benull
if the flag should not be specified when the task is created (in which case the server will use a default behavior of excluding the state dump).
-
getIncludeBinaryFiles
@Nullable public java.lang.Boolean getIncludeBinaryFiles()
Retrieves the value of a flag that indicates whether the support data archive may include binary files.- Returns:
- The value of a flag that indicates whether the support data
archive may include binary files, or
null
if the property should not be specified when the task is created (in which case the server will use a default behavior of excluding binary files).
-
setIncludeBinaryFiles
public void setIncludeBinaryFiles(@Nullable java.lang.Boolean includeBinaryFiles)
Specifies the value of a flag that that indicates whether the support data archive may include binary files.- Parameters:
includeBinaryFiles
- The value of a flag that indicates whether the support data archive may include binary files. It may benull
if the property should not be specified when the task is created (in which case the server will use a default behavior of excluding binary files).
-
getIncludeExtensionSource
@Nullable public java.lang.Boolean getIncludeExtensionSource()
Retrieves the value of a flag that indicates whether the support data archive should include source code (if available) for any third-party extensions installed in the server.- Returns:
- The value of a flag that indicates whether the support data
archive should include source code (if available) for any
third-party extensions installed in the server, or
null
if the property should not be specified when the task is created (in which case the server will use a default behavior of excluding extension source code).
-
setIncludeExtensionSource
public void setIncludeExtensionSource(@Nullable java.lang.Boolean includeExtensionSource)
Specifies the value of a flag that indicates whether the support data archive should include source code (if available) for any third-party extensions installed in the server.- Parameters:
includeExtensionSource
- The value of a flag that indicates whether the support data archive should include source code (if available) for any third-party extensions in the server. It may benull
if the property should not be specified when the task is created (in which case the server will use a default behavior of excluding extension source code).
-
getUseSequentialMode
@Nullable public java.lang.Boolean getUseSequentialMode()
Retrieves the value of a flag that indicates whether the server should collect items for the support data archive in sequential mode rather than in parallel. Collecting data in sequential mode may reduce the amount of memory consumed during the collection process, but it will take longer to complete.- Returns:
- The value of a flag that indicates whether the server should
collect items for the support data archive in sequential mode
rather than in parallel, or
null
if the property should not be specified when the task is created (in which case the server will default to capturing data in parallel).
-
setUseSequentialMode
public void setUseSequentialMode(@Nullable java.lang.Boolean useSequentialMode)
Specifies the value of a flag that indicates whether the server should collect items for the support data archive in sequential mode rather than in parallel. Collecting data in sequential mode may reduce the amount of memory consumed during the collection process, but it will take longer to complete.- Parameters:
useSequentialMode
- The value of a flag that indicates whether the server should collect items for the support data archive in sequential mode rather than in parallel. It may benull
if the property should not be specified when the task is created (in which case the server will default to capturing data in parallel).
-
getSecurityLevel
@Nullable public CollectSupportDataSecurityLevel getSecurityLevel()
Retrieves the security level that should be used to indicate which data should be obscured, redacted, or omitted from the support data archive.- Returns:
- The security level that should be used when creating the support
data archive, or
null
if the property should not be specified when the task is created (in which case the server will use a default security level).
-
setSecurityLevel
public void setSecurityLevel(@Nullable CollectSupportDataSecurityLevel securityLevel)
Specifies the security level that should be used to indicate which data should be obscured, redacted, or omitted from the support data archive.- Parameters:
securityLevel
- The security level that should be used when creating the support data archive. It may benull
if the property should not be specified when the task is created (in which case the server will use a default security level).
-
getReportCount
@Nullable public java.lang.Integer getReportCount()
Retrieves the number of intervals that should be captured from tools that use interval-based sampling (e.g., vmstat, iostat, mpstat, etc.).- Returns:
- The number of intervals that should be captured from tools that
use interval-based sampling, or
null
if the property should not be specified when the task is created (in which case the server will use a default report count).
-
setReportCount
public void setReportCount(@Nullable java.lang.Integer reportCount)
Specifies the number of intervals that should be captured form tools that use interval-based sampling (e.g., vmstat, iostat, mpstat, etc.).- Parameters:
reportCount
- The number of intervals that should be captured from tools that use interval-based sampling. The value must not be negative, but it may be zero to indicate that no intervals should be captured. It may benull
if the property should not be specified when the task is created (in which case the server will use a default report count).
-
getReportIntervalSeconds
@Nullable public java.lang.Integer getReportIntervalSeconds()
Retrieves the interval duration in seconds that should be used for tools that use interval-based sampling (e.g., vmstat, iostat, mpstat, etc.).- Returns:
- The interval duration in seconds that should be used for tools
that use interval-based sampling, or
null
if the property should not be specified when the task is created (in which case the server will use a default report interval).
-
setReportIntervalSeconds
public void setReportIntervalSeconds(@Nullable java.lang.Integer reportIntervalSeconds)
Specifies the interval duration in seconds that should be used for tools that use interval-based sampling (e.g., vmstat, iostat, mpstat, etc.).- Parameters:
reportIntervalSeconds
- The interval duration in seconds that should be used for tools that use interval-based sampling. The value must be greater than or equal to one. It may benull
if the property should not be specified when the task is created (in which case the server will use a default report count).
-
getJStackCount
@Nullable public java.lang.Integer getJStackCount()
Retrieves the number of times that the jstack utility should be invoked to obtain stack traces from all threads in the server.- Returns:
- The number of times that the jstack utility should be invoked to
obtain stack traces from all threads in the server, or
null
if the property should not be specified when the task is created (in which case the server will use a default count).
-
setJStackCount
public void setJStackCount(@Nullable java.lang.Integer jstackCount)
Specifies the number of times that the jstack utility should be invoked to obtain stack traces from all threads in the server.- Parameters:
jstackCount
- The number of times that the jstack utility should be invoked to obtain stack traces from all threads in the server. The value must not be negative, but it may be zero to indicate that the jstack utility should not be invoked. It may benull
if the property should not be specified when the task is created (in which case the server will use a default count).
-
getLogDuration
@Nullable public java.lang.String getLogDuration()
Retrieves a string representation of the duration (up until the time that the collect support data task is invoked) of log content that should be included in the support data archive.- Returns:
- A string representation of the duration of log content that should
be included in the support data archive, or
null
if the property should not be specified when the task is created (in which case the server will use a default behavior for selecting the amount of log content to include).
-
getLogDurationMillis
@Nullable public java.lang.Long getLogDurationMillis() throws TaskException
Retrieves a parsed value of the log duration in milliseconds.- Returns:
- A parsed value of the log duration in milliseconds or
null
if no log duration is set. - Throws:
TaskException
- If the log duration value cannot be parsed as a valid duration.
-
setLogDuration
public void setLogDuration(@Nullable java.lang.String logDuration) throws TaskException
Specifies the string representation of the duration (up until the time that the collect support data task is invoked) of log content that should be included in the support data archive.
The string representation of the duration should be specified as an integer followed by a time unit, where the unit may be one of millisecond, second, minute, hour, day, or week (or one of their plurals). For example, "5 minutes" or "1 hour".- Parameters:
logDuration
- The string representation of the duration of log content that should be included in the support data archive. It may benull
if the property should not be specified when the task is created (in which case the server will determine an appropriate amount of log content to include).- Throws:
TaskException
- If the provided string representation cannot be parsed as a valid duration.
-
setLogDurationMillis
public void setLogDurationMillis(@Nullable java.lang.Long logDurationMillis)
Specifies the duration in milliseconds (up until the time that the collect support data task is invoked) of log content that should be included in the support data archive.- Parameters:
logDurationMillis
- The duration in milliseconds of log content that should be included in the support data archive. The value must be greater than zero. It may benull
if the property should not be specified when the task is created (in which case the server will determine an appropriate amount of log content to include).
-
getLogFileHeadCollectionSizeKB
@Nullable public java.lang.Integer getLogFileHeadCollectionSizeKB()
Retrieves the amount of data in kilobytes to capture from the beginning of each log file that should be included in the support data archive.- Returns:
- The amount of data in kilobytes to capture from the beginning of
each log file that should be included in the support data archive,
or
null
if the property should not be specified when the task is created (in which case the server will determine an appropriate amount of log content to include).
-
setLogFileHeadCollectionSizeKB
public void setLogFileHeadCollectionSizeKB(@Nullable java.lang.Integer logFileHeadCollectionSizeKB)
Specifies the amount of data in kilobytes to capture from the beginning of each log file that should be included in the support data archive.- Parameters:
logFileHeadCollectionSizeKB
- The amount of data in kilobytes to capture from the beginning of each log file that should be included in the support data archive. This may benull
if the property should not be specified when the task is created (in which case the server will determine an appropriate amount of log content to include).
-
getLogFileTailCollectionSizeKB
@Nullable public java.lang.Integer getLogFileTailCollectionSizeKB()
Retrieves the amount of data in kilobytes to capture from the end of each log file that should be included in the support data archive.- Returns:
- The amount of data in kilobytes to capture from the end of each
log file that should be included in the support data archive, or
null
if the property should not be specified when the task is created (in which case the server will determine an appropriate amount of log content to include).
-
setLogFileTailCollectionSizeKB
public void setLogFileTailCollectionSizeKB(@Nullable java.lang.Integer logFileTailCollectionSizeKB)
Specifies the amount of data in kilobytes to capture from the end of each log file that should be included in the support data archive.- Parameters:
logFileTailCollectionSizeKB
- The amount of data in kilobytes to capture from the end of each log file that should be included in the support data archive. This may benull
if the property should not be specified when the task is created (in which case the server will determine an appropriate amount of log content to include).
-
getComment
@Nullable public java.lang.String getComment()
Retrieves an additional comment that should be included in the support data archive.- Returns:
- An additional comment that should be included in the support data
archive, or
null
if no comment should be included.
-
setComment
public void setComment(@Nullable java.lang.String comment)
Specifies an additional comment that should be included in the support data archive.- Parameters:
comment
- An additional comment that should be included in the support data archive. It may benull
if no additional comment should be included.
-
getRetainPreviousSupportDataArchiveCount
@Nullable public java.lang.Integer getRetainPreviousSupportDataArchiveCount()
Retrieves the minimum number of existing support data archives that should be retained.- Returns:
- The minimum number of existing support data archives that should
be retained, or
null
if there is no minimum retain count.
-
setRetainPreviousSupportDataArchiveCount
public void setRetainPreviousSupportDataArchiveCount(@Nullable java.lang.Integer retainPreviousSupportDataArchiveCount)
Specifies the minimum number of existing support data archives that should be retained.
Note that if an output path is specified, then a retain count or retain age may only be used if that output path specifies a directory rather than a file, so that the file name will be generated by the server, and only archive files in that directory with names that conform to the server-generated pattern may be removed.
If neither a retain count nor a retain age is specified, then no existing support data archives will be removed. If both are specified, then any existing archive that is outside the criteria for either will be removed.- Parameters:
retainPreviousSupportDataArchiveCount
- The minimum number of existing support data archives that should be retained. A value of zero indicates that only the new support data archive should be retained, and any other preexisting archives may be removed. It may benull
if only the age of existing archives should be considered (if a retain age is specified), or if no existing support data archives should be removed (if no retain age is specified).
-
getRetainPreviousSupportDataArchiveAge
@Nullable public java.lang.String getRetainPreviousSupportDataArchiveAge()
Retrieves the minimum age of existing support data archives that should be retained.- Returns:
- The minimum age of existing support data archives that should
be retained, or
null
if there is no minimum retain age.
-
getRetainPreviousSupportDataArchiveAgeMillis
@Nullable public java.lang.Long getRetainPreviousSupportDataArchiveAgeMillis() throws TaskException
Retrieves a parsed value of the retain previous support data archive age in milliseconds.- Returns:
- A parsed value of the retain previous support data archive age in
milliseconds or
null
if no retain age is set. - Throws:
TaskException
- If the retain age value cannot be parsed as a valid duration.
-
setRetainPreviousSupportDataArchiveAge
public void setRetainPreviousSupportDataArchiveAge(@Nullable java.lang.String retainPreviousSupportDataArchiveAge) throws TaskException
Specifies the minimum age of existing support data archives that should be retained.
The string representation of the duration should be specified as an integer followed by a time unit, where the unit may be one of millisecond, second, minute, hour, day, or week (or one of their plurals). For example, "5 minutes" or "1 hour".
Note that if an output path is specified, then a retain count or retain age may only be used if that output path specifies a directory rather than a file, so that the file name will be generated by the server, and only archive files in that directory with names that conform to the server-generated pattern may be removed.
If neither a retain count nor a retain age is specified, then no existing support data archives will be removed. If both are specified, then any existing archive that is outside the criteria for either will be removed.- Parameters:
retainPreviousSupportDataArchiveAge
- The minimum age of existing support data archives that should be retained. Any existing support data archives that are older than this may be removed. It may benull
if only the number of existing archives should be considered (if a retain count is specified), or if no existing support data archives should be removed (if no retain count is specified).- Throws:
TaskException
- If the provided string representation cannot be parsed as a valid duration.
-
setRetainPreviousSupportDataArchiveAgeMillis
public void setRetainPreviousSupportDataArchiveAgeMillis(@Nullable java.lang.Long retainPreviousSupportDataArchiveAgeMillis)
Specifies the minimum age in milliseconds of existing support data archives that should be retained.
Note that if an output path is specified, then a retain count or retain age may only be used if that output path specifies a directory rather than a file, so that the file name will be generated by the server, and only archive files in that directory with names that conform to the server-generated pattern may be removed.
If neither a retain count nor a retain age is specified, then no existing support data archives will be removed. If both are specified, then any existing archive that is outside the criteria for either will be removed.- Parameters:
retainPreviousSupportDataArchiveAgeMillis
- The minimum age in milliseconds of existing support data archives that should be retained. Any existing support data archives that are older than this may be removed. It may benull
if only the number of existing archives should be considered (if a retain count is specified), or if no existing support data archives should be removed (if no retain count is specified).
-
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.
-
-