setScheduling method
Sets an instance's scheduling options.
You can only call this method on a stopped instance, that is, a VM
instance that is in a TERMINATED
state. See Instance Life Cycle for more
information on the possible instance states. For more information about
setting scheduling options for a VM, see Set VM host maintenance policy.
request
- The metadata request object.
Request parameters:
project
- Project ID for this request.
Value must have pattern
(?:(?:\[-a-z0-9\]{1,63}\.)*(?:\[a-z\](?:\[-a-z0-9\]{0,61}\[a-z0-9\])?):)?(?:\[0-9\]{1,19}|(?:\[a-z0-9\](?:\[-a-z0-9\]{0,61}\[a-z0-9\])?))
.
zone
- The name of the zone for this request.
Value must have pattern \[a-z\](?:\[-a-z0-9\]{0,61}\[a-z0-9\])?
.
instance
- Instance name for this request.
Value must have pattern
\[a-z\](?:\[-a-z0-9\]{0,61}\[a-z0-9\])?|\[1-9\]\[0-9\]{0,19}
.
requestId
- An optional request ID to identify requests. Specify a
unique request ID so that if you must retry your request, the server will
know to ignore the request if it has already been completed. For example,
consider a situation where you make an initial request and the request
times out. If you make the request again with the same request ID, the
server can check if original operation with the same request ID was
received, and if so, will ignore the second request. This prevents clients
from accidentally creating duplicate commitments. The request ID must be a
valid UUID with the exception that zero UUID is not supported (
00000000-0000-0000-0000-000000000000).
$fields
- Selector specifying which fields to include in a partial
response.
Completes with a Operation.
Completes with a commons.ApiRequestError if the API endpoint returned an error.
If the used http.Client
completes with an error when making a REST call,
this method will complete with the same error.
Implementation
async.Future<Operation> setScheduling(
Scheduling request,
core.String project,
core.String zone,
core.String instance, {
core.String? requestId,
core.String? $fields,
}) async {
final body_ = convert.json.encode(request);
final queryParams_ = <core.String, core.List<core.String>>{
if (requestId != null) 'requestId': [requestId],
if ($fields != null) 'fields': [$fields],
};
final url_ = 'projects/' +
commons.escapeVariable('$project') +
'/zones/' +
commons.escapeVariable('$zone') +
'/instances/' +
commons.escapeVariable('$instance') +
'/setScheduling';
final response_ = await _requester.request(
url_,
'POST',
body: body_,
queryParams: queryParams_,
);
return Operation.fromJson(response_ as core.Map<core.String, core.dynamic>);
}