Compute V1 Client - Class StopInstancesInstanceGroupManagerRequest (1.22.0)

Reference documentation and code samples for the Compute V1 Client class StopInstancesInstanceGroupManagerRequest.

A request message for InstanceGroupManagers.StopInstances. See the method description for details.

Generated from protobuf message google.cloud.compute.v1.StopInstancesInstanceGroupManagerRequest

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ instance_group_manager string

The name of the managed instance group.

↳ instance_group_managers_stop_instances_request_resource InstanceGroupManagersStopInstancesRequest

The body resource for this request

↳ 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 where the managed instance group is located.

getInstanceGroupManager

The name of the managed instance group.

Returns
Type Description
string

setInstanceGroupManager

The name of the managed instance group.

Parameter
Name Description
var string
Returns
Type Description
$this

getInstanceGroupManagersStopInstancesRequestResource

The body resource for this request

Returns
Type Description
InstanceGroupManagersStopInstancesRequest|null

hasInstanceGroupManagersStopInstancesRequestResource

clearInstanceGroupManagersStopInstancesRequestResource

setInstanceGroupManagersStopInstancesRequestResource

The body resource for this request

Parameter
Name Description
var InstanceGroupManagersStopInstancesRequest
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).

Parameter
Name Description
var string
Returns
Type Description
$this

getZone

The name of the zone where the managed instance group is located.

Returns
Type Description
string

setZone

The name of the zone where the managed instance group is located.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameters
Name Description
project string

Project ID for this request.

zone string

The name of the zone where the managed instance group is located.

instanceGroupManager string

The name of the managed instance group.

instanceGroupManagersStopInstancesRequestResource InstanceGroupManagersStopInstancesRequest

The body resource for this request

Returns
Type Description
StopInstancesInstanceGroupManagerRequest