InstanceGroupManager (Compute Engine API alpha-rev20201019-1.30.10)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.compute.model.InstanceGroupManager

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class InstanceGroupManager
extends GenericJson
```
Represents a Managed Instance Group resource. An instance group is a collection of VM instances that you can manage as a single entity. For more information, read Instance groups. For zonal Managed Instance Group, use the instanceGroupManagers resource. For regional Managed Instance Group, use the regionInstanceGroupManagers resource. (== resource_for {$api_version}.instanceGroupManagers ==) (== resource_for {$api_version}.regionInstanceGroupManagers ==)
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

InstanceGroupManager()

Constructors
Constructor and Description
`InstanceGroupManager()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`InstanceGroupManager`	`clone()`
`byte[]`	`decodeFingerprint()` Fingerprint of this resource.
`InstanceGroupManager`	`encodeFingerprint(byte[] fingerprint)` Fingerprint of this resource.
`List<InstanceGroupManagerAutoHealingPolicy>`	`getAutoHealingPolicies()` The autohealing policy for this managed instance group.
`String`	`getBaseInstanceName()` The base instance name to use for instances in this group.
`String`	`getCreationTimestamp()` [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
`InstanceGroupManagerActionsSummary`	`getCurrentActions()` [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
`String`	`getDescription()` An optional description of this resource.
`DistributionPolicy`	`getDistributionPolicy()` Policy specifying intended distribution of instances in regional managed instance group.
`String`	`getFailoverAction()` The action to perform in case of zone failure.
`String`	`getFingerprint()` Fingerprint of this resource.
`BigInteger`	`getId()` [Output Only] A unique identifier for this resource type.
`String`	`getInstanceGroup()` [Output Only] The URL of the Instance Group resource.
`String`	`getInstanceTemplate()` The URL of the instance template that is specified for this managed instance group.
`String`	`getKind()` [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
`String`	`getName()` The name of the managed instance group.
`List<NamedPort>`	`getNamedPorts()` Named ports configured for the Instance Groups complementary to this Instance Group Manager.
`InstanceGroupManagerPendingActionsSummary`	`getPendingActions()` [Deprecated] This field is deprecated and will be removed.
`String`	`getRegion()` [Output Only] The URL of the region where the managed instance group resides (for regional resources).
`String`	`getSelfLink()` [Output Only] The URL for this managed instance group.
`String`	`getSelfLinkWithId()` [Output Only] Server-defined URL for this resource with the resource id.
`String`	`getServiceAccount()` The service account to be used as credentials for all operations performed by the managed instance group on instances.
`StatefulPolicy`	`getStatefulPolicy()` Stateful configuration for this Instanced Group Manager
`InstanceGroupManagerStatus`	`getStatus()` [Output Only] The status of this managed instance group.
`List<String>`	`getTargetPools()` The URLs for all TargetPool resources to which instances in the instanceGroup field are added.
`Integer`	`getTargetSize()` The target number of running instances for this managed instance group.
`InstanceGroupManagerUpdatePolicy`	`getUpdatePolicy()` The update policy for this managed instance group.
`List<InstanceGroupManagerVersion>`	`getVersions()` Specifies the instance templates used by this managed instance group to create instances.
`String`	`getZone()` [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
`InstanceGroupManager`	`set(String fieldName, Object value)`
`InstanceGroupManager`	`setAutoHealingPolicies(List<InstanceGroupManagerAutoHealingPolicy> autoHealingPolicies)` The autohealing policy for this managed instance group.
`InstanceGroupManager`	`setBaseInstanceName(String baseInstanceName)` The base instance name to use for instances in this group.
`InstanceGroupManager`	`setCreationTimestamp(String creationTimestamp)` [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
`InstanceGroupManager`	`setCurrentActions(InstanceGroupManagerActionsSummary currentActions)` [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
`InstanceGroupManager`	`setDescription(String description)` An optional description of this resource.
`InstanceGroupManager`	`setDistributionPolicy(DistributionPolicy distributionPolicy)` Policy specifying intended distribution of instances in regional managed instance group.
`InstanceGroupManager`	`setFailoverAction(String failoverAction)` The action to perform in case of zone failure.
`InstanceGroupManager`	`setFingerprint(String fingerprint)` Fingerprint of this resource.
`InstanceGroupManager`	`setId(BigInteger id)` [Output Only] A unique identifier for this resource type.
`InstanceGroupManager`	`setInstanceGroup(String instanceGroup)` [Output Only] The URL of the Instance Group resource.
`InstanceGroupManager`	`setInstanceTemplate(String instanceTemplate)` The URL of the instance template that is specified for this managed instance group.
`InstanceGroupManager`	`setKind(String kind)` [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
`InstanceGroupManager`	`setName(String name)` The name of the managed instance group.
`InstanceGroupManager`	`setNamedPorts(List<NamedPort> namedPorts)` Named ports configured for the Instance Groups complementary to this Instance Group Manager.
`InstanceGroupManager`	`setPendingActions(InstanceGroupManagerPendingActionsSummary pendingActions)` [Deprecated] This field is deprecated and will be removed.
`InstanceGroupManager`	`setRegion(String region)` [Output Only] The URL of the region where the managed instance group resides (for regional resources).
`InstanceGroupManager`	`setSelfLink(String selfLink)` [Output Only] The URL for this managed instance group.
`InstanceGroupManager`	`setSelfLinkWithId(String selfLinkWithId)` [Output Only] Server-defined URL for this resource with the resource id.
`InstanceGroupManager`	`setServiceAccount(String serviceAccount)` The service account to be used as credentials for all operations performed by the managed instance group on instances.
`InstanceGroupManager`	`setStatefulPolicy(StatefulPolicy statefulPolicy)` Stateful configuration for this Instanced Group Manager
`InstanceGroupManager`	`setStatus(InstanceGroupManagerStatus status)` [Output Only] The status of this managed instance group.
`InstanceGroupManager`	`setTargetPools(List<String> targetPools)` The URLs for all TargetPool resources to which instances in the instanceGroup field are added.
`InstanceGroupManager`	`setTargetSize(Integer targetSize)` The target number of running instances for this managed instance group.
`InstanceGroupManager`	`setUpdatePolicy(InstanceGroupManagerUpdatePolicy updatePolicy)` The update policy for this managed instance group.
`InstanceGroupManager`	`setVersions(List<InstanceGroupManagerVersion> versions)` Specifies the instance templates used by this managed instance group to create instances.
`InstanceGroupManager`	`setZone(String zone)` [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - InstanceGroupManager
```
public InstanceGroupManager()
```
- Method Detail
  - getAutoHealingPolicies
```
public List<InstanceGroupManagerAutoHealingPolicy> getAutoHealingPolicies()
```
    The autohealing policy for this managed instance group. You can specify only one value.
    
    Returns:
    
    value or null for none
  - setAutoHealingPolicies
```
public InstanceGroupManager setAutoHealingPolicies(List<InstanceGroupManagerAutoHealingPolicy> autoHealingPolicies)
```
    The autohealing policy for this managed instance group. You can specify only one value.
    
    Parameters:
    
    autoHealingPolicies - autoHealingPolicies or null for none
  - getBaseInstanceName
```
public String getBaseInstanceName()
```
    The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
    
    Returns:
    
    value or null for none
  - setBaseInstanceName
```
public InstanceGroupManager setBaseInstanceName(String baseInstanceName)
```
    The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.
    
    Parameters:
    
    baseInstanceName - baseInstanceName or null for none
  - getCreationTimestamp
```
public String getCreationTimestamp()
```
    [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
    
    Returns:
    
    value or null for none
  - setCreationTimestamp
```
public InstanceGroupManager setCreationTimestamp(String creationTimestamp)
```
    [Output Only] The creation timestamp for this managed instance group in RFC3339 text format.
    
    Parameters:
    
    creationTimestamp - creationTimestamp or null for none
  - getCurrentActions
```
public InstanceGroupManagerActionsSummary getCurrentActions()
```
    [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
    
    Returns:
    
    value or null for none
  - setCurrentActions
```
public InstanceGroupManager setCurrentActions(InstanceGroupManagerActionsSummary currentActions)
```
    [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions.
    
    Parameters:
    
    currentActions - currentActions or null for none
  - getDescription
```
public String getDescription()
```
    An optional description of this resource. Provide this property when you create the resource.
    
    Returns:
    
    value or null for none
  - setDescription
```
public InstanceGroupManager setDescription(String description)
```
    An optional description of this resource. Provide this property when you create the resource.
    
    Parameters:
    
    description - description or null for none
  - getDistributionPolicy
```
public DistributionPolicy getDistributionPolicy()
```
    Policy specifying intended distribution of instances in regional managed instance group.
    
    Returns:
    
    value or null for none
  - setDistributionPolicy
```
public InstanceGroupManager setDistributionPolicy(DistributionPolicy distributionPolicy)
```
    Policy specifying intended distribution of instances in regional managed instance group.
    
    Parameters:
    
    distributionPolicy - distributionPolicy or null for none
  - getFailoverAction
```
public String getFailoverAction()
```
    The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
    
    Returns:
    
    value or null for none
  - setFailoverAction
```
public InstanceGroupManager setFailoverAction(String failoverAction)
```
    The action to perform in case of zone failure. Only one value is supported, NO_FAILOVER. The default is NO_FAILOVER.
    
    Parameters:
    
    failoverAction - failoverAction or null for none
  - getFingerprint
```
public String getFingerprint()
```
    Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.
    
    Returns:
    
    value or null for none
    
    See Also:
    
    decodeFingerprint()
  - decodeFingerprint
```
public byte[] decodeFingerprint()
```
    Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.
    
    Returns:
    
    Base64 decoded value or null for none
    
    Since:
    
    1.14
    
    See Also:
    
    getFingerprint()
  - setFingerprint
```
public InstanceGroupManager setFingerprint(String fingerprint)
```
    Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.
    
    Parameters:
    
    fingerprint - fingerprint or null for none
    
    See Also:
    
    #encodeFingerprint()
  - encodeFingerprint
```
public InstanceGroupManager encodeFingerprint(byte[] fingerprint)
```
    Fingerprint of this resource. This field may be used in optimistic locking. It will be ignored when inserting an InstanceGroupManager. An up-to-date fingerprint must be provided in order to update the InstanceGroupManager, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve an InstanceGroupManager.
    
    Since:
    
    1.14
    
    See Also:
    
    The value is encoded Base64 or {@code null} for none.
  - getId
```
public BigInteger getId()
```
    [Output Only] A unique identifier for this resource type. The server generates this identifier.
    
    Returns:
    
    value or null for none
  - setId
```
public InstanceGroupManager setId(BigInteger id)
```
    [Output Only] A unique identifier for this resource type. The server generates this identifier.
    
    Parameters:
    
    id - id or null for none
  - getInstanceGroup
```
public String getInstanceGroup()
```
    [Output Only] The URL of the Instance Group resource.
    
    Returns:
    
    value or null for none
  - setInstanceGroup
```
public InstanceGroupManager setInstanceGroup(String instanceGroup)
```
    [Output Only] The URL of the Instance Group resource.
    
    Parameters:
    
    instanceGroup - instanceGroup or null for none
  - getInstanceTemplate
```
public String getInstanceTemplate()
```
    The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
    
    Returns:
    
    value or null for none
  - setInstanceTemplate
```
public InstanceGroupManager setInstanceTemplate(String instanceTemplate)
```
    The URL of the instance template that is specified for this managed instance group. The group uses this template to create all new instances in the managed instance group.
    
    Parameters:
    
    instanceTemplate - instanceTemplate or null for none
  - getKind
```
public String getKind()
```
    [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
    
    Returns:
    
    value or null for none
  - setKind
```
public InstanceGroupManager setKind(String kind)
```
    [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
    
    Parameters:
    
    kind - kind or null for none
  - getName
```
public String getName()
```
    The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
    
    Returns:
    
    value or null for none
  - setName
```
public InstanceGroupManager setName(String name)
```
    The name of the managed instance group. The name must be 1-63 characters long, and comply with RFC1035.
    
    Parameters:
    
    name - name or null for none
  - getNamedPorts
```
public List<NamedPort> getNamedPorts()
```
    Named ports configured for the Instance Groups complementary to this Instance Group Manager.
    
    Returns:
    
    value or null for none
  - setNamedPorts
```
public InstanceGroupManager setNamedPorts(List<NamedPort> namedPorts)
```
    Named ports configured for the Instance Groups complementary to this Instance Group Manager.
    
    Parameters:
    
    namedPorts - namedPorts or null for none
  - getPendingActions
```
public InstanceGroupManagerPendingActionsSummary getPendingActions()
```
    [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions.
    
    Returns:
    
    value or null for none
  - setPendingActions
```
public InstanceGroupManager setPendingActions(InstanceGroupManagerPendingActionsSummary pendingActions)
```
    [Deprecated] This field is deprecated and will be removed. Prefer using the status field instead. Please contact cloud-updater-feedback@google.com to leave feedback if your workload relies on this field. [Output Only] The list of instance actions and the number of instances in this managed instance group that are pending for each of those actions.
    
    Parameters:
    
    pendingActions - pendingActions or null for none
  - getRegion
```
public String getRegion()
```
    [Output Only] The URL of the region where the managed instance group resides (for regional resources).
    
    Returns:
    
    value or null for none
  - setRegion
```
public InstanceGroupManager setRegion(String region)
```
    [Output Only] The URL of the region where the managed instance group resides (for regional resources).
    
    Parameters:
    
    region - region or null for none
  - getSelfLink
```
public String getSelfLink()
```
    [Output Only] The URL for this managed instance group. The server defines this URL.
    
    Returns:
    
    value or null for none
  - setSelfLink
```
public InstanceGroupManager setSelfLink(String selfLink)
```
    [Output Only] The URL for this managed instance group. The server defines this URL.
    
    Parameters:
    
    selfLink - selfLink or null for none
  - getSelfLinkWithId
```
public String getSelfLinkWithId()
```
    [Output Only] Server-defined URL for this resource with the resource id.
    
    Returns:
    
    value or null for none
  - setSelfLinkWithId
```
public InstanceGroupManager setSelfLinkWithId(String selfLinkWithId)
```
    [Output Only] Server-defined URL for this resource with the resource id.
    
    Parameters:
    
    selfLinkWithId - selfLinkWithId or null for none
  - getServiceAccount
```
public String getServiceAccount()
```
    The service account to be used as credentials for all operations performed by the managed instance group on instances. The service accounts needs all permissions required to create and delete instances. By default, the service account {projectNumber}@cloudservices.gserviceaccount.com is used.
    
    Returns:
    
    value or null for none
  - setServiceAccount
```
public InstanceGroupManager setServiceAccount(String serviceAccount)
```
    The service account to be used as credentials for all operations performed by the managed instance group on instances. The service accounts needs all permissions required to create and delete instances. By default, the service account {projectNumber}@cloudservices.gserviceaccount.com is used.
    
    Parameters:
    
    serviceAccount - serviceAccount or null for none
  - getStatefulPolicy
```
public StatefulPolicy getStatefulPolicy()
```
    Stateful configuration for this Instanced Group Manager
    
    Returns:
    
    value or null for none
  - setStatefulPolicy
```
public InstanceGroupManager setStatefulPolicy(StatefulPolicy statefulPolicy)
```
    Stateful configuration for this Instanced Group Manager
    
    Parameters:
    
    statefulPolicy - statefulPolicy or null for none
  - getStatus
```
public InstanceGroupManagerStatus getStatus()
```
    [Output Only] The status of this managed instance group.
    
    Returns:
    
    value or null for none
  - setStatus
```
public InstanceGroupManager setStatus(InstanceGroupManagerStatus status)
```
    [Output Only] The status of this managed instance group.
    
    Parameters:
    
    status - status or null for none
  - getTargetPools
```
public List<String> getTargetPools()
```
    The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
    
    Returns:
    
    value or null for none
  - setTargetPools
```
public InstanceGroupManager setTargetPools(List<String> targetPools)
```
    The URLs for all TargetPool resources to which instances in the instanceGroup field are added. The target pools automatically apply to all of the instances in the managed instance group.
    
    Parameters:
    
    targetPools - targetPools or null for none
  - getTargetSize
```
public Integer getTargetSize()
```
    The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number.
    
    Returns:
    
    value or null for none
  - setTargetSize
```
public InstanceGroupManager setTargetSize(Integer targetSize)
```
    The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number.
    
    Parameters:
    
    targetSize - targetSize or null for none
  - getUpdatePolicy
```
public InstanceGroupManagerUpdatePolicy getUpdatePolicy()
```
    The update policy for this managed instance group.
    
    Returns:
    
    value or null for none
  - setUpdatePolicy
```
public InstanceGroupManager setUpdatePolicy(InstanceGroupManagerUpdatePolicy updatePolicy)
```
    The update policy for this managed instance group.
    
    Parameters:
    
    updatePolicy - updatePolicy or null for none
  - getVersions
```
public List<InstanceGroupManagerVersion> getVersions()
```
    Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates.
    
    Returns:
    
    value or null for none
  - setVersions
```
public InstanceGroupManager setVersions(List<InstanceGroupManagerVersion> versions)
```
    Specifies the instance templates used by this managed instance group to create instances. Each version is defined by an instanceTemplate and a name. Every version can appear at most once per instance group. This field overrides the top-level instanceTemplate field. Read more about the relationships between these fields. Exactly one version must leave the targetSize field unset. That version will be applied to all remaining instances. For more information, read about canary updates.
    
    Parameters:
    
    versions - versions or null for none
  - getZone
```
public String getZone()
```
    [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
    
    Returns:
    
    value or null for none
  - setZone
```
public InstanceGroupManager setZone(String zone)
```
    [Output Only] The URL of the zone where the managed instance group is located (for zonal resources).
    
    Parameters:
    
    zone - zone or null for none
  - set
```
public InstanceGroupManager set(String fieldName,
                                Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public InstanceGroupManager clone()
```
    Overrides:
    
    clone in class GenericJson

Class InstanceGroupManager

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

InstanceGroupManager

Method Detail

getAutoHealingPolicies

setAutoHealingPolicies

getBaseInstanceName

setBaseInstanceName

getCreationTimestamp

setCreationTimestamp

getCurrentActions

setCurrentActions

getDescription

setDescription

getDistributionPolicy

setDistributionPolicy

getFailoverAction

setFailoverAction

getFingerprint

decodeFingerprint

setFingerprint

encodeFingerprint

getId

setId

getInstanceGroup

setInstanceGroup

getInstanceTemplate

setInstanceTemplate

getKind

setKind

getName

setName

getNamedPorts

setNamedPorts

getPendingActions

setPendingActions

getRegion

setRegion

getSelfLink

setSelfLink

getSelfLinkWithId

setSelfLinkWithId

getServiceAccount

setServiceAccount

getStatefulPolicy

setStatefulPolicy

getStatus

setStatus

getTargetPools

setTargetPools

getTargetSize

setTargetSize

getUpdatePolicy

setUpdatePolicy

getVersions

setVersions

getZone

setZone

set

clone