A set of parameters for Kinetica.adminAlterJobs. More...
Inheritance diagram for kinetica.AdminAlterJobsRequest:
Collaboration diagram for kinetica.AdminAlterJobsRequest:
Classes | |
| struct | Action |
| A set of string constants for the parameter action. More... | |
| struct | Options |
| A set of string constants for the parameter options. More... | |
Public Member Functions | |
| AdminAlterJobsRequest () | |
| Constructs an AdminAlterJobsRequest object with default parameters. More... | |
| AdminAlterJobsRequest (IList< long > job_ids, string action, IDictionary< string, string > options=null) | |
| Constructs an AdminAlterJobsRequest object with the specified parameters. More... | |
| Public Member Functions inherited from kinetica.KineticaData | |
| KineticaData (KineticaType type) | |
| Constructor from Kinetica Type More... | |
| KineticaData (System.Type type=null) | |
| Default constructor, with optional System.Type More... | |
| object | Get (int fieldPos) |
| Retrieve a specific property from this object More... | |
| void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object More... | |
Properties | |
| IList< long > | job_ids = new List<long>() [get, set] |
| Jobs to be modified. More... | |
| string | action [get, set] |
| Action to be performed on the jobs specified by job_ids. More... | |
| IDictionary< string, string > | options = new Dictionary<string, string>() [get, set] |
| Optional parameters. More... | |
| Properties inherited from kinetica.KineticaData | |
| Schema | Schema [get] |
| Avro Schema for this class More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from kinetica.KineticaData | |
| static ? RecordSchema | SchemaFromType (System.Type t, KineticaType? ktype=null) |
| Create an Avro Schema from a System.Type and a KineticaType. More... | |
Detailed Description
A set of parameters for Kinetica.adminAlterJobs.
Perform the requested action on a list of one or more job(s). Based on the type of job and the current state of execution, the action may not be successfully executed. The final result of the attempted actions for each specified job is returned in the status array of the response. See Job Manager for more information.
Definition at line 20 of file AdminAlterJobs.cs.
Constructor & Destructor Documentation
◆ AdminAlterJobsRequest() [1/2]
|
inline |
Constructs an AdminAlterJobsRequest object with default parameters.
Definition at line 66 of file AdminAlterJobs.cs.
◆ AdminAlterJobsRequest() [2/2]
|
inline |
Constructs an AdminAlterJobsRequest object with the specified parameters.
- Parameters
-
job_ids Jobs to be modified. action Action to be performed on the jobs specified by job_ids. Supported values: options Optional parameters. - JOB_TAG: Job tag returned in call to create the job
Definition at line 89 of file AdminAlterJobs.cs.
Property Documentation
◆ action
|
getset |
Action to be performed on the jobs specified by job_ids.
Supported values:
Definition at line 51 of file AdminAlterJobs.cs.
◆ job_ids
|
getset |
Jobs to be modified.
Definition at line 41 of file AdminAlterJobs.cs.
◆ options
|
getset |
Optional parameters.
- JOB_TAG: Job tag returned in call to create the job
The default value is an empty Dictionary.
Definition at line 62 of file AdminAlterJobs.cs.
The documentation for this class was generated from the following file:
- Kinetica/Protocol/AdminAlterJobs.cs
