Compute V1 Client - Class InstanceGroupManagerResizeRequest (1.20.0)

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

InstanceGroupManagerResizeRequest represents a request to create a number of VMs: either immediately or by queuing the request for the specified time. This resize request is nested under InstanceGroupManager and the VMs created by this request are added to the owning InstanceGroupManager.

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

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
dataarray

Optional. Data for populating the Message object.

↳ creation_timestampstring

[Output Only] The creation timestamp for this resize request in RFC3339 text format.

↳ descriptionstring

An optional description of this resource.

↳ idint|string

[Output Only] A unique identifier for this resource type. The server generates this identifier.

↳ kindstring

[Output Only] The resource type, which is always compute#instanceGroupManagerResizeRequest for resize requests.

↳ namestring

The name of this resize request. The name must be 1-63 characters long, and comply with RFC1035.

↳ requested_run_durationGoogle\Cloud\Compute\V1\Duration

Requested run duration for instances that will be created by this request. At the end of the run duration instance will be deleted.

↳ resize_byint

The number of instances to be created by this resize request. The group's target size will be increased by this number. This field cannot be used together with 'instances'.

↳ self_linkstring

[Output Only] The URL for this resize request. The server defines this URL.

↳ self_link_with_idstring

[Output Only] Server-defined URL for this resource with the resource id.

↳ statestring

[Output only] Current state of the request. Check the State enum for the list of possible values.

↳ statusGoogle\Cloud\Compute\V1\InstanceGroupManagerResizeRequestStatus

[Output only] Status of the request.

↳ zonestring

[Output Only] The URL of a zone where the resize request is located. Populated only for zonal resize requests.

getCreationTimestamp

[Output Only] The creation timestamp for this resize request in RFC3339 text format.

Returns
TypeDescription
string

hasCreationTimestamp

clearCreationTimestamp

setCreationTimestamp

[Output Only] The creation timestamp for this resize request in RFC3339 text format.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getDescription

An optional description of this resource.

Returns
TypeDescription
string

hasDescription

clearDescription

setDescription

An optional description of this resource.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getId

[Output Only] A unique identifier for this resource type. The server generates this identifier.

Returns
TypeDescription
int|string

hasId

clearId

setId

[Output Only] A unique identifier for this resource type. The server generates this identifier.

Parameter
NameDescription
varint|string
Returns
TypeDescription
$this

getKind

[Output Only] The resource type, which is always compute#instanceGroupManagerResizeRequest for resize requests.

Returns
TypeDescription
string

hasKind

clearKind

setKind

[Output Only] The resource type, which is always compute#instanceGroupManagerResizeRequest for resize requests.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getName

The name of this resize request. The name must be 1-63 characters long, and comply with RFC1035.

Returns
TypeDescription
string

hasName

clearName

setName

The name of this resize request. The name must be 1-63 characters long, and comply with RFC1035.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getRequestedRunDuration

Requested run duration for instances that will be created by this request. At the end of the run duration instance will be deleted.

Returns
TypeDescription
Google\Cloud\Compute\V1\Duration|null

hasRequestedRunDuration

clearRequestedRunDuration

setRequestedRunDuration

Requested run duration for instances that will be created by this request. At the end of the run duration instance will be deleted.

Parameter
NameDescription
varGoogle\Cloud\Compute\V1\Duration
Returns
TypeDescription
$this

getResizeBy

The number of instances to be created by this resize request. The group's target size will be increased by this number. This field cannot be used together with 'instances'.

Returns
TypeDescription
int

hasResizeBy

clearResizeBy

setResizeBy

The number of instances to be created by this resize request. The group's target size will be increased by this number. This field cannot be used together with 'instances'.

Parameter
NameDescription
varint
Returns
TypeDescription
$this

[Output Only] The URL for this resize request. The server defines this URL.

Returns
TypeDescription
string

[Output Only] The URL for this resize request. The server defines this URL.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getSelfLinkWithId

[Output Only] Server-defined URL for this resource with the resource id.

Returns
TypeDescription
string

hasSelfLinkWithId

clearSelfLinkWithId

setSelfLinkWithId

[Output Only] Server-defined URL for this resource with the resource id.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getState

[Output only] Current state of the request.

Check the State enum for the list of possible values.

Returns
TypeDescription
string

hasState

clearState

setState

[Output only] Current state of the request.

Check the State enum for the list of possible values.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getStatus

[Output only] Status of the request.

Returns
TypeDescription
Google\Cloud\Compute\V1\InstanceGroupManagerResizeRequestStatus|null

hasStatus

clearStatus

setStatus

[Output only] Status of the request.

Parameter
NameDescription
varGoogle\Cloud\Compute\V1\InstanceGroupManagerResizeRequestStatus
Returns
TypeDescription
$this

getZone

[Output Only] The URL of a zone where the resize request is located. Populated only for zonal resize requests.

Returns
TypeDescription
string

hasZone

clearZone

setZone

[Output Only] The URL of a zone where the resize request is located. Populated only for zonal resize requests.

Parameter
NameDescription
varstring
Returns
TypeDescription
$this