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 \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ creation_timestamp |
string
[Output Only] The creation timestamp for this resize request in RFC3339 text format. |
↳ description |
string
An optional description of this resource. |
↳ id |
int|string
[Output Only] A unique identifier for this resource type. The server generates this identifier. |
↳ kind |
string
[Output Only] The resource type, which is always compute#instanceGroupManagerResizeRequest for resize requests. |
↳ name |
string
The name of this resize request. The name must be 1-63 characters long, and comply with RFC1035. |
↳ requested_run_duration |
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_by |
int
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_link |
string
[Output Only] The URL for this resize request. The server defines this URL. |
↳ self_link_with_id |
string
[Output Only] Server-defined URL for this resource with the resource id. |
↳ state |
string
[Output only] Current state of the request. Check the State enum for the list of possible values. |
↳ status |
InstanceGroupManagerResizeRequestStatus
[Output only] Status of the request. |
↳ zone |
string
[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 | |
|---|---|
| Type | Description |
string |
|
hasCreationTimestamp
clearCreationTimestamp
setCreationTimestamp
[Output Only] The creation timestamp for this resize request in RFC3339 text format.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDescription
An optional description of this resource.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasDescription
clearDescription
setDescription
An optional description of this resource.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getId
[Output Only] A unique identifier for this resource type. The server generates this identifier.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasId
clearId
setId
[Output Only] A unique identifier for this resource type. The server generates this identifier.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getKind
[Output Only] The resource type, which is always compute#instanceGroupManagerResizeRequest for resize requests.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasKind
clearKind
setKind
[Output Only] The resource type, which is always compute#instanceGroupManagerResizeRequest for resize requests.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getName
The name of this resize request. The name must be 1-63 characters long, and comply with RFC1035.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasName
clearName
setName
The name of this resize request. The name must be 1-63 characters long, and comply with RFC1035.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
Duration
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSelfLink
[Output Only] The URL for this resize request. The server defines this URL.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasSelfLink
clearSelfLink
setSelfLink
[Output Only] The URL for this resize request. The server defines this URL.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSelfLinkWithId
[Output Only] Server-defined URL for this resource with the resource id.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasSelfLinkWithId
clearSelfLinkWithId
setSelfLinkWithId
[Output Only] Server-defined URL for this resource with the resource id.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getState
[Output only] Current state of the request.
Check the State enum for the list of possible values.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasState
clearState
setState
[Output only] Current state of the request.
Check the State enum for the list of possible values.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStatus
[Output only] Status of the request.
| Returns | |
|---|---|
| Type | Description |
InstanceGroupManagerResizeRequestStatus|null |
|
hasStatus
clearStatus
setStatus
[Output only] Status of the request.
| Parameter | |
|---|---|
| Name | Description |
var |
InstanceGroupManagerResizeRequestStatus
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getZone
[Output Only] The URL of a zone where the resize request is located. Populated only for zonal resize requests.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasZone
clearZone
setZone
[Output Only] The URL of a zone where the resize request is located. Populated only for zonal resize requests.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|