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 pathJobResultsArgs.java
More file actions
116 lines (102 loc) · 3.32 KB
/
JobResultsArgs.java
File metadata and controls
116 lines (102 loc) · 3.32 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
/*
* 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 JobResultsArgs} class contains arguments for getting job results
* using the {@link Job#getResults} method.
*/
public class JobResultsArgs extends Args {
/**
* Specifies the format for the returned output.
*/
public static enum OutputMode {
/** Returns output in Atom format. */
ATOM("atom"),
/** Returns output in CSV format. */
CSV("csv"),
/** Returns output in JSON format. */
JSON("json"),
/** Returns output in JSON_COLS format. */
JSON_COLS("json_cols"),
/** Returns output in JSON_ROWS format. */
JSON_ROWS("json_rows"),
/** Returns output in raw format. */
RAW("raw"),
/** Returns output in XML format. */
XML("xml");
private String value;
private OutputMode(String value) {
this.value = value;
}
/**
* @return The REST API value for this enumerated constant.
*/
public String toString() {
return this.value;
}
}
/**
* Class constructor.
*/
public JobResultsArgs() { super(); }
/* BEGIN AUTOGENERATED CODE */
/**
* Sets the maximum number of results to return.
*
* @param count
* The maximum number of results. To return all available results, specify 0.
*/
public void setCount(int count) {
this.put("count", count);
}
/**
* 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);
}
/**
* Specifies the index of the first result (inclusive) from which to begin returning data. This value is 0-indexed.<p>In Splunk 4.1+, negative offsets are allowed and are added to the count to compute the absolute offset (for example, offset=-1 is the last available offset). Offsets in the results are always absolute and never negative. The default value is 0.
*
* @param offset
* The index of the first result to return.
*/
public void setOffset(int offset) {
this.put("offset", offset);
}
/**
* Sets the format of the output.
*
* @param outputMode
* The output format.
*/
public void setOutputMode(OutputMode outputMode) {
this.put("output_mode", outputMode);
}
/**
* Sets the post-processing search to apply to results.
*
* @param search
* The post-processing search query.
*/
public void setSearch(String search) {
this.put("search", search);
}
/* END AUTOGENERATED CODE */
}