copilot-sdk-java/snapshot/jacoco/com.github.copilot.rpc/ElicitationSchema.java.html at gh-pages · github/copilot-sdk-java · GitHub

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
<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml" lang=""><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"/><link rel="stylesheet" href="../jacoco-resources/report.css" type="text/css"/><link rel="shortcut icon" href="../jacoco-resources/report.gif" type="image/gif"/><title>ElicitationSchema.java</title><link rel="stylesheet" href="../jacoco-resources/prettify.css" type="text/css"/><script type="text/javascript" src="../jacoco-resources/prettify.js"></script></head><body onload="window['PR_TAB_WIDTH']=4;prettyPrint()"><div class="breadcrumb" id="breadcrumb"><span class="info"><a href="../jacoco-sessions.html" class="el_session">Sessions</a></span><a href="../index.html" class="el_report">GitHub Copilot SDK :: Java</a> &gt; <a href="index.source.html" class="el_package">com.github.copilot.rpc</a> &gt; <span class="el_source">ElicitationSchema.java</span></div><h1>ElicitationSchema.java</h1><pre class="source lang-java linenums">/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *--------------------------------------------------------------------------------------------*/

package com.github.copilot.rpc;

import java.util.List;
import java.util.Map;

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;

/**
 * JSON Schema describing the form fields to present for an elicitation dialog.
 *
 * @since 1.0.0
 */
@JsonInclude(JsonInclude.Include.NON_NULL)
<span class="fc" id="L19">public class ElicitationSchema {</span>

<span class="fc" id="L21">    @JsonProperty(&quot;type&quot;)</span>
    private String type = &quot;object&quot;;

    @JsonProperty(&quot;properties&quot;)
    private Map&lt;String, Object&gt; properties;

    @JsonProperty(&quot;required&quot;)
    private List&lt;String&gt; required;

    /**
     * Gets the schema type indicator (always {@code &quot;object&quot;}).
     *
     * @return the type
     */
    public String getType() {
<span class="fc" id="L36">        return type;</span>
    }

    /**
     * Sets the schema type indicator.
     *
     * @param type
     *            the type (typically {@code &quot;object&quot;})
     * @return this instance for method chaining
     */
    public ElicitationSchema setType(String type) {
<span class="fc" id="L47">        this.type = type;</span>
<span class="fc" id="L48">        return this;</span>
    }

    /**
     * Gets the form field definitions, keyed by field name.
     *
     * @return the properties map
     */
    public Map&lt;String, Object&gt; getProperties() {
<span class="fc" id="L57">        return properties;</span>
    }

    /**
     * Sets the form field definitions, keyed by field name.
     *
     * @param properties
     *            the properties map
     * @return this instance for method chaining
     */
    public ElicitationSchema setProperties(Map&lt;String, Object&gt; properties) {
<span class="fc" id="L68">        this.properties = properties;</span>
<span class="fc" id="L69">        return this;</span>
    }

    /**
     * Gets the list of required field names.
     *
     * @return the required field names, or {@code null}
     */
    public List&lt;String&gt; getRequired() {
<span class="fc" id="L78">        return required;</span>
    }

    /**
     * Sets the list of required field names.
     *
     * @param required
     *            the required field names
     * @return this instance for method chaining
     */
    public ElicitationSchema setRequired(List&lt;String&gt; required) {
<span class="fc" id="L89">        this.required = required;</span>
<span class="fc" id="L90">        return this;</span>
    }
}
</pre><div class="footer"><span class="right">Created with <a href="http://www.jacoco.org/jacoco">JaCoCo</a> 0.8.14.202510111229</span></div></body></html>