Reference documentation and code samples for the Compute V1 Client class RemoveInstancesInstanceGroupRequest.
A request message for InstanceGroups.RemoveInstances. See the method description for details.
Generated from protobuf message google.cloud.compute.v1.RemoveInstancesInstanceGroupRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ instance_group |
string
The name of the instance group where the specified instances will be removed. |
↳ instance_groups_remove_instances_request_resource |
Google\Cloud\Compute\V1\InstanceGroupsRemoveInstancesRequest
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 instance group is located. |
getInstanceGroup
The name of the instance group where the specified instances will be removed.
| Returns | |
|---|---|
| Type | Description |
string | |
setInstanceGroup
The name of the instance group where the specified instances will be removed.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getInstanceGroupsRemoveInstancesRequestResource
The body resource for this request
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Compute\V1\InstanceGroupsRemoveInstancesRequest|null | |
hasInstanceGroupsRemoveInstancesRequestResource
clearInstanceGroupsRemoveInstancesRequestResource
setInstanceGroupsRemoveInstancesRequestResource
The body resource for this request
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Compute\V1\InstanceGroupsRemoveInstancesRequest
|
| 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 instance group is located.
| Returns | |
|---|---|
| Type | Description |
string | |
setZone
The name of the zone where the instance group is located.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |