Reference documentation and code samples for the Compute V1 Client class StopInstanceRequest.
A request message for Instances.Stop. See the method description for details.
Generated from protobuf message google.cloud.compute.v1.StopInstanceRequest
Namespace
Google \ Cloud \ Compute \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ discard_local_ssd
bool
This property is required if the instance has any attached Local SSD disks. If false, Local SSD data will be preserved when the instance is suspended. If true, the contents of any attached Local SSD disks will be discarded.
↳ instance
string
Name of the instance resource to stop.
↳ project
string
Project ID for this request.
↳ request_id
string
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).
↳ zone
string
The name of the zone for this request.
getDiscardLocalSsd
This property is required if the instance has any attached Local SSD disks. If false, Local SSD data will be preserved when the instance is suspended. If true, the contents of any attached Local SSD disks will be discarded.
Returns
Type
Description
bool
hasDiscardLocalSsd
clearDiscardLocalSsd
setDiscardLocalSsd
This property is required if the instance has any attached Local SSD disks. If false, Local SSD data will be preserved when the instance is suspended. If true, the contents of any attached Local SSD disks will be discarded.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
getInstance
Name of the instance resource to stop.
Returns
Type
Description
string
setInstance
Name of the instance resource to stop.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getProject
Project ID for this request.
Returns
Type
Description
string
setProject
Project ID for this request.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getRequestId
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).
Returns
Type
Description
string
hasRequestId
clearRequestId
setRequestId
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).
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Compute V1 Client - Class StopInstanceRequest (1.35.0)\n\nVersion latestkeyboard_arrow_down\n\n- [1.35.0 (latest)](/php/docs/reference/cloud-compute/latest/V1.StopInstanceRequest)\n- [1.34.0](/php/docs/reference/cloud-compute/1.34.0/V1.StopInstanceRequest)\n- [1.33.0](/php/docs/reference/cloud-compute/1.33.0/V1.StopInstanceRequest)\n- [1.32.0](/php/docs/reference/cloud-compute/1.32.0/V1.StopInstanceRequest)\n- [1.31.0](/php/docs/reference/cloud-compute/1.31.0/V1.StopInstanceRequest)\n- [1.30.0](/php/docs/reference/cloud-compute/1.30.0/V1.StopInstanceRequest)\n- [1.29.0](/php/docs/reference/cloud-compute/1.29.0/V1.StopInstanceRequest)\n- [1.28.0](/php/docs/reference/cloud-compute/1.28.0/V1.StopInstanceRequest)\n- [1.27.0](/php/docs/reference/cloud-compute/1.27.0/V1.StopInstanceRequest)\n- [1.26.0](/php/docs/reference/cloud-compute/1.26.0/V1.StopInstanceRequest)\n- [1.25.0](/php/docs/reference/cloud-compute/1.25.0/V1.StopInstanceRequest)\n- [1.24.0](/php/docs/reference/cloud-compute/1.24.0/V1.StopInstanceRequest)\n- [1.23.0](/php/docs/reference/cloud-compute/1.23.0/V1.StopInstanceRequest)\n- [1.22.1](/php/docs/reference/cloud-compute/1.22.1/V1.StopInstanceRequest)\n- [1.21.0](/php/docs/reference/cloud-compute/1.21.0/V1.StopInstanceRequest)\n- [1.20.0](/php/docs/reference/cloud-compute/1.20.0/V1.StopInstanceRequest)\n- [1.19.0](/php/docs/reference/cloud-compute/1.19.0/V1.StopInstanceRequest)\n- [1.18.1](/php/docs/reference/cloud-compute/1.18.1/V1.StopInstanceRequest)\n- [1.17.0](/php/docs/reference/cloud-compute/1.17.0/V1.StopInstanceRequest)\n- [1.16.2](/php/docs/reference/cloud-compute/1.16.2/V1.StopInstanceRequest)\n- [1.14.0](/php/docs/reference/cloud-compute/1.14.0/V1.StopInstanceRequest)\n- [1.13.0](/php/docs/reference/cloud-compute/1.13.0/V1.StopInstanceRequest)\n- [1.12.1](/php/docs/reference/cloud-compute/1.12.1/V1.StopInstanceRequest)\n- [1.11.1](/php/docs/reference/cloud-compute/1.11.1/V1.StopInstanceRequest)\n- [1.10.1](/php/docs/reference/cloud-compute/1.10.1/V1.StopInstanceRequest)\n- [1.9.1](/php/docs/reference/cloud-compute/1.9.1/V1.StopInstanceRequest)\n- [1.8.3](/php/docs/reference/cloud-compute/1.8.3/V1.StopInstanceRequest)\n- [1.7.1](/php/docs/reference/cloud-compute/1.7.1/V1.StopInstanceRequest)\n- [1.6.1](/php/docs/reference/cloud-compute/1.6.1/V1.StopInstanceRequest)\n- [1.5.0](/php/docs/reference/cloud-compute/1.5.0/V1.StopInstanceRequest) \nReference documentation and code samples for the Compute V1 Client class StopInstanceRequest.\n\nA request message for Instances.Stop. See the method description for details.\n\nGenerated from protobuf message `google.cloud.compute.v1.StopInstanceRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Compute \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getDiscardLocalSsd\n\nThis property is required if the instance has any attached Local SSD disks. If false, Local SSD data will be preserved when the instance is suspended. If true, the contents of any attached Local SSD disks will be discarded.\n\n### hasDiscardLocalSsd\n\n### clearDiscardLocalSsd\n\n### setDiscardLocalSsd\n\nThis property is required if the instance has any attached Local SSD disks. If false, Local SSD data will be preserved when the instance is suspended. If true, the contents of any attached Local SSD disks will be discarded.\n\n### getInstance\n\nName of the instance resource to stop.\n\n### setInstance\n\nName of the instance resource to stop.\n\n### getProject\n\nProject ID for this request.\n\n### setProject\n\nProject ID for this request.\n\n### getRequestId\n\nAn 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).\n\n### hasRequestId\n\n### clearRequestId\n\n### setRequestId\n\nAn 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).\n\n### getZone\n\nThe name of the zone for this request.\n\n### setZone\n\nThe name of the zone for this request.\n\n### static::build"]]
