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.customers.html">customers</a> . <a href="sasportal_v1alpha1.customers.deployments.html">deployments</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="sasportal_v1alpha1.customers.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="#create">create(parent, body=None, x__xgafv=None)</a></code></p> 87<p class="firstline">Creates a new deployment.</p> 88<p class="toc_element"> 89 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 90<p class="firstline">Deletes a deployment.</p> 91<p class="toc_element"> 92 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 93<p class="firstline">Returns a requested deployment.</p> 94<p class="toc_element"> 95 <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 96<p class="firstline">Lists deployments.</p> 97<p class="toc_element"> 98 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 99<p class="firstline">Retrieves the next page of results.</p> 100<p class="toc_element"> 101 <code><a href="#move">move(name, body=None, x__xgafv=None)</a></code></p> 102<p class="firstline">Moves a deployment under another node or customer.</p> 103<p class="toc_element"> 104 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 105<p class="firstline">Updates an existing deployment.</p> 106<h3>Method Details</h3> 107<div class="method"> 108 <code class="details" id="close">close()</code> 109 <pre>Close httplib2 connections.</pre> 110</div> 111 112<div class="method"> 113 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 114 <pre>Creates a new deployment. 115 116Args: 117 parent: string, Required. The parent resource name where the deployment is to be created. (required) 118 body: object, The request body. 119 The object takes the form of: 120 121{ # The Deployment. 122 "allowedBillingModes": [ # The allowed billing modes under this deployment. 123 "A String", 124 ], 125 "defaultBillingMode": "A String", # Default billing mode for the deployment and devices under it. 126 "displayName": "A String", # The deployment's display name. 127 "frns": [ # Output only. The FRNs copied from its direct parent. 128 "A String", 129 ], 130 "name": "A String", # Output only. Resource name. 131 "sasUserIds": [ # User ID used by the devices belonging to this deployment. Each deployment should be associated with one unique user ID. 132 "A String", 133 ], 134} 135 136 x__xgafv: string, V1 error format. 137 Allowed values 138 1 - v1 error format 139 2 - v2 error format 140 141Returns: 142 An object of the form: 143 144 { # The Deployment. 145 "allowedBillingModes": [ # The allowed billing modes under this deployment. 146 "A String", 147 ], 148 "defaultBillingMode": "A String", # Default billing mode for the deployment and devices under it. 149 "displayName": "A String", # The deployment's display name. 150 "frns": [ # Output only. The FRNs copied from its direct parent. 151 "A String", 152 ], 153 "name": "A String", # Output only. Resource name. 154 "sasUserIds": [ # User ID used by the devices belonging to this deployment. Each deployment should be associated with one unique user ID. 155 "A String", 156 ], 157}</pre> 158</div> 159 160<div class="method"> 161 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 162 <pre>Deletes a deployment. 163 164Args: 165 name: string, Required. The name of the deployment. (required) 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 { # 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 `{}`. 175}</pre> 176</div> 177 178<div class="method"> 179 <code class="details" id="get">get(name, x__xgafv=None)</code> 180 <pre>Returns a requested deployment. 181 182Args: 183 name: string, Required. The name of the deployment. (required) 184 x__xgafv: string, V1 error format. 185 Allowed values 186 1 - v1 error format 187 2 - v2 error format 188 189Returns: 190 An object of the form: 191 192 { # The Deployment. 193 "allowedBillingModes": [ # The allowed billing modes under this deployment. 194 "A String", 195 ], 196 "defaultBillingMode": "A String", # Default billing mode for the deployment and devices under it. 197 "displayName": "A String", # The deployment's display name. 198 "frns": [ # Output only. The FRNs copied from its direct parent. 199 "A String", 200 ], 201 "name": "A String", # Output only. Resource name. 202 "sasUserIds": [ # User ID used by the devices belonging to this deployment. Each deployment should be associated with one unique user ID. 203 "A String", 204 ], 205}</pre> 206</div> 207 208<div class="method"> 209 <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 210 <pre>Lists deployments. 211 212Args: 213 parent: string, Required. The parent resource name, for example, "nodes/1", customer/1/nodes/2. (required) 214 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. 215 pageSize: integer, The maximum number of deployments to return in the response. 216 pageToken: string, A pagination token returned from a previous call to ListDeployments that indicates where this listing should continue from. 217 x__xgafv: string, V1 error format. 218 Allowed values 219 1 - v1 error format 220 2 - v2 error format 221 222Returns: 223 An object of the form: 224 225 { # Response for ListDeployments. 226 "deployments": [ # The deployments that match the request. 227 { # The Deployment. 228 "allowedBillingModes": [ # The allowed billing modes under this deployment. 229 "A String", 230 ], 231 "defaultBillingMode": "A String", # Default billing mode for the deployment and devices under it. 232 "displayName": "A String", # The deployment's display name. 233 "frns": [ # Output only. The FRNs copied from its direct parent. 234 "A String", 235 ], 236 "name": "A String", # Output only. Resource name. 237 "sasUserIds": [ # User ID used by the devices belonging to this deployment. Each deployment should be associated with one unique user ID. 238 "A String", 239 ], 240 }, 241 ], 242 "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. 243}</pre> 244</div> 245 246<div class="method"> 247 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 248 <pre>Retrieves the next page of results. 249 250Args: 251 previous_request: The request for the previous page. (required) 252 previous_response: The response from the request for the previous page. (required) 253 254Returns: 255 A request object that you can call 'execute()' on to request the next 256 page. Returns None if there are no more items in the collection. 257 </pre> 258</div> 259 260<div class="method"> 261 <code class="details" id="move">move(name, body=None, x__xgafv=None)</code> 262 <pre>Moves a deployment under another node or customer. 263 264Args: 265 name: string, Required. The name of the deployment to move. (required) 266 body: object, The request body. 267 The object takes the form of: 268 269{ # Request for MoveDeployment. 270 "destination": "A String", # Required. The name of the new parent resource node or customer to reparent the deployment under. 271} 272 273 x__xgafv: string, V1 error format. 274 Allowed values 275 1 - v1 error format 276 2 - v2 error format 277 278Returns: 279 An object of the form: 280 281 { # This resource represents a long-running operation that is the result of a network API call. 282 "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. 283 "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. 284 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 285 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 286 { 287 "a_key": "", # Properties of the object. Contains field @type with type URL. 288 }, 289 ], 290 "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. 291 }, 292 "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. 293 "a_key": "", # Properties of the object. Contains field @type with type URL. 294 }, 295 "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}`. 296 "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`. 297 "a_key": "", # Properties of the object. Contains field @type with type URL. 298 }, 299}</pre> 300</div> 301 302<div class="method"> 303 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 304 <pre>Updates an existing deployment. 305 306Args: 307 name: string, Output only. Resource name. (required) 308 body: object, The request body. 309 The object takes the form of: 310 311{ # The Deployment. 312 "allowedBillingModes": [ # The allowed billing modes under this deployment. 313 "A String", 314 ], 315 "defaultBillingMode": "A String", # Default billing mode for the deployment and devices under it. 316 "displayName": "A String", # The deployment's display name. 317 "frns": [ # Output only. The FRNs copied from its direct parent. 318 "A String", 319 ], 320 "name": "A String", # Output only. Resource name. 321 "sasUserIds": [ # User ID used by the devices belonging to this deployment. Each deployment should be associated with one unique user ID. 322 "A String", 323 ], 324} 325 326 updateMask: string, Fields to be updated. 327 x__xgafv: string, V1 error format. 328 Allowed values 329 1 - v1 error format 330 2 - v2 error format 331 332Returns: 333 An object of the form: 334 335 { # The Deployment. 336 "allowedBillingModes": [ # The allowed billing modes under this deployment. 337 "A String", 338 ], 339 "defaultBillingMode": "A String", # Default billing mode for the deployment and devices under it. 340 "displayName": "A String", # The deployment's display name. 341 "frns": [ # Output only. The FRNs copied from its direct parent. 342 "A String", 343 ], 344 "name": "A String", # Output only. Resource name. 345 "sasUserIds": [ # User ID used by the devices belonging to this deployment. Each deployment should be associated with one unique user ID. 346 "A String", 347 ], 348}</pre> 349</div> 350 351</body></html>