target.apidocs.com.google.api.services.compute.model.InstanceGroup.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-compute Show documentation

There is a newer version: v1-rev20250107-2.0.0

Show newest version







InstanceGroup (Compute Engine API alpha-rev20200526-1.30.9)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.compute.model
Class InstanceGroup



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













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class InstanceGroup
extends GenericJson
Represents an Instance Group resource.

 Instance Groups can be used to configure a target for load balancing.

 Instance groups can either be managed or unmanaged.

 To create  managed instance groups, use the instanceGroupManager or regionInstanceGroupManager
 resource instead.

 Use zonal unmanaged instance groups if you need to apply load balancing to groups of
 heterogeneous instances or if you need to manage the instances yourself. You cannot create
 regional unmanaged instance groups.

 For more information, read Instance groups.

 (== resource_for {$api_version}.instanceGroups ==) (== resource_for
 {$api_version}.regionInstanceGroups ==)

  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


InstanceGroup() 









Method Summary

All Methods Instance Methods Concrete 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.



String
getCreationTimestamp()
[Output Only] The creation timestamp for this instance group in RFC3339 text format.



String
getDescription()
An optional description of this resource.



String
getFingerprint()
[Output Only] The fingerprint of the named ports.



BigInteger
getId()
[Output Only] A unique identifier for this instance group, generated by the server.



String
getKind()
[Output Only] The resource type, which is always compute#instanceGroup for instance groups.



String
getName()
The name of the instance group.



List<NamedPort>
getNamedPorts()
Assigns a name to a port number.



String
getNetwork()
[Output Only] The URL of the network to which all instances in the instance group belong.



String
getRegion()
[Output Only] The URL of the region where the instance group is located (for regional
 resources).



String
getSelfLink()
[Output Only] The URL for this instance group.



String
getSelfLinkWithId()
[Output Only] Server-defined URL for this resource with the resource id.



Integer
getSize()
[Output Only] The total number of instances in the instance group.



String
getSubnetwork()
[Output Only] The URL of the subnetwork to which all instances in the instance group belong.



String
getZone()
[Output Only] The URL of the zone where the instance group is located (for zonal resources).



InstanceGroup
set(String fieldName,
   Object value) 


InstanceGroup
setCreationTimestamp(String creationTimestamp)
[Output Only] The creation timestamp for this instance group in RFC3339 text format.



InstanceGroup
setDescription(String description)
An optional description of this resource.



InstanceGroup
setFingerprint(String fingerprint)
[Output Only] The fingerprint of the named ports.



InstanceGroup
setId(BigInteger id)
[Output Only] A unique identifier for this instance group, generated by the server.



InstanceGroup
setKind(String kind)
[Output Only] The resource type, which is always compute#instanceGroup for instance groups.



InstanceGroup
setName(String name)
The name of the instance group.



InstanceGroup
setNamedPorts(List<NamedPort> namedPorts)
Assigns a name to a port number.



InstanceGroup
setNetwork(String network)
[Output Only] The URL of the network to which all instances in the instance group belong.



InstanceGroup
setRegion(String region)
[Output Only] The URL of the region where the instance group is located (for regional
 resources).



InstanceGroup
setSelfLink(String selfLink)
[Output Only] The URL for this instance group.



InstanceGroup
setSelfLinkWithId(String selfLinkWithId)
[Output Only] Server-defined URL for this resource with the resource id.



InstanceGroup
setSize(Integer size)
[Output Only] The total number of instances in the instance group.



InstanceGroup
setSubnetwork(String subnetwork)
[Output Only] The URL of the subnetwork to which all instances in the instance group belong.



InstanceGroup
setZone(String zone)
[Output Only] The URL of the zone where the 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





InstanceGroup
public InstanceGroup()









Method Detail





getCreationTimestamp
public 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(String creationTimestamp)
[Output Only] The creation timestamp for this instance group in RFC3339 text format.

Parameters:
creationTimestamp - creationTimestamp 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 InstanceGroup setDescription(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 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(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 BigInteger getId()
[Output Only] A unique identifier for this instance group, generated by the server.

Returns:
value or null for none








setId
public InstanceGroup setId(BigInteger id)
[Output Only] A unique identifier for this instance group, generated by the server.

Parameters:
id - id or null for none








getKind
public 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(String kind)
[Output Only] The resource type, which is always compute#instanceGroup for instance groups.

Parameters:
kind - kind or null for none








getName
public 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(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 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(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 String getNetwork()
[Output Only] The URL of the network to which all instances in the instance group belong. If
 your instance has multiple network interfaces, then the network and subnetwork fields only
 refer to the network and subnet used by your primary interface (nic0).

Returns:
value or null for none








setNetwork
public InstanceGroup setNetwork(String network)
[Output Only] The URL of the network to which all instances in the instance group belong. If
 your instance has multiple network interfaces, then the network and subnetwork fields only
 refer to the network and subnet used by your primary interface (nic0).

Parameters:
network - network or null for none








getRegion
public String getRegion()
[Output Only] The URL of the region where the instance group is located (for regional
 resources).

Returns:
value or null for none








setRegion
public InstanceGroup setRegion(String region)
[Output Only] The URL of the region where the instance group is located (for regional
 resources).

Parameters:
region - region or null for none








getSelfLink
public 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(String selfLink)
[Output Only] The URL for this instance group. The server generates 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 InstanceGroup setSelfLinkWithId(String selfLinkWithId)
[Output Only] Server-defined URL for this resource with the resource id.

Parameters:
selfLinkWithId - selfLinkWithId or null for none








getSize
public Integer getSize()
[Output Only] The total number of instances in the instance group.

Returns:
value or null for none








setSize
public InstanceGroup setSize(Integer size)
[Output Only] The total number of instances in the instance group.

Parameters:
size - size or null for none








getSubnetwork
public String getSubnetwork()
[Output Only] The URL of the subnetwork to which all instances in the instance group belong. If
 your instance has multiple network interfaces, then the network and subnetwork fields only
 refer to the network and subnet used by your primary interface (nic0).

Returns:
value or null for none








setSubnetwork
public InstanceGroup setSubnetwork(String subnetwork)
[Output Only] The URL of the subnetwork to which all instances in the instance group belong. If
 your instance has multiple network interfaces, then the network and subnetwork fields only
 refer to the network and subnet used by your primary interface (nic0).

Parameters:
subnetwork - subnetwork or null for none








getZone
public String getZone()
[Output Only] The URL of the zone where the instance group is located (for zonal resources).

Returns:
value or null for none








setZone
public InstanceGroup setZone(String zone)
[Output Only] The URL of the zone where the instance group is located (for zonal resources).

Parameters:
zone - zone or null for none








set
public InstanceGroup set(String fieldName,
                         Object value)

Overrides:
set in class GenericJson








clone
public InstanceGroup clone()

Overrides:
clone in class GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2020 Google. All rights reserved.

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.
`String`	`getCreationTimestamp()` [Output Only] The creation timestamp for this instance group in RFC3339 text format.
`String`	`getDescription()` An optional description of this resource.
`String`	`getFingerprint()` [Output Only] The fingerprint of the named ports.
`BigInteger`	`getId()` [Output Only] A unique identifier for this instance group, generated by the server.
`String`	`getKind()` [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
`String`	`getName()` The name of the instance group.
`List<NamedPort>`	`getNamedPorts()` Assigns a name to a port number.
`String`	`getNetwork()` [Output Only] The URL of the network to which all instances in the instance group belong.
`String`	`getRegion()` [Output Only] The URL of the region where the instance group is located (for regional resources).
`String`	`getSelfLink()` [Output Only] The URL for this instance group.
`String`	`getSelfLinkWithId()` [Output Only] Server-defined URL for this resource with the resource id.
`Integer`	`getSize()` [Output Only] The total number of instances in the instance group.
`String`	`getSubnetwork()` [Output Only] The URL of the subnetwork to which all instances in the instance group belong.
`String`	`getZone()` [Output Only] The URL of the zone where the instance group is located (for zonal resources).
`InstanceGroup`	`set(String fieldName, Object value)`
`InstanceGroup`	`setCreationTimestamp(String creationTimestamp)` [Output Only] The creation timestamp for this instance group in RFC3339 text format.
`InstanceGroup`	`setDescription(String description)` An optional description of this resource.
`InstanceGroup`	`setFingerprint(String fingerprint)` [Output Only] The fingerprint of the named ports.
`InstanceGroup`	`setId(BigInteger id)` [Output Only] A unique identifier for this instance group, generated by the server.
`InstanceGroup`	`setKind(String kind)` [Output Only] The resource type, which is always compute#instanceGroup for instance groups.
`InstanceGroup`	`setName(String name)` The name of the instance group.
`InstanceGroup`	`setNamedPorts(List<NamedPort> namedPorts)` Assigns a name to a port number.
`InstanceGroup`	`setNetwork(String network)` [Output Only] The URL of the network to which all instances in the instance group belong.
`InstanceGroup`	`setRegion(String region)` [Output Only] The URL of the region where the instance group is located (for regional resources).
`InstanceGroup`	`setSelfLink(String selfLink)` [Output Only] The URL for this instance group.
`InstanceGroup`	`setSelfLinkWithId(String selfLinkWithId)` [Output Only] Server-defined URL for this resource with the resource id.
`InstanceGroup`	`setSize(Integer size)` [Output Only] The total number of instances in the instance group.
`InstanceGroup`	`setSubnetwork(String subnetwork)` [Output Only] The URL of the subnetwork to which all instances in the instance group belong.
`InstanceGroup`	`setZone(String zone)` [Output Only] The URL of the zone where the instance group is located (for zonal resources).