copilot-sdk-java/snapshot/jacoco/com.github.copilot.rpc/ExitPlanModeRequest.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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
<?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>ExitPlanModeRequest.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">ExitPlanModeRequest.java</span></div><h1>ExitPlanModeRequest.java</h1><pre class="source lang-java linenums">/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *--------------------------------------------------------------------------------------------*/

package com.github.copilot.rpc;

import java.util.Collections;
import java.util.List;

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

/**
 * Request to exit plan mode and continue with a selected action.
 * &lt;p&gt;
 * This is sent by the server when the agent wants to exit plan mode and
 * requests user confirmation.
 *
 * @since 1.0.8
 */
@JsonIgnoreProperties(ignoreUnknown = true)
<span class="fc" id="L22">public class ExitPlanModeRequest {</span>

<span class="fc" id="L24">    @JsonProperty(&quot;summary&quot;)</span>
    private String summary = &quot;&quot;;

    @JsonProperty(&quot;planContent&quot;)
    private String planContent;

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

<span class="fc" id="L33">    @JsonProperty(&quot;recommendedAction&quot;)</span>
    private String recommendedAction = &quot;autopilot&quot;;

    /**
     * Gets the summary of the plan or proposed next step.
     *
     * @return the summary
     */
    public String getSummary() {
<span class="fc" id="L42">        return summary;</span>
    }

    /**
     * Sets the summary of the plan or proposed next step.
     *
     * @param summary
     *            the summary
     * @return this instance for method chaining
     */
    public ExitPlanModeRequest setSummary(String summary) {
<span class="fc" id="L53">        this.summary = summary;</span>
<span class="fc" id="L54">        return this;</span>
    }

    /**
     * Gets the full plan content, when available.
     *
     * @return the plan content, or {@code null} if not available
     */
    public String getPlanContent() {
<span class="fc" id="L63">        return planContent;</span>
    }

    /**
     * Sets the full plan content.
     *
     * @param planContent
     *            the plan content
     * @return this instance for method chaining
     */
    public ExitPlanModeRequest setPlanContent(String planContent) {
<span class="fc" id="L74">        this.planContent = planContent;</span>
<span class="fc" id="L75">        return this;</span>
    }

    /**
     * Gets the available actions the user can select.
     *
     * @return the list of actions, or {@code null} if not specified
     */
    public List&lt;String&gt; getActions() {
<span class="pc bpc" id="L84" title="1 of 2 branches missed.">        return actions == null ? null : Collections.unmodifiableList(actions);</span>
    }

    /**
     * Sets the available actions the user can select.
     *
     * @param actions
     *            the list of actions
     * @return this instance for method chaining
     */
    public ExitPlanModeRequest setActions(List&lt;String&gt; actions) {
<span class="fc" id="L95">        this.actions = actions;</span>
<span class="fc" id="L96">        return this;</span>
    }

    /**
     * Gets the action recommended by the runtime.
     *
     * @return the recommended action
     */
    public String getRecommendedAction() {
<span class="nc" id="L105">        return recommendedAction;</span>
    }

    /**
     * Sets the action recommended by the runtime.
     *
     * @param recommendedAction
     *            the recommended action
     * @return this instance for method chaining
     */
    public ExitPlanModeRequest setRecommendedAction(String recommendedAction) {
<span class="fc" id="L116">        this.recommendedAction = recommendedAction;</span>
<span class="fc" id="L117">        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>