Kinetica   C#   API  Version 7.2.3.1
CreateVideo.cs
Go to the documentation of this file.
1 /*
2  * This file was autogenerated by the Kinetica schema processor.
3  *
4  * DO NOT EDIT DIRECTLY.
5  */
6 
7 using System.Collections.Generic;
8 
9 namespace kinetica;
10 
17 {
23  public struct Style
24  {
25  public const string CHART = "chart";
26  public const string RASTER = "raster";
27  public const string CLASSBREAK = "classbreak";
28  public const string CONTOUR = "contour";
29  public const string HEATMAP = "heatmap";
30  public const string LABELS = "labels";
31  } // end struct Style
32 
36  public struct Options
37  {
40  public const string TTL = "ttl";
41 
52  public const string WINDOW = "window";
53 
67  public const string NO_ERROR_IF_EXISTS = "no_error_if_exists";
68 
69  public const string FALSE = "false";
70  public const string TRUE = "true";
71 
86  public const string REPLACE_IF_EXISTS = "replace_if_exists";
87  } // end struct Options
88 
93  public string attribute { get; set; }
94 
98  public string begin { get; set; }
99 
101  public double duration_seconds { get; set; }
102 
106  public string end { get; set; }
107 
110  public double frames_per_second { get; set; }
111 
135  public string style { get; set; }
136 
143  public string path { get; set; }
144 
149  public string style_parameters { get; set; }
150 
211  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
212 
215  public CreateVideoRequest() { }
216 
322  string begin,
323  double duration_seconds,
324  string end,
325  double frames_per_second,
326  string style,
327  string path,
328  string style_parameters,
329  IDictionary<string, string> options = null)
330  {
331  this.attribute = attribute ?? "";
332  this.begin = begin ?? "";
333  this.duration_seconds = duration_seconds;
334  this.end = end ?? "";
335  this.frames_per_second = frames_per_second;
336  this.style = style ?? "";
337  this.path = path ?? "";
338  this.style_parameters = style_parameters ?? "";
339  this.options = options ?? new Dictionary<string, string>();
340  } // end constructor
341 } // end class CreateVideoRequest
342 
347 {
349  public long job_id { get; set; }
350 
352  public string path { get; set; }
353 
355  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
356 } // end class CreateVideoResponse
long job_id
An identifier for the created job.
Definition: CreateVideo.cs:349
IDictionary< string, string > info
Additional information.
Definition: CreateVideo.cs:355
string end
The end point for the video.
Definition: CreateVideo.cs:106
string style
The name of the visualize mode; should correspond to the schema used for the style_parameters field.
Definition: CreateVideo.cs:135
CreateVideoRequest(string attribute, string begin, double duration_seconds, string end, double frames_per_second, string style, string path, string style_parameters, IDictionary< string, string > options=null)
Constructs a CreateVideoRequest object with the specified parameters.
Definition: CreateVideo.cs:321
const string WINDOW
Specified using the data-type corresponding to the attribute.
Definition: CreateVideo.cs:52
string style_parameters
A string containing the JSON-encoded visualize request.
Definition: CreateVideo.cs:149
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
string begin
The start point for the video.
Definition: CreateVideo.cs:98
CreateVideoRequest()
Constructs a CreateVideoRequest object with default parameters.
Definition: CreateVideo.cs:215
double duration_seconds
Seconds of video to produce.
Definition: CreateVideo.cs:101
const string CLASSBREAK
Definition: CreateVideo.cs:27
double frames_per_second
The presentation frame rate of the encoded video in frames per second.
Definition: CreateVideo.cs:110
IDictionary< string, string > options
Optional parameters.
Definition: CreateVideo.cs:211
string attribute
The animated attribute to map to the video's frames.
Definition: CreateVideo.cs:93
const string NO_ERROR_IF_EXISTS
If TRUE, does not return an error if the video already exists.
Definition: CreateVideo.cs:67
A set of results returned by Kinetica.createVideo.
Definition: CreateVideo.cs:346
const string REPLACE_IF_EXISTS
If TRUE, deletes any existing video with the same path before creating a new video.
Definition: CreateVideo.cs:86
A set of string constants for the parameter options.
Definition: CreateVideo.cs:36
string path
Fully-qualified KiFS path.
Definition: CreateVideo.cs:143
A set of string constants for the parameter style.
Definition: CreateVideo.cs:23
string path
Fully qualified KIFS path to the video file.
Definition: CreateVideo.cs:352
const string TTL
Sets the TTL of the video.
Definition: CreateVideo.cs:40
A set of parameters for Kinetica.createVideo.
Definition: CreateVideo.cs:16