Compute V1 Client - Class InstanceGroupManagersDeleteInstancesRequest (1.13.0)

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

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

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ instances array

The URLs of one or more instances to delete. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. Queued instances do not have URL and can be deleted only by name. One cannot specify both URLs and names in a single request.

↳ skip_instances_on_validation_error bool

Specifies whether the request should proceed despite the inclusion of instances that are not members of the group or that are already in the process of being deleted or abandoned. If this field is set to false and such an instance is specified in the request, the operation fails. The operation always fails if the request contains a malformed instance URL or a reference to an instance that exists in a zone or region other than the group's zone or region.

getInstances

The URLs of one or more instances to delete. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. Queued instances do not have URL and can be deleted only by name. One cannot specify both URLs and names in a single request.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setInstances

The URLs of one or more instances to delete. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. Queued instances do not have URL and can be deleted only by name. One cannot specify both URLs and names in a single request.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this

getSkipInstancesOnValidationError

Specifies whether the request should proceed despite the inclusion of instances that are not members of the group or that are already in the process of being deleted or abandoned. If this field is set to false and such an instance is specified in the request, the operation fails. The operation always fails if the request contains a malformed instance URL or a reference to an instance that exists in a zone or region other than the group's zone or region.

Returns
TypeDescription
bool

hasSkipInstancesOnValidationError

clearSkipInstancesOnValidationError

setSkipInstancesOnValidationError

Specifies whether the request should proceed despite the inclusion of instances that are not members of the group or that are already in the process of being deleted or abandoned. If this field is set to false and such an instance is specified in the request, the operation fails. The operation always fails if the request contains a malformed instance URL or a reference to an instance that exists in a zone or region other than the group's zone or region.

Parameter
NameDescription
var bool
Returns
TypeDescription
$this