InstanceGroup (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.InstanceGroup

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class InstanceGroup
extends com.google.api.client.json.GenericJson
```
Model definition for InstanceGroup.
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

InstanceGroup()

Constructors
Constructor and Description
`InstanceGroup()`

Method Summary

Methods
Modifier and Type	Method and Description
`InstanceGroup`	`clone()`
`byte[]`	`decodeFingerprint()` [Output Only] The fingerprint of the named ports.
`InstanceGroup`	`encodeFingerprint(byte[] fingerprint)` [Output Only] The fingerprint of the named ports.
`java.lang.String`	`getCreationTimestamp()` [Output Only] The creation timestamp for this instance group in RFC3339 text format.
`java.lang.String`	`getDescription()` An optional description of this resource.
`java.lang.String`	`getFingerprint()` [Output Only] The fingerprint of the named ports.
`java.math.BigInteger`	`getId()` [Output Only] A unique identifier for this resource type.
`java.lang.String`	`getKind()` [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
`java.lang.String`	`getName()` The name of the instance group.
`java.util.List<NamedPort>`	`getNamedPorts()` Assigns a name to a port number.
`java.lang.String`	`getNetwork()` The URL of the network to which all instances in the instance group belong.
`java.lang.String`	`getSelfLink()` [Output Only] The URL for this instance group.
`java.lang.Integer`	`getSize()` [Output Only] The total number of instances in the instance group.
`java.lang.String`	`getSubnetwork()` The URL of the subnetwork to which all instances in the instance group belong.
`java.lang.String`	`getZone()` [Output Only] The URL of the zone where the instance group is located.
`InstanceGroup`	`set(java.lang.String fieldName, java.lang.Object value)`
`InstanceGroup`	`setCreationTimestamp(java.lang.String creationTimestamp)` [Output Only] The creation timestamp for this instance group in RFC3339 text format.
`InstanceGroup`	`setDescription(java.lang.String description)` An optional description of this resource.
`InstanceGroup`	`setFingerprint(java.lang.String fingerprint)` [Output Only] The fingerprint of the named ports.
`InstanceGroup`	`setId(java.math.BigInteger id)` [Output Only] A unique identifier for this resource type.
`InstanceGroup`	`setKind(java.lang.String kind)` [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
`InstanceGroup`	`setName(java.lang.String name)` The name of the instance group.
`InstanceGroup`	`setNamedPorts(java.util.List<NamedPort> namedPorts)` Assigns a name to a port number.
`InstanceGroup`	`setNetwork(java.lang.String network)` The URL of the network to which all instances in the instance group belong.
`InstanceGroup`	`setSelfLink(java.lang.String selfLink)` [Output Only] The URL for this instance group.
`InstanceGroup`	`setSize(java.lang.Integer size)` [Output Only] The total number of instances in the instance group.
`InstanceGroup`	`setSubnetwork(java.lang.String subnetwork)` The URL of the subnetwork to which all instances in the instance group belong.
`InstanceGroup`	`setZone(java.lang.String zone)` [Output Only] The URL of the zone where the 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
  - InstanceGroup
```
public InstanceGroup()
```
- Method Detail
  - getCreationTimestamp
```
public java.lang.String getCreationTimestamp()
```
    [Output Only] The creation timestamp for this instance group in RFC3339 text format.
    
    Returns:
    value or null for none
  - setCreationTimestamp
```
public InstanceGroup setCreationTimestamp(java.lang.String creationTimestamp)
```
    [Output Only] The creation timestamp for this instance group in RFC3339 text format.
    
    Parameters:
    creationTimestamp - creationTimestamp 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 InstanceGroup 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 named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
    
    Returns:
    value or null for none
    See Also:
    decodeFingerprint()
  - decodeFingerprint
```
public byte[] decodeFingerprint()
```
    [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
    
    Returns:
    Base64 decoded value or null for none
    Since:
    
    1.14
    
    See Also:
    getFingerprint()
  - setFingerprint
```
public InstanceGroup setFingerprint(java.lang.String fingerprint)
```
    [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
    
    Parameters:
    fingerprint - fingerprint or null for none
    See Also:
    #encodeFingerprint()
  - encodeFingerprint
```
public InstanceGroup encodeFingerprint(byte[] fingerprint)
```
    [Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
    
    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 InstanceGroup 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
  - getKind
```
public java.lang.String getKind()
```
    [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
    
    Returns:
    value or null for none
  - setKind
```
public InstanceGroup setKind(java.lang.String kind)
```
    [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
    
    Parameters:
    kind - kind or null for none
  - getName
```
public java.lang.String getName()
```
    The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
    
    Returns:
    value or null for none
  - setName
```
public InstanceGroup setName(java.lang.String name)
```
    The name of the 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()
```
    Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}] Named ports apply to all instances in this instance group.
    
    Returns:
    value or null for none
  - setNamedPorts
```
public InstanceGroup setNamedPorts(java.util.List<NamedPort> namedPorts)
```
    Assigns a name to a port number. For example: {name: "http", port: 80} This allows the system to reference ports by the assigned name instead of a port number. Named ports can also contain multiple ports. For example: [{name: "http", port: 80},{name: "http", port: 8080}] Named ports apply to all instances in this instance group.
    
    Parameters:
    namedPorts - namedPorts or null for none
  - getNetwork
```
public java.lang.String getNetwork()
```
    The URL of the network to which all instances in the instance group belong.
    
    Returns:
    value or null for none
  - setNetwork
```
public InstanceGroup setNetwork(java.lang.String network)
```
    The URL of the network to which all instances in the instance group belong.
    
    Parameters:
    network - network or null for none
  - getSelfLink
```
public java.lang.String getSelfLink()
```
    [Output Only] The URL for this instance group. The server generates this URL.
    
    Returns:
    value or null for none
  - setSelfLink
```
public InstanceGroup setSelfLink(java.lang.String selfLink)
```
    [Output Only] The URL for this instance group. The server generates this URL.
    
    Parameters:
    selfLink - selfLink or null for none
  - getSize
```
public java.lang.Integer getSize()
```
    [Output Only] The total number of instances in the instance group.
    
    Returns:
    value or null for none
  - setSize
```
public InstanceGroup setSize(java.lang.Integer size)
```
    [Output Only] The total number of instances in the instance group.
    
    Parameters:
    size - size or null for none
  - getSubnetwork
```
public java.lang.String getSubnetwork()
```
    The URL of the subnetwork to which all instances in the instance group belong.
    
    Returns:
    value or null for none
  - setSubnetwork
```
public InstanceGroup setSubnetwork(java.lang.String subnetwork)
```
    The URL of the subnetwork to which all instances in the instance group belong.
    
    Parameters:
    subnetwork - subnetwork or null for none
  - getZone
```
public java.lang.String getZone()
```
    [Output Only] The URL of the zone where the instance group is located.
    
    Returns:
    value or null for none
  - setZone
```
public InstanceGroup setZone(java.lang.String zone)
```
    [Output Only] The URL of the zone where the instance group is located.
    
    Parameters:
    zone - zone or null for none
  - set
```
public InstanceGroup set(java.lang.String fieldName,
                java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public InstanceGroup clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Compute Engine API v1 (revision 103)

Class InstanceGroup

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

InstanceGroup

Method Detail

getCreationTimestamp

setCreationTimestamp

getDescription

setDescription

getFingerprint

decodeFingerprint

setFingerprint

encodeFingerprint

getId

setId

getKind

setKind

getName

setName

getNamedPorts

setNamedPorts

getNetwork

setNetwork

getSelfLink

setSelfLink

getSize

setSize

getSubnetwork

setSubnetwork

getZone

setZone

set

clone