| yoshi-code-bot | 3dd1527 | 2021-04-21 15:07:48 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="dialogflow_v2beta1.html">Dialogflow API</a> . <a href="dialogflow_v2beta1.projects.html">projects</a> . <a href="dialogflow_v2beta1.projects.agent.html">agent</a> . <a href="dialogflow_v2beta1.projects.agent.versions.html">versions</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Creates an agent version. The new version points to the agent instance in the "default" environment.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Delete the specified agent version.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 88 | <p class="firstline">Retrieves the specified agent version.</p> |
| 89 | <p class="toc_element"> |
| 90 | <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| 91 | <p class="firstline">Returns the list of all versions of the specified agent.</p> |
| 92 | <p class="toc_element"> |
| 93 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 94 | <p class="firstline">Retrieves the next page of results.</p> |
| 95 | <p class="toc_element"> |
| 96 | <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| 97 | <p class="firstline">Updates the specified agent version. Note that this method does not allow you to update the state of the agent the given version points to. It allows you to update only mutable properties of the version resource.</p> |
| 98 | <h3>Method Details</h3> |
| 99 | <div class="method"> |
| 100 | <code class="details" id="close">close()</code> |
| 101 | <pre>Close httplib2 connections.</pre> |
| 102 | </div> |
| 103 | |
| 104 | <div class="method"> |
| 105 | <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> |
| 106 | <pre>Creates an agent version. The new version points to the agent instance in the "default" environment. |
| 107 | |
| 108 | Args: |
| 109 | parent: string, Required. The agent to create a version for. Supported formats: - `projects//agent` - `projects//locations//agent` (required) |
| 110 | body: object, The request body. |
| 111 | The object takes the form of: |
| 112 | |
| 113 | { # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions). |
| 114 | "createTime": "A String", # Output only. The creation time of this version. This field is read-only, i.e., it cannot be set by create and update methods. |
| 115 | "description": "A String", # Optional. The developer-provided description of this version. |
| 116 | "name": "A String", # Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/` |
| 117 | "status": "A String", # Output only. The status of this version. This field is read-only and cannot be set by create and update methods. |
| 118 | "versionNumber": 42, # Output only. The sequential number of this version. This field is read-only which means it cannot be set by create and update methods. |
| 119 | } |
| 120 | |
| 121 | x__xgafv: string, V1 error format. |
| 122 | Allowed values |
| 123 | 1 - v1 error format |
| 124 | 2 - v2 error format |
| 125 | |
| 126 | Returns: |
| 127 | An object of the form: |
| 128 | |
| 129 | { # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions). |
| 130 | "createTime": "A String", # Output only. The creation time of this version. This field is read-only, i.e., it cannot be set by create and update methods. |
| 131 | "description": "A String", # Optional. The developer-provided description of this version. |
| 132 | "name": "A String", # Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/` |
| 133 | "status": "A String", # Output only. The status of this version. This field is read-only and cannot be set by create and update methods. |
| 134 | "versionNumber": 42, # Output only. The sequential number of this version. This field is read-only which means it cannot be set by create and update methods. |
| 135 | }</pre> |
| 136 | </div> |
| 137 | |
| 138 | <div class="method"> |
| 139 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| 140 | <pre>Delete the specified agent version. |
| 141 | |
| 142 | Args: |
| 143 | name: string, Required. The name of the version to delete. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/` (required) |
| 144 | x__xgafv: string, V1 error format. |
| 145 | Allowed values |
| 146 | 1 - v1 error format |
| 147 | 2 - v2 error format |
| 148 | |
| 149 | Returns: |
| 150 | An object of the form: |
| 151 | |
| 152 | { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. |
| 153 | }</pre> |
| 154 | </div> |
| 155 | |
| 156 | <div class="method"> |
| 157 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 158 | <pre>Retrieves the specified agent version. |
| 159 | |
| 160 | Args: |
| 161 | name: string, Required. The name of the version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/` (required) |
| 162 | x__xgafv: string, V1 error format. |
| 163 | Allowed values |
| 164 | 1 - v1 error format |
| 165 | 2 - v2 error format |
| 166 | |
| 167 | Returns: |
| 168 | An object of the form: |
| 169 | |
| 170 | { # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions). |
| 171 | "createTime": "A String", # Output only. The creation time of this version. This field is read-only, i.e., it cannot be set by create and update methods. |
| 172 | "description": "A String", # Optional. The developer-provided description of this version. |
| 173 | "name": "A String", # Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/` |
| 174 | "status": "A String", # Output only. The status of this version. This field is read-only and cannot be set by create and update methods. |
| 175 | "versionNumber": 42, # Output only. The sequential number of this version. This field is read-only which means it cannot be set by create and update methods. |
| 176 | }</pre> |
| 177 | </div> |
| 178 | |
| 179 | <div class="method"> |
| 180 | <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| 181 | <pre>Returns the list of all versions of the specified agent. |
| 182 | |
| 183 | Args: |
| 184 | parent: string, Required. The agent to list all versions from. Supported formats: - `projects//agent` - `projects//locations//agent` (required) |
| 185 | pageSize: integer, Optional. The maximum number of items to return in a single page. By default 100 and at most 1000. |
| 186 | pageToken: string, Optional. The next_page_token value returned from a previous list request. |
| 187 | x__xgafv: string, V1 error format. |
| 188 | Allowed values |
| 189 | 1 - v1 error format |
| 190 | 2 - v2 error format |
| 191 | |
| 192 | Returns: |
| 193 | An object of the form: |
| 194 | |
| 195 | { # The response message for Versions.ListVersions. |
| 196 | "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list. |
| 197 | "versions": [ # The list of agent versions. There will be a maximum number of items returned based on the page_size field in the request. |
| 198 | { # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions). |
| 199 | "createTime": "A String", # Output only. The creation time of this version. This field is read-only, i.e., it cannot be set by create and update methods. |
| 200 | "description": "A String", # Optional. The developer-provided description of this version. |
| 201 | "name": "A String", # Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/` |
| 202 | "status": "A String", # Output only. The status of this version. This field is read-only and cannot be set by create and update methods. |
| 203 | "versionNumber": 42, # Output only. The sequential number of this version. This field is read-only which means it cannot be set by create and update methods. |
| 204 | }, |
| 205 | ], |
| 206 | }</pre> |
| 207 | </div> |
| 208 | |
| 209 | <div class="method"> |
| 210 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 211 | <pre>Retrieves the next page of results. |
| 212 | |
| 213 | Args: |
| 214 | previous_request: The request for the previous page. (required) |
| 215 | previous_response: The response from the request for the previous page. (required) |
| 216 | |
| 217 | Returns: |
| 218 | A request object that you can call 'execute()' on to request the next |
| 219 | page. Returns None if there are no more items in the collection. |
| 220 | </pre> |
| 221 | </div> |
| 222 | |
| 223 | <div class="method"> |
| 224 | <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| 225 | <pre>Updates the specified agent version. Note that this method does not allow you to update the state of the agent the given version points to. It allows you to update only mutable properties of the version resource. |
| 226 | |
| 227 | Args: |
| 228 | name: string, Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/` (required) |
| 229 | body: object, The request body. |
| 230 | The object takes the form of: |
| 231 | |
| 232 | { # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions). |
| 233 | "createTime": "A String", # Output only. The creation time of this version. This field is read-only, i.e., it cannot be set by create and update methods. |
| 234 | "description": "A String", # Optional. The developer-provided description of this version. |
| 235 | "name": "A String", # Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/` |
| 236 | "status": "A String", # Output only. The status of this version. This field is read-only and cannot be set by create and update methods. |
| 237 | "versionNumber": 42, # Output only. The sequential number of this version. This field is read-only which means it cannot be set by create and update methods. |
| 238 | } |
| 239 | |
| 240 | updateMask: string, Required. The mask to control which fields get updated. |
| 241 | x__xgafv: string, V1 error format. |
| 242 | Allowed values |
| 243 | 1 - v1 error format |
| 244 | 2 - v2 error format |
| 245 | |
| 246 | Returns: |
| 247 | An object of the form: |
| 248 | |
| 249 | { # You can create multiple versions of your agent and publish them to separate environments. When you edit an agent, you are editing the draft agent. At any point, you can save the draft agent as an agent version, which is an immutable snapshot of your agent. When you save the draft agent, it is published to the default environment. When you create agent versions, you can publish them to custom environments. You can create a variety of custom environments for: - testing - development - production - etc. For more information, see the [versions and environments guide](https://cloud.google.com/dialogflow/docs/agents-versions). |
| 250 | "createTime": "A String", # Output only. The creation time of this version. This field is read-only, i.e., it cannot be set by create and update methods. |
| 251 | "description": "A String", # Optional. The developer-provided description of this version. |
| 252 | "name": "A String", # Output only. The unique identifier of this agent version. Supported formats: - `projects//agent/versions/` - `projects//locations//agent/versions/` |
| 253 | "status": "A String", # Output only. The status of this version. This field is read-only and cannot be set by create and update methods. |
| 254 | "versionNumber": 42, # Output only. The sequential number of this version. This field is read-only which means it cannot be set by create and update methods. |
| 255 | }</pre> |
| 256 | </div> |
| 257 | |
| 258 | </body></html> |