A set of parameters for Kinetica.adminAlterJobs. More…
Classes | |
| struct | Action |
| A set of string constants for the parameter AdminAlterJobsRequest.action. More… | |
| struct | Options |
| A set of string constants for the parameter AdminAlterJobsRequest.options. More… | |
Public Member Functions | |
| AdminAlterJobsRequest () | |
| Constructs an AdminAlterJobsRequest object with default parameters. | |
| AdminAlterJobsRequest (IList< long > job_ids, string action, IDictionary< string, string > options=null) | |
| Constructs an AdminAlterJobsRequest object with the specified parameters. | |
| AdminAlterJobsRequest () | |
| Constructs an AdminAlterJobsRequest object with default parameters. | |
| AdminAlterJobsRequest (IList< long > job_ids, string action, IDictionary< string, string > options=null) | |
| Constructs an AdminAlterJobsRequest object with the specified parameters. | |
| Public Member Functions inherited from kinetica.KineticaData | |
| KineticaData (KineticaType type) | |
| Constructor from Kinetica Type. | |
| KineticaData (System.Type type=null) | |
| Default constructor, with optional System.Type. | |
| object | Get (int fieldPos) |
| Retrieve a specific property from this object. | |
| void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object. | |
| KineticaData (KineticaType type) | |
| Constructor from Kinetica Type. | |
| KineticaData (System.Type type=null) | |
| Default constructor, with optional System.Type. | |
| object | Get (int fieldPos) |
| Retrieve a specific property from this object. | |
| void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object. | |
Properties | |
| IList< long > | job_ids = new List<long>() [get, set] |
| Jobs to be modified. | |
| string | action [get, set] |
| Action to be performed on the jobs specified by job_ids. | |
| IDictionary< string, string > | options = new Dictionary<string, string>() [get, set] |
| Optional parameters. | |
| Properties inherited from kinetica.KineticaData | |
| Schema | Schema [get] |
| Avro Schema for this class. | |
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. | |
| static ? RecordSchema | SchemaFromType (System.Type t, KineticaType? ktype=null) |
| Create an Avro Schema from a System.Type and a KineticaType. | |
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/4]
| inline |
Constructs an AdminAlterJobsRequest object with default parameters.
Definition at line 71 of file AdminAlterJobs.cs.
◆ AdminAlterJobsRequest() [2/4]
| inline |
Constructs an AdminAlterJobsRequest object with the specified parameters.
Definition at line 97 of file AdminAlterJobs.cs.
◆ AdminAlterJobsRequest() [3/4]
| inline |
Constructs an AdminAlterJobsRequest object with default parameters.
Definition at line 71 of file AdminAlterJobs.cs.
◆ AdminAlterJobsRequest() [4/4]
| inline |
Constructs an AdminAlterJobsRequest object with the specified parameters.
Definition at line 97 of file AdminAlterJobs.cs.
Property Documentation
◆ action
| getset |
Action to be performed on the jobs specified by job_ids.
Supported values:
Definition at line 54 of file AdminAlterJobs.cs.
◆ job_ids
| getset |
Jobs to be modified.
Definition at line 43 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 67 of file AdminAlterJobs.cs.
The documentation for this class was generated from the following files:
- _build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/AdminAlterJobs.cs
- Kinetica/Protocol/AdminAlterJobs.cs