region_instance_group_manager_resize_requests

Creates, updates, deletes, gets or lists a region_instance_group_manager_resize_requests resource.

Overview

Name	region_instance_group_manager_resize_requests
Type	Resource
Id	google.compute.region_instance_group_manager_resize_requests

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string (uint64)	Output only. A unique identifier for this resource type. The server generates this identifier.
name	string	The name of this resize request. The name must be 1-63 characters long, and comply withRFC1035. (pattern: [a-z](?:[-a-z0-9]{0,61}[a-z0-9])?)
creationTimestamp	string	Output only. The creation timestamp for this resize request inRFC3339 text format.
description	string	An optional description of this resource.
instances	array	The names of instances to be created by this resize request. The number of names specified determines the number of instances to create. The group's target size will be increased by this number. This field cannot be used together with 'resize_by'.
kind	string	Output only. The resource type, which is alwayscompute#instanceGroupManagerResizeRequest for resize requests. (default: compute#instanceGroupManagerResizeRequest)
region	string	Output only. The URL of a region where the resize request is located. Populated only for regional resize requests.
requestedRunDuration	object	A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. (id: Duration)
resizeBy	integer (int32)	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'.
selfLink	string	Output only. The URL for this resize request. The server defines this URL.
selfLinkWithId	string	Output only. Server-defined URL for this resource with the resource id.
state	string	Output only. Current state of the request. (ACCEPTED, CANCELLED, CREATING, FAILED, STATE_UNSPECIFIED, SUCCEEDED)
status	object	Output only. Status of the request. (id: InstanceGroupManagerResizeRequestStatus)
zone	string	Output only. The URL of a zone where the resize request is located. Populated only for zonal resize requests.

list

Name	Datatype	Description
id	string	Output only. Unique identifier for the resource; defined by the server.
etag	string
items	array	A list of Resize Request resources.
kind	string	Output only. Type of the resource. Alwayscompute#regionInstanceGroupManagerResizeRequestList for a list of Resize Requests. (default: compute#regionInstanceGroupManagerResizeRequestList)
nextPageToken	string	Output only. This token allows you to get the next page of results for list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLink	string	Output only. Server-defined URL for this resource.
unreachables	array	Output only. Unreachable resources. end_interface: MixerListResponseWithEtagBuilder
warning	object	Output only. Informational warning message.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	project, region, instanceGroupManager, resizeRequest		Returns all of the details about the specified resize request.
list	select	project, region, instanceGroupManager	filter, maxResults, pageToken, orderBy, returnPartialSuccess	Retrieves a list of Resize Requests that are contained in the managed instance group.
insert	insert	project, region, instanceGroupManager	requestId	Creates a new Resize Request that starts provisioning VMs immediately or queues VM creation.
delete	delete	project, region, instanceGroupManager, resizeRequest	requestId	Deletes the specified, inactive resize request. Requests that are still active cannot be deleted. Deleting request does not delete instances that were provisioned previously.
cancel	exec	project, region, instanceGroupManager, resizeRequest	requestId	Cancels the specified resize request. Cancelled resize request no longer waits for the resources to be provisioned. Cancel is only possible for requests that are in accepted state.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
instanceGroupManager	string
project	string
region	string
resizeRequest	string
filter	string
maxResults	integer (uint32)
orderBy	string
pageToken	string
requestId	string
returnPartialSuccess	boolean

SELECT examples

get

Returns all of the details about the specified resize request.

SELECT
id,
name,
creationTimestamp,
description,
instances,
kind,
region,
requestedRunDuration,
resizeBy,
selfLink,
selfLinkWithId,
state,
status,
zone
FROM google.compute.region_instance_group_manager_resize_requests
WHERE project = '{{ project }}' -- required
AND region = '{{ region }}' -- required
AND instanceGroupManager = '{{ instanceGroupManager }}' -- required
AND resizeRequest = '{{ resizeRequest }}' -- required
;

list

Retrieves a list of Resize Requests that are contained in the
managed instance group.

SELECT
id,
etag,
items,
kind,
nextPageToken,
selfLink,
unreachables,
warning
FROM google.compute.region_instance_group_manager_resize_requests
WHERE project = '{{ project }}' -- required
AND region = '{{ region }}' -- required
AND instanceGroupManager = '{{ instanceGroupManager }}' -- required
AND filter = '{{ filter }}'
AND maxResults = '{{ maxResults }}'
AND pageToken = '{{ pageToken }}'
AND orderBy = '{{ orderBy }}'
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
;

INSERT examples

insert

Creates a new Resize Request that starts provisioning VMs immediately
or queues VM creation.

INSERT INTO google.compute.region_instance_group_manager_resize_requests (
data__requestedRunDuration,
data__description,
data__instances,
data__resizeBy,
data__name,
project,
region,
instanceGroupManager,
requestId
)
SELECT 
'{{ requestedRunDuration }}',
'{{ description }}',
'{{ instances }}',
{{ resizeBy }},
'{{ name }}',
'{{ project }}',
'{{ region }}',
'{{ instanceGroupManager }}',
'{{ requestId }}'
RETURNING
id,
name,
clientOperationId,
creationTimestamp,
description,
endTime,
error,
getVersionOperationMetadata,
httpErrorMessage,
httpErrorStatusCode,
insertTime,
instancesBulkInsertOperationMetadata,
kind,
operationGroupId,
operationType,
progress,
region,
selfLink,
setCommonInstanceMetadataOperationMetadata,
startTime,
status,
statusMessage,
targetId,
targetLink,
user,
warnings,
zone
;

Manifest

# Description fields are for documentation purposes
- name: region_instance_group_manager_resize_requests
props:
  - name: project
    value: "{{ project }}"
    description: Required parameter for the region_instance_group_manager_resize_requests resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the region_instance_group_manager_resize_requests resource.
  - name: instanceGroupManager
    value: "{{ instanceGroupManager }}"
    description: Required parameter for the region_instance_group_manager_resize_requests resource.
  - name: requestedRunDuration
    description: |
      A Duration represents a fixed-length span of time represented
      as a count of seconds and fractions of seconds at nanosecond
      resolution. It is independent of any calendar and concepts like "day"
      or "month". Range is approximately 10,000 years.
    value:
      nanos: {{ nanos }}
      seconds: "{{ seconds }}"
  - name: description
    value: "{{ description }}"
    description: |
      An optional description of this resource.
  - name: instances
    description: |
      The names of instances to be created by this resize request. The number of
      names specified determines the number of instances to create. The group's
      target size will be increased by this number. This field cannot be used
      together with 'resize_by'.
    value:
      - name: "{{ name }}"
        status: "{{ status }}"
        preservedState:
          disks: "{{ disks }}"
          internalIPs: "{{ internalIPs }}"
          metadata: "{{ metadata }}"
          externalIPs: "{{ externalIPs }}"
        fingerprint: "{{ fingerprint }}"
  - name: resizeBy
    value: {{ resizeBy }}
    description: |
      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'.
  - name: name
    value: "{{ name }}"
    description: |
      The name of this resize request. The name must be 1-63 characters
      long, and comply withRFC1035.
  - name: requestId
    value: "{{ requestId }}"

DELETE examples

delete

Deletes the specified, inactive resize request. Requests that are still
active cannot be deleted. Deleting request does not delete instances that
were provisioned previously.

DELETE FROM google.compute.region_instance_group_manager_resize_requests
WHERE project = '{{ project }}' --required
AND region = '{{ region }}' --required
AND instanceGroupManager = '{{ instanceGroupManager }}' --required
AND resizeRequest = '{{ resizeRequest }}' --required
AND requestId = '{{ requestId }}'
;

Lifecycle Methods

cancel

Cancels the specified resize request.
Cancelled resize request no longer waits for the resources to be
provisioned. Cancel is only possible for requests that are in accepted
state.

EXEC google.compute.region_instance_group_manager_resize_requests.cancel 
@project='{{ project }}' --required, 
@region='{{ region }}' --required, 
@instanceGroupManager='{{ instanceGroupManager }}' --required, 
@resizeRequest='{{ resizeRequest }}' --required, 
@requestId='{{ requestId }}'
;