1<html><body> 2<style> 3 4body, 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 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, 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="sasportal_v1alpha1.html">SAS Portal API</a> . <a href="sasportal_v1alpha1.nodes.html">nodes</a> . <a href="sasportal_v1alpha1.nodes.deployments.html">deployments</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="sasportal_v1alpha1.nodes.deployments.devices.html">devices()</a></code> 79</p> 80<p class="firstline">Returns the devices Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="#close">close()</a></code></p> 84<p class="firstline">Close httplib2 connections.</p> 85<p class="toc_element"> 86 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 87<p class="firstline">Deletes a deployment.</p> 88<p class="toc_element"> 89 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 90<p class="firstline">Returns a requested deployment.</p> 91<p class="toc_element"> 92 <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 93<p class="firstline">Lists deployments.</p> 94<p class="toc_element"> 95 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 96<p class="firstline">Retrieves the next page of results.</p> 97<p class="toc_element"> 98 <code><a href="#move">move(name, body=None, x__xgafv=None)</a></code></p> 99<p class="firstline">Moves a deployment under another node or customer.</p> 100<p class="toc_element"> 101 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 102<p class="firstline">Updates an existing deployment.</p> 103<h3>Method Details</h3> 104<div class="method"> 105 <code class="details" id="close">close()</code> 106 <pre>Close httplib2 connections.</pre> 107</div> 108 109<div class="method"> 110 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 111 <pre>Deletes a deployment. 112 113Args: 114 name: string, Required. The name of the deployment. (required) 115 x__xgafv: string, V1 error format. 116 Allowed values 117 1 - v1 error format 118 2 - v2 error format 119 120Returns: 121 An object of the form: 122 123 { # 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 `{}`. 124}</pre> 125</div> 126 127<div class="method"> 128 <code class="details" id="get">get(name, x__xgafv=None)</code> 129 <pre>Returns a requested deployment. 130 131Args: 132 name: string, Required. The name of the deployment. (required) 133 x__xgafv: string, V1 error format. 134 Allowed values 135 1 - v1 error format 136 2 - v2 error format 137 138Returns: 139 An object of the form: 140 141 { # The Deployment. 142 "allowedBillingModes": [ # The allowed billing modes under this deployment. 143 "A String", 144 ], 145 "defaultBillingMode": "A String", # Default billing mode for the deployment and devices under it. 146 "displayName": "A String", # The deployment's display name. 147 "frns": [ # Output only. The FRNs copied from its direct parent. 148 "A String", 149 ], 150 "name": "A String", # Output only. Resource name. 151 "sasUserIds": [ # User ID used by the devices belonging to this deployment. Each deployment should be associated with one unique user ID. 152 "A String", 153 ], 154}</pre> 155</div> 156 157<div class="method"> 158 <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 159 <pre>Lists deployments. 160 161Args: 162 parent: string, Required. The parent resource name, for example, "nodes/1", customer/1/nodes/2. (required) 163 filter: string, The filter expression. The filter should have the following format: "DIRECT_CHILDREN" or format: "direct_children". The filter is case insensitive. If empty, then no deployments are filtered. 164 pageSize: integer, The maximum number of deployments to return in the response. 165 pageToken: string, A pagination token returned from a previous call to ListDeployments that indicates where this listing should continue from. 166 x__xgafv: string, V1 error format. 167 Allowed values 168 1 - v1 error format 169 2 - v2 error format 170 171Returns: 172 An object of the form: 173 174 { # Response for ListDeployments. 175 "deployments": [ # The deployments that match the request. 176 { # The Deployment. 177 "allowedBillingModes": [ # The allowed billing modes under this deployment. 178 "A String", 179 ], 180 "defaultBillingMode": "A String", # Default billing mode for the deployment and devices under it. 181 "displayName": "A String", # The deployment's display name. 182 "frns": [ # Output only. The FRNs copied from its direct parent. 183 "A String", 184 ], 185 "name": "A String", # Output only. Resource name. 186 "sasUserIds": [ # User ID used by the devices belonging to this deployment. Each deployment should be associated with one unique user ID. 187 "A String", 188 ], 189 }, 190 ], 191 "nextPageToken": "A String", # A pagination token returned from a previous call to ListDeployments that indicates from where listing should continue. If the field is missing or empty, it means there are no more deployments. 192}</pre> 193</div> 194 195<div class="method"> 196 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 197 <pre>Retrieves the next page of results. 198 199Args: 200 previous_request: The request for the previous page. (required) 201 previous_response: The response from the request for the previous page. (required) 202 203Returns: 204 A request object that you can call 'execute()' on to request the next 205 page. Returns None if there are no more items in the collection. 206 </pre> 207</div> 208 209<div class="method"> 210 <code class="details" id="move">move(name, body=None, x__xgafv=None)</code> 211 <pre>Moves a deployment under another node or customer. 212 213Args: 214 name: string, Required. The name of the deployment to move. (required) 215 body: object, The request body. 216 The object takes the form of: 217 218{ # Request for MoveDeployment. 219 "destination": "A String", # Required. The name of the new parent resource node or customer to reparent the deployment under. 220} 221 222 x__xgafv: string, V1 error format. 223 Allowed values 224 1 - v1 error format 225 2 - v2 error format 226 227Returns: 228 An object of the form: 229 230 { # This resource represents a long-running operation that is the result of a network API call. 231 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 232 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 233 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 234 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 235 { 236 "a_key": "", # Properties of the object. Contains field @type with type URL. 237 }, 238 ], 239 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 240 }, 241 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 242 "a_key": "", # Properties of the object. Contains field @type with type URL. 243 }, 244 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 245 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 246 "a_key": "", # Properties of the object. Contains field @type with type URL. 247 }, 248}</pre> 249</div> 250 251<div class="method"> 252 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 253 <pre>Updates an existing deployment. 254 255Args: 256 name: string, Output only. Resource name. (required) 257 body: object, The request body. 258 The object takes the form of: 259 260{ # The Deployment. 261 "allowedBillingModes": [ # The allowed billing modes under this deployment. 262 "A String", 263 ], 264 "defaultBillingMode": "A String", # Default billing mode for the deployment and devices under it. 265 "displayName": "A String", # The deployment's display name. 266 "frns": [ # Output only. The FRNs copied from its direct parent. 267 "A String", 268 ], 269 "name": "A String", # Output only. Resource name. 270 "sasUserIds": [ # User ID used by the devices belonging to this deployment. Each deployment should be associated with one unique user ID. 271 "A String", 272 ], 273} 274 275 updateMask: string, Fields to be updated. 276 x__xgafv: string, V1 error format. 277 Allowed values 278 1 - v1 error format 279 2 - v2 error format 280 281Returns: 282 An object of the form: 283 284 { # The Deployment. 285 "allowedBillingModes": [ # The allowed billing modes under this deployment. 286 "A String", 287 ], 288 "defaultBillingMode": "A String", # Default billing mode for the deployment and devices under it. 289 "displayName": "A String", # The deployment's display name. 290 "frns": [ # Output only. The FRNs copied from its direct parent. 291 "A String", 292 ], 293 "name": "A String", # Output only. Resource name. 294 "sasUserIds": [ # User ID used by the devices belonging to this deployment. Each deployment should be associated with one unique user ID. 295 "A String", 296 ], 297}</pre> 298</div> 299 300</body></html>