Method: customers.deployments.move
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
POST https://sasportal.googleapis.com/v1alpha1/{name=customers/*/deployments/*}:move
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
name |
string
Required. The name of the deployment to move.
|
Request body
The request body contains data with the following structure:
JSON representation |
{
"destination": string
} |
Fields |
destination |
string
Required. The name of the new parent resource node or customer to reparent the deployment under.
|
Response body
If successful, the response body contains an instance of Operation
.
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/sasportal
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2023-12-05 UTC.
[null,null,["Last updated 2023-12-05 UTC."],[[["\u003cp\u003eThis API moves a deployment under a new parent node or customer within the Spectrum Access System.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires specifying the deployment's name in the URL and the destination parent's name in the request body.\u003c/p\u003e\n"],["\u003cp\u003eA successful request will initiate an operation and return an Operation object in the response.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires the \u003ccode\u003ehttps://www.googleapis.com/auth/sasportal\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This document details the process for moving a deployment to a new parent resource. Key actions include using a `POST` request to the specified URL, including the deployment's name in the path. The request body must contain a `destination` field, which specifies the new parent node or customer. Successful requests return an `Operation` instance. Authorization requires the `https://www.googleapis.com/auth/sasportal` OAuth scope. The required path parameter is `name` and `destination` in the body.\n"],null,["# Method: customers.deployments.move\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization Scopes](#body.aspect)\n\nMoves a [deployment](/spectrum-access-system/reference/rest/v1alpha1/customers.deployments#Deployment) under another [node](/spectrum-access-system/reference/rest/v1alpha1/customers.nodes#Node) or [customer](/spectrum-access-system/reference/rest/v1alpha1/customers#Customer).\n\n### HTTP request\n\n`POST https://sasportal.googleapis.com/v1alpha1/{name=customers/*/deployments/*}:move`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|--------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Required. The name of the [deployment](/spectrum-access-system/reference/rest/v1alpha1/customers.deployments#Deployment) to move. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------|\n| ``` { \"destination\": string } ``` |\n\n| Fields ||\n|---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `destination` | `string` Required. The name of the new parent resource [node](/spectrum-access-system/reference/rest/v1alpha1/customers.nodes#Node) or [customer](/spectrum-access-system/reference/rest/v1alpha1/customers#Customer) to reparent the deployment under. |\n\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/spectrum-access-system/reference/rest/v1alpha1/Operation).\n\n### Authorization Scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/sasportal`"]]