InstanceGroupManager (Compute Engine API v1 (Rev. 103) 1.21.0)

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

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class InstanceGroupManager
extends com.google.api.client.json.GenericJson
```
Model definition for InstanceGroupManager.
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
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

InstanceGroupManager()

Constructors
Constructor and Description
`InstanceGroupManager()`

Method Summary

Methods
Modifier and Type	Method and Description
`InstanceGroupManager`	`clone()`
`byte[]`	`decodeFingerprint()` [Output Only] The fingerprint of the target pools information.
`InstanceGroupManager`	`encodeFingerprint(byte[] fingerprint)` [Output Only] The fingerprint of the target pools information.
`java.lang.String`	`getBaseInstanceName()` The base instance name to use for instances in this group.
`java.lang.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.
`java.lang.String`	`getDescription()` An optional description of this resource.
`java.lang.String`	`getFingerprint()` [Output Only] The fingerprint of the target pools information.
`java.math.BigInteger`	`getId()` [Output Only] A unique identifier for this resource type.
`java.lang.String`	`getInstanceGroup()` [Output Only] The URL of the Instance Group resource.
`java.lang.String`	`getInstanceTemplate()` The URL of the instance template that is specified for this managed instance group.
`java.lang.String`	`getKind()` [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
`java.lang.String`	`getName()` The name of the managed instance group.
`java.util.List<NamedPort>`	`getNamedPorts()` Named ports configured for the Instance Groups complementary to this Instance Group Manager.
`java.lang.String`	`getSelfLink()` [Output Only] The URL for this managed instance group.
`java.util.List<java.lang.String>`	`getTargetPools()` The URLs for all TargetPool resources to which instances in the instanceGroup field are added.
`java.lang.Integer`	`getTargetSize()` The target number of running instances for this managed instance group.
`java.lang.String`	`getZone()` The name of the zone where the managed instance group is located.
`InstanceGroupManager`	`set(java.lang.String fieldName, java.lang.Object value)`
`InstanceGroupManager`	`setBaseInstanceName(java.lang.String baseInstanceName)` The base instance name to use for instances in this group.
`InstanceGroupManager`	`setCreationTimestamp(java.lang.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(java.lang.String description)` An optional description of this resource.
`InstanceGroupManager`	`setFingerprint(java.lang.String fingerprint)` [Output Only] The fingerprint of the target pools information.
`InstanceGroupManager`	`setId(java.math.BigInteger id)` [Output Only] A unique identifier for this resource type.
`InstanceGroupManager`	`setInstanceGroup(java.lang.String instanceGroup)` [Output Only] The URL of the Instance Group resource.
`InstanceGroupManager`	`setInstanceTemplate(java.lang.String instanceTemplate)` The URL of the instance template that is specified for this managed instance group.
`InstanceGroupManager`	`setKind(java.lang.String kind)` [Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.
`InstanceGroupManager`	`setName(java.lang.String name)` The name of the managed instance group.
`InstanceGroupManager`	`setNamedPorts(java.util.List<NamedPort> namedPorts)` Named ports configured for the Instance Groups complementary to this Instance Group Manager.
`InstanceGroupManager`	`setSelfLink(java.lang.String selfLink)` [Output Only] The URL for this managed instance group.
`InstanceGroupManager`	`setTargetPools(java.util.List<java.lang.String> targetPools)` The URLs for all TargetPool resources to which instances in the instanceGroup field are added.
`InstanceGroupManager`	`setTargetSize(java.lang.Integer targetSize)` The target number of running instances for this managed instance group.
`InstanceGroupManager`	`setZone(java.lang.String zone)` The name of the zone where the managed instance group is located.

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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

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

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

- Constructor Detail
  - InstanceGroupManager
```
public InstanceGroupManager()
```
- Method Detail
  - getBaseInstanceName
```
public java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.String description)
```
    An optional description of this resource. Provide this property when you create the resource.
    
    Parameters:
    description - description or null for none
  - getFingerprint
```
public java.lang.String getFingerprint()
```
    [Output Only] The fingerprint of the target pools information. You can use this optional field for optimistic locking when you update the target pool entries.
    
    Returns:
    value or null for none
    See Also:
    decodeFingerprint()
  - decodeFingerprint
```
public byte[] decodeFingerprint()
```
    [Output Only] The fingerprint of the target pools information. You can use this optional field for optimistic locking when you update the target pool entries.
    
    Returns:
    Base64 decoded value or null for none
    Since:
    
    1.14
    
    See Also:
    getFingerprint()
  - setFingerprint
```
public InstanceGroupManager setFingerprint(java.lang.String fingerprint)
```
    [Output Only] The fingerprint of the target pools information. You can use this optional field for optimistic locking when you update the target pool entries.
    
    Parameters:
    fingerprint - fingerprint or null for none
    See Also:
    #encodeFingerprint()
  - encodeFingerprint
```
public InstanceGroupManager encodeFingerprint(byte[] fingerprint)
```
    [Output Only] The fingerprint of the target pools information. You can use this optional field for optimistic locking when you update the target pool entries.
    
    Since:
    
    1.14
    
    See Also:
    The value is encoded Base64 or {@code null} for none.
  - getId
```
public java.math.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(java.math.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 java.lang.String getInstanceGroup()
```
    [Output Only] The URL of the Instance Group resource.
    
    Returns:
    value or null for none
  - setInstanceGroup
```
public InstanceGroupManager setInstanceGroup(java.lang.String instanceGroup)
```
    [Output Only] The URL of the Instance Group resource.
    
    Parameters:
    instanceGroup - instanceGroup or null for none
  - getInstanceTemplate
```
public java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.util.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(java.util.List<NamedPort> namedPorts)
```
    Named ports configured for the Instance Groups complementary to this Instance Group Manager.
    
    Parameters:
    namedPorts - namedPorts or null for none
  - getSelfLink
```
public java.lang.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(java.lang.String selfLink)
```
    [Output Only] The URL for this managed instance group. The server defines this URL.
    
    Parameters:
    selfLink - selfLink or null for none
  - getTargetPools
```
public java.util.List<java.lang.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(java.util.List<java.lang.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 java.lang.Integer getTargetSize()
```
    The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
    
    Returns:
    value or null for none
  - setTargetSize
```
public InstanceGroupManager setTargetSize(java.lang.Integer targetSize)
```
    The target number of running instances for this managed instance group. Deleting or abandoning instances reduces this number. Resizing the group changes this number.
    
    Parameters:
    targetSize - targetSize or null for none
  - getZone
```
public java.lang.String getZone()
```
    The name of the zone where the managed instance group is located.
    
    Returns:
    value or null for none
  - setZone
```
public InstanceGroupManager setZone(java.lang.String zone)
```
    The name of the zone where the managed instance group is located.
    
    Parameters:
    zone - zone or null for none
  - set
```
public InstanceGroupManager set(java.lang.String fieldName,
                       java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public InstanceGroupManager clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Compute Engine API v1 (revision 103)

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

Constructor Detail

InstanceGroupManager

Method Detail

getBaseInstanceName

setBaseInstanceName

getCreationTimestamp

setCreationTimestamp

getCurrentActions

setCurrentActions

getDescription

setDescription

getFingerprint

decodeFingerprint

setFingerprint

encodeFingerprint

getId

setId

getInstanceGroup

setInstanceGroup

getInstanceTemplate

setInstanceTemplate

getKind

setKind

getName

setName

getNamedPorts

setNamedPorts

getSelfLink

setSelfLink

getTargetPools

setTargetPools

getTargetSize

setTargetSize

getZone

setZone

set

clone