This repository was archived by the owner on Jul 20, 2024. It is now read-only.
forked from splunk/splunk-sdk-java
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathJobSummaryArgs.java
More file actions
122 lines (109 loc) · 3.76 KB
/
JobSummaryArgs.java
File metadata and controls
122 lines (109 loc) · 3.76 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
/*
* Copyright 2012 Splunk, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License"): you may
* not use this file except in compliance with the License. You may obtain
* a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*/
package com.splunk;
/**
* The {@code JobSummaryArgs} class contains arguments for getting a job summary
* using the {@link Job#getSummary} method.
*/
public class JobSummaryArgs extends Args {
/**
* Class constructor.
*/
public JobSummaryArgs() { super(); }
/* BEGIN AUTOGENERATED CODE */
/**
* Specifies the earliest time in the time range to search. The time string can be a UTC time (with fractional seconds), a relative time specifier (to now), or a formatted time string.
*
* @param earliestTime
* The earliest time.
*/
public void setEarliestTime(String earliestTime) {
this.put("earliest_time", earliestTime);
}
/**
* Sets a list of fields to return for the event set.
*
* @param fieldList
* A list of fields.
*/
public void setFieldList(String[] fieldList) {
this.put("f", fieldList);
}
/**
* Indicates whether to add histogram data to the summary output.
*
* @param histogram
* {@code true} to add histogram data, {@code false} if not.
*/
public void setHistogram(boolean histogram) {
this.put("histogram", histogram);
}
/**
* Specifies the latest time in the time range to search. The time string can be a UTC time (with fractional seconds), a relative time specifier (to now), or a formatted time string.
*
* @param latestTime
* The latest time.
*/
public void setLatestTime(String latestTime) {
this.put("latest_time", latestTime);
}
/**
* Sets the fraction of results for each key that this key must occur in to be displayed.
*
* @param minimumFrequency
* The frequency, as a fraction (a value between 0 and 1).
*/
public void setMinimumFrequency(double minimumFrequency) {
this.put("min_freq", minimumFrequency);
}
/**
* Sets a UTC time format.
*
* @param outputTimeFormat
* A UTC time format.
*/
public void setOutputTimeFormat(String outputTimeFormat) {
this.put("output_time_format", outputTimeFormat);
}
/**
* Sets a search query to filter the response. The response matches field values against the search query. For example, "foo" matches any object that has "foo" as a substring in a field, and "field_name=field_value" restricts the match to a single field.
*
* @param search
* A search substring.
*/
public void setSearch(String search) {
this.put("search", search);
}
/**
* Specifies an expression to convert a formatted time string from {start,end}_time into UTC seconds. The default format is "%m/%d/%Y:%H:%M:%S".
*
* @param timeFormat
* The time format.
*/
public void setTimeFormat(String timeFormat) {
this.put("time_format", timeFormat);
}
/**
* Sets for each key how many of the most frequent items to return.
*
* @param topCount
* The number of items to return.
*/
public void setTopCount(int topCount) {
this.put("top_count", topCount);
}
/* END AUTOGENERATED CODE */
}