Beispiel #1
0
        /// <summary>
        /// Initializes a new instance of the <see cref="DAGTaskLoop" /> class.
        /// </summary>
        /// <param name="annotations">An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries..</param>
        /// <param name="from">The task or DAG parameter to loop over (must be iterable)..</param>
        public DAGTaskLoop
        (
            // Required parameters
            Dictionary <string, string> annotations = default, AnyOf <InputReference, TaskReference, ValueListReference> from = default // Optional parameters
        ) : base()                                                                                                                      // BaseClass
        {
            this.Annotations = annotations;
            this.From        = from;

            // Set non-required readonly properties with defaultValue
            this.Type = "DAGTaskLoop";
        }
        /// <summary>
        /// Initializes a new instance of the <see cref="StepPathOutput" /> class.
        /// </summary>
        /// <param name="source">The path to source the file from. (required).</param>
        /// <param name="name">Output name. (required).</param>
        /// <param name="annotations">An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries..</param>
        /// <param name="description">Optional description for output..</param>
        /// <param name="path">Path to the output artifact relative to where the function command is executed. (required).</param>
        /// <param name="required">A boolean to indicate if an artifact output is required. A False value makes the artifact optional. (default to true).</param>
        public StepPathOutput
        (
            string name, string path, AnyOf <HTTP, S3, ProjectFolder> source,                                     // Required parameters
            Dictionary <string, string> annotations = default, string description = default, bool required = true // Optional parameters
        ) : base(name: name, annotations: annotations, description: description, path: path, required: required)  // BaseClass
        {
            // to ensure "source" is required (not null)
            this.Source = source ?? throw new ArgumentNullException("source is a required property for StepPathOutput and cannot be null");

            // Set non-required readonly properties with defaultValue
            this.Type = "StepPathOutput";
        }
Beispiel #3
0
        /// <summary>
        /// Initializes a new instance of the <see cref="DAGFolderOutputAlias" /> class.
        /// </summary>
        /// <param name="from">Reference to a folder or a task output. Task output must be folder. (required).</param>
        /// <param name="name">Output name. (required).</param>
        /// <param name="annotations">An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries..</param>
        /// <param name="description">Optional description for output..</param>
        /// <param name="platform">Name of the client platform (e.g. Grasshopper, Revit, etc). The value can be any strings as long as it has been agreed between client-side developer and author of the recipe. (required).</param>
        /// <param name="handler">List of process actions to process the input or output value. (required).</param>
        /// <param name="required">A boolean to indicate if an artifact output is required. A False value makes the artifact optional. (default to true).</param>
        public DAGFolderOutputAlias
        (
            string name, List <string> platform, List <IOAliasHandler> handler, AnyOf <TaskReference, FolderReference> from,               // Required parameters
            Dictionary <string, string> annotations = default, string description = default, bool required = true                          // Optional parameters
        ) : base(name: name, annotations: annotations, description: description, platform: platform, handler: handler, required: required) // BaseClass
        {
            // to ensure "from" is required (not null)
            this.From = from ?? throw new ArgumentNullException("from is a required property for DAGFolderOutputAlias and cannot be null");

            // Set non-required readonly properties with defaultValue
            this.Type = "DAGFolderOutputAlias";
        }
        /// <summary>
        /// Initializes a new instance of the <see cref="DAGIntegerOutput" /> class.
        /// </summary>
        /// <param name="from">Reference to a file or a task output. Task output must be file. (required).</param>
        /// <param name="alias">A list of additional processes for loading this output on different platforms..</param>
        /// <param name="required">A boolean to indicate if an artifact output is required. A False value makes the artifact optional. (default to true).</param>
        /// <param name="name">Output name. (required).</param>
        /// <param name="annotations">An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries..</param>
        /// <param name="description">Optional description for output..</param>
        public DAGIntegerOutput
        (
            string name, AnyOf <TaskReference, FileReference> from,                                                                                                                                                                                                                                                                                                                                   // Required parameters
            Dictionary <string, string> annotations = default, string description = default, List <AnyOf <DAGGenericOutputAlias, DAGStringOutputAlias, DAGIntegerOutputAlias, DAGNumberOutputAlias, DAGBooleanOutputAlias, DAGFolderOutputAlias, DAGFileOutputAlias, DAGPathOutputAlias, DAGArrayOutputAlias, DAGJSONObjectOutputAlias, DAGLinkedOutputAlias> > alias = default, bool required = true // Optional parameters
        ) : base(name: name, annotations: annotations, description: description)                                                                                                                                                                                                                                                                                                                      // BaseClass
        {
            // to ensure "from" is required (not null)
            this.From     = from ?? throw new ArgumentNullException("from is a required property for DAGIntegerOutput and cannot be null");
            this.Alias    = alias;
            this.Required = required;

            // Set non-required readonly properties with defaultValue
            this.Type = "DAGIntegerOutput";
        }
Beispiel #5
0
        /// <summary>
        /// Initializes a new instance of the <see cref="JobPathArgument" /> class.
        /// </summary>
        /// <param name="name">Argument name. The name must match one of the input names from Job&#39;s template which can be a function or DAG. (required).</param>
        /// <param name="source">The path to source the file from. (required).</param>
        /// <param name="annotations">An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries..</param>
        public JobPathArgument
        (
            string name, AnyOf <HTTP, S3, ProjectFolder> source, // Required parameters
            Dictionary <string, string> annotations = default    // Optional parameters
        ) : base()                                               // BaseClass
        {
            // to ensure "name" is required (not null)
            this.Name = name ?? throw new ArgumentNullException("name is a required property for JobPathArgument and cannot be null");
            // to ensure "source" is required (not null)
            this.Source      = source ?? throw new ArgumentNullException("source is a required property for JobPathArgument and cannot be null");
            this.Annotations = annotations;

            // Set non-required readonly properties with defaultValue
            this.Type = "JobPathArgument";
        }
Beispiel #6
0
        /// <summary>
        /// Initializes a new instance of the <see cref="TaskArgument" /> class.
        /// </summary>
        /// <param name="name">Argument name. The name must match one of the input names from Task&#39;s template which can be a function or DAG. (required).</param>
        /// <param name="from">A reference to a DAG input, a DAG output or another task output. You can also use the ValueReference type to hard-code an input value. (required).</param>
        /// <param name="annotations">An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries..</param>
        public TaskArgument
        (
            string name, AnyOf <InputReference, TaskReference, ItemReference, ValueReference> from, // Required parameters
            Dictionary <string, string> annotations = default                                       // Optional parameters
        ) : base()                                                                                  // BaseClass
        {
            // to ensure "name" is required (not null)
            this.Name = name ?? throw new ArgumentNullException("name is a required property for TaskArgument and cannot be null");
            // to ensure "from" is required (not null)
            this.From        = from ?? throw new ArgumentNullException("from is a required property for TaskArgument and cannot be null");
            this.Annotations = annotations;

            // Set non-required readonly properties with defaultValue
            this.Type = "TaskArgument";
        }
Beispiel #7
0
        /// <summary>
        /// Initializes a new instance of the <see cref="StepFolderInput" /> class.
        /// </summary>
        /// <param name="source">The path to source the file from. (required).</param>
        /// <param name="_default">The default source for file if the value is not provided..</param>
        /// <param name="alias">A list of aliases for this input in different platforms..</param>
        /// <param name="required">A field to indicate if this input is required. This input needs to be set explicitly even when a default value is provided. (default to false).</param>
        /// <param name="spec">An optional JSON Schema specification to validate the input value. You can use validate_spec method to validate a value against the spec..</param>
        /// <param name="path">Path to the target location that the input will be copied to.  This path is relative to the working directory where the command is executed..</param>
        /// <param name="name">Input name. (required).</param>
        /// <param name="annotations">An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries..</param>
        /// <param name="description">Optional description for input..</param>
        public StepFolderInput
        (
            string name, AnyOf <HTTP, S3, ProjectFolder> source,                                                                                                                                                                                                                                                                                                                                                                                                                              // Required parameters
            Dictionary <string, string> annotations = default, string description = default, AnyOf <HTTP, S3, ProjectFolder> _default = default, List <AnyOf <DAGGenericInputAlias, DAGStringInputAlias, DAGIntegerInputAlias, DAGNumberInputAlias, DAGBooleanInputAlias, DAGFolderInputAlias, DAGFileInputAlias, DAGPathInputAlias, DAGArrayInputAlias, DAGJSONObjectInputAlias, DAGLinkedInputAlias> > alias = default, bool required = false, Object spec = default, string path = default // Optional parameters
        ) : base(name: name, annotations: annotations, description: description)                                                                                                                                                                                                                                                                                                                                                                                                              // BaseClass
        {
            // to ensure "source" is required (not null)
            this.Source   = source ?? throw new ArgumentNullException("source is a required property for StepFolderInput and cannot be null");
            this.Default  = _default;
            this.Alias    = alias;
            this.Required = required;
            this.Spec     = spec;
            this.Path     = path;

            // Set non-required readonly properties with defaultValue
            this.Type = "StepFolderInput";
        }
Beispiel #8
0
        /// <summary>
        /// Initializes a new instance of the <see cref="DAGFileInputAlias" /> class.
        /// </summary>
        /// <param name="platform">Name of the client platform (e.g. Grasshopper, Revit, etc). The value can be any strings as long as it has been agreed between client-side developer and author of the recipe. (required).</param>
        /// <param name="handler">List of process actions to process the input or output value. (required).</param>
        /// <param name="_default">The default source for file if the value is not provided..</param>
        /// <param name="required">A field to indicate if this input is required. This input needs to be set explicitly even when a default value is provided. (default to false).</param>
        /// <param name="spec">An optional JSON Schema specification to validate the input value. You can use validate_spec method to validate a value against the spec..</param>
        /// <param name="extensions">Optional list of extensions for file. The check for extension is case-insensitive..</param>
        /// <param name="name">Input name. (required).</param>
        /// <param name="annotations">An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries..</param>
        /// <param name="description">Optional description for input..</param>
        public DAGFileInputAlias
        (
            string name, List <string> platform, List <IOAliasHandler> handler,                                                                                                                                                   // Required parameters
            Dictionary <string, string> annotations = default, string description = default, AnyOf <HTTP, S3, ProjectFolder> _default = default, bool required = false, Object spec = default, List <string> extensions = default // Optional parameters
        ) : base(name: name, annotations: annotations, description: description)                                                                                                                                                  // BaseClass
        {
            // to ensure "platform" is required (not null)
            this.Platform = platform ?? throw new ArgumentNullException("platform is a required property for DAGFileInputAlias and cannot be null");
            // to ensure "handler" is required (not null)
            this.Handler    = handler ?? throw new ArgumentNullException("handler is a required property for DAGFileInputAlias and cannot be null");
            this.Default    = _default;
            this.Required   = required;
            this.Spec       = spec;
            this.Extensions = extensions;

            // Set non-required readonly properties with defaultValue
            this.Type = "DAGFileInputAlias";
        }
        /// <summary>
        /// Initializes a new instance of the <see cref="DAGFileInput" /> class.
        /// </summary>
        /// <param name="_default">The default source for file if the value is not provided..</param>
        /// <param name="alias">A list of aliases for this input in different platforms..</param>
        /// <param name="required">A field to indicate if this input is required. This input needs to be set explicitly even when a default value is provided. (default to false).</param>
        /// <param name="spec">An optional JSON Schema specification to validate the input value. You can use validate_spec method to validate a value against the spec..</param>
        /// <param name="extensions">Optional list of extensions for file. The check for extension is case-insensitive..</param>
        /// <param name="name">Input name. (required).</param>
        /// <param name="annotations">An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries..</param>
        /// <param name="description">Optional description for input..</param>
        public DAGFileInput
        (
            string name,                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   // Required parameters
            Dictionary <string, string> annotations = default, string description = default, AnyOf <HTTP, S3, ProjectFolder> _default = default, List <AnyOf <DAGGenericInputAlias, DAGStringInputAlias, DAGIntegerInputAlias, DAGNumberInputAlias, DAGBooleanInputAlias, DAGFolderInputAlias, DAGFileInputAlias, DAGPathInputAlias, DAGArrayInputAlias, DAGJSONObjectInputAlias, DAGLinkedInputAlias> > alias = default, bool required = false, Object spec = default, List <string> extensions = default // Optional parameters
        ) : base(name: name, annotations: annotations, description: description)                                                                                                                                                                                                                                                                                                                                                                                                                           // BaseClass
        {
            this.Default    = _default;
            this.Alias      = alias;
            this.Required   = required;
            this.Spec       = spec;
            this.Extensions = extensions;

            // Set non-required readonly properties with defaultValue
            this.Type = "DAGFileInput";
        }
Beispiel #10
0
        /// <summary>
        /// Initializes a new instance of the <see cref="PackageVersion" /> class.
        /// </summary>
        /// <param name="name">Package name. Make it descriptive and helpful ;) (required).</param>
        /// <param name="tag">The tag of the package (required).</param>
        /// <param name="url">url (required).</param>
        /// <param name="created">created (required).</param>
        /// <param name="digest">digest (required).</param>
        /// <param name="annotations">An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries..</param>
        /// <param name="appVersion">The version of the application code underlying the manifest.</param>
        /// <param name="keywords">A list of keywords to search the package by.</param>
        /// <param name="maintainers">A list of maintainers for the package.</param>
        /// <param name="home">The URL of this package&#39;s home page.</param>
        /// <param name="sources">A list of URLs to source code for this project.</param>
        /// <param name="icon">A URL to an SVG or PNG image to be used as an icon.</param>
        /// <param name="deprecated">Whether this package is deprecated.</param>
        /// <param name="description">A description of what this package does.</param>
        /// <param name="license">The license information..</param>
        /// <param name="slug">A slug of the repository name and the package name..</param>
        /// <param name="kind">The type of Queenbee package (ie: recipe or plugin) (default to &quot;&quot;).</param>
        /// <param name="readme">The README file string for this package.</param>
        /// <param name="manifest">The package Recipe or Plugin manifest.</param>
        public PackageVersion
        (
            string name, string tag, string url, DateTime created, string digest,                                                                                                                                                                                                                                                                                                                                                                     // Required parameters
            Dictionary <string, string> annotations = default, string appVersion = default, List <string> keywords = default, List <Maintainer> maintainers = default, string home = default, List <string> sources = default, string icon = default, bool deprecated = default, string description = default, License license = default, string slug = default, string kind = "", string readme = default, AnyOf <Recipe, Plugin> manifest = default // Optional parameters
        ) : base()                                                                                                                                                                                                                                                                                                                                                                                                                                    // BaseClass
        {
            // to ensure "name" is required (not null)
            this.Name = name ?? throw new ArgumentNullException("name is a required property for PackageVersion and cannot be null");
            // to ensure "tag" is required (not null)
            this.Tag = tag ?? throw new ArgumentNullException("tag is a required property for PackageVersion and cannot be null");
            // to ensure "url" is required (not null)
            this.Url     = url ?? throw new ArgumentNullException("url is a required property for PackageVersion and cannot be null");
            this.Created = created;
            // to ensure "digest" is required (not null)
            this.Digest      = digest ?? throw new ArgumentNullException("digest is a required property for PackageVersion and cannot be null");
            this.Annotations = annotations;
            this.AppVersion  = appVersion;
            this.Keywords    = keywords;
            this.Maintainers = maintainers;
            this.Home        = home;
            this.Sources     = sources;
            this.Icon        = icon;
            this.Deprecated  = deprecated;
            this.Description = description;
            this.License     = license;
            this.Slug        = slug;
            // use default value if no "kind" provided
            this.Kind     = kind ?? "";
            this.Readme   = readme;
            this.Manifest = manifest;

            // Set non-required readonly properties with defaultValue
            this.Type = "PackageVersion";
        }