com.cloudera.api.model

Class ApiCollectDiagnosticDataArguments

java.lang.Object

com.cloudera.api.model.ApiCollectDiagnosticDataArguments

public class ApiCollectDiagnosticDataArguments
extends Object

Arguments used for the collectDiagnosticData command.

Constructor Summary

Constructors

Constructor and Description
ApiCollectDiagnosticDataArguments()

Method Summary

Methods

Modifier and Type	Method and Description
long	getBundleSizeBytes() The maximum approximate bundle size of the output file
String	getClusterName() Name of the cluster to collect.
String	getComments() Comments to include with this data collection.
Boolean	getEnableMonitorMetricsCollection() Flag to enable collection of metrics for chart display.
String	getEndTime() The end time (in ISO 8601 format) of the period to collection statistics for.
List<String>	getRoles() List of roles for which to get logs and metrics.
String	getStartTime() This parameter is ignored between CM 4.5 and CM 5.7 versions.
String	getTicketNumber() The support ticket number to attach to this data collection.
boolean	isIncludeInfoLog() Deprecated.
void	setBundleSize(long bundleSizeByte)
void	setClusterName(String clusterName)
void	setComments(String comments)
void	setEnableMonitorMetricsCollection(Boolean enable)
void	setEndTime(String endTime)
void	setIncludeInfoLog(boolean includeInfoLog) Deprecated.
void	setRoles(List<String> roles)
void	setStartTime(String startTime)
void	setTicketNumber(String ticketNumber)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ApiCollectDiagnosticDataArguments

public ApiCollectDiagnosticDataArguments()

Method Detail

getBundleSizeBytes

public long getBundleSizeBytes()

The maximum approximate bundle size of the output file

setBundleSize

public void setBundleSize(long bundleSizeByte)

getStartTime

public String getStartTime()

This parameter is ignored between CM 4.5 and CM 5.7 versions. For versions from CM 4.5 to CM 5.7, use endTime and bundleSizeBytes instead. For CM 5.7+ versions, startTime is an optional parameter that is with endTime and bundleSizeBytes. This was introduced to perform diagnostic data estimation and collection of global diagnostics data for a certain time range. The start time (in ISO 8601 format) of the period to collection statistics for.

setStartTime

public void setStartTime(String startTime)

getEndTime

public String getEndTime()

The end time (in ISO 8601 format) of the period to collection statistics for.

setEndTime

public void setEndTime(String endTime)

isIncludeInfoLog

@Deprecated
public boolean isIncludeInfoLog()

Deprecated.

This parameter is ignored as of CM 4.5. INFO logs are always collected. Whether to include INFO level logs. WARN, ERROR, and FATAL level logs are always included.

setIncludeInfoLog

@Deprecated
public void setIncludeInfoLog(boolean includeInfoLog)

Deprecated.

getTicketNumber

public String getTicketNumber()

The support ticket number to attach to this data collection.

setTicketNumber

public void setTicketNumber(String ticketNumber)

getComments

public String getComments()

Comments to include with this data collection.

setComments

public void setComments(String comments)

getClusterName

public String getClusterName()

Name of the cluster to collect. If null, collects from all clusters.

setClusterName

public void setClusterName(String clusterName)

getEnableMonitorMetricsCollection

public Boolean getEnableMonitorMetricsCollection()

Flag to enable collection of metrics for chart display.

setEnableMonitorMetricsCollection

public void setEnableMonitorMetricsCollection(Boolean enable)

getRoles

public List<String> getRoles()

List of roles for which to get logs and metrics. If set, this restricts the roles for log and metrics collection to the list specified. If empty, the default is to get logs for all roles (in the selected cluster, if one is selected). Introduced in API v10 of the API.

setRoles

public void setRoles(List<String> roles)