- 1.63.0 (latest)
- 1.62.0
- 1.61.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.1
- 1.11.0
- 1.9.1
- 1.8.1
- 1.7.2
- 1.6.0-beta
public final class InstanceGroup extends GeneratedMessageV3 implements InstanceGroupOrBuilderRepresents 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.
Protobuf type google.cloud.compute.v1.InstanceGroup
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > InstanceGroupImplements
InstanceGroupOrBuilderStatic Fields
CREATION_TIMESTAMP_FIELD_NUMBER
public static final int CREATION_TIMESTAMP_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int | |
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int | |
FINGERPRINT_FIELD_NUMBER
public static final int FINGERPRINT_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int | |
ID_FIELD_NUMBER
public static final int ID_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int | |
KIND_FIELD_NUMBER
public static final int KIND_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int | |
NAMED_PORTS_FIELD_NUMBER
public static final int NAMED_PORTS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int | |
NETWORK_FIELD_NUMBER
public static final int NETWORK_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int | |
REGION_FIELD_NUMBER
public static final int REGION_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int | |
SELF_LINK_FIELD_NUMBER
public static final int SELF_LINK_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int | |
SIZE_FIELD_NUMBER
public static final int SIZE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int | |
SUBNETWORK_FIELD_NUMBER
public static final int SUBNETWORK_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int | |
ZONE_FIELD_NUMBER
public static final int ZONE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static InstanceGroup getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
InstanceGroup | |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
newBuilder()
public static InstanceGroup.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
InstanceGroup.Builder | |
newBuilder(InstanceGroup prototype)
public static InstanceGroup.Builder newBuilder(InstanceGroup prototype)| Parameter | |
|---|---|
| Name | Description |
prototype | InstanceGroup |
| Returns | |
|---|---|
| Type | Description |
InstanceGroup.Builder | |
parseDelimitedFrom(InputStream input)
public static InstanceGroup parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input | InputStream |
| Returns | |
|---|---|
| Type | Description |
InstanceGroup | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static InstanceGroup parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
InstanceGroup | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(byte[] data)
public static InstanceGroup parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data | byte[] |
| Returns | |
|---|---|
| Type | Description |
InstanceGroup | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static InstanceGroup parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data | byte[] |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
InstanceGroup | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(ByteString data)
public static InstanceGroup parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data | ByteString |
| Returns | |
|---|---|
| Type | Description |
InstanceGroup | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static InstanceGroup parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data | ByteString |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
InstanceGroup | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(CodedInputStream input)
public static InstanceGroup parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input | CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
InstanceGroup | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static InstanceGroup parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
InstanceGroup | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(InputStream input)
public static InstanceGroup parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input | InputStream |
| Returns | |
|---|---|
| Type | Description |
InstanceGroup | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static InstanceGroup parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
InstanceGroup | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(ByteBuffer data)
public static InstanceGroup parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data | ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
InstanceGroup | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static InstanceGroup parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data | ByteBuffer |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
InstanceGroup | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parser()
public static Parser<InstanceGroup> parser()| Returns | |
|---|---|
| Type | Description |
Parser<InstanceGroup> | |
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj | Object |
| Returns | |
|---|---|
| Type | Description |
boolean | |
getCreationTimestamp()
public String getCreationTimestamp()[Output Only] The creation timestamp for this instance group in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Returns | |
|---|---|
| Type | Description |
String | The creationTimestamp. |
getCreationTimestampBytes()
public ByteString getCreationTimestampBytes()[Output Only] The creation timestamp for this instance group in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for creationTimestamp. |
getDefaultInstanceForType()
public InstanceGroup getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
InstanceGroup | |
getDescription()
public String getDescription()An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Returns | |
|---|---|
| Type | Description |
String | The description. |
getDescriptionBytes()
public ByteString getDescriptionBytes()An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for description. |
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.
optional string fingerprint = 234678500;
| Returns | |
|---|---|
| Type | Description |
String | The fingerprint. |
getFingerprintBytes()
public ByteString getFingerprintBytes()[Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
optional string fingerprint = 234678500;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for fingerprint. |
getId()
public long getId()[Output Only] A unique identifier for this instance group, generated by the server.
optional uint64 id = 3355;
| Returns | |
|---|---|
| Type | Description |
long | The id. |
getKind()
public String getKind()[Output Only] The resource type, which is always compute#instanceGroup for instance groups.
optional string kind = 3292052;
| Returns | |
|---|---|
| Type | Description |
String | The kind. |
getKindBytes()
public ByteString getKindBytes()[Output Only] The resource type, which is always compute#instanceGroup for instance groups.
optional string kind = 3292052;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for kind. |
getName()
public String getName()The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
optional string name = 3373707;
| Returns | |
|---|---|
| Type | Description |
String | The name. |
getNameBytes()
public ByteString getNameBytes()The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
optional string name = 3373707;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for name. |
getNamedPorts(int index)
public NamedPort getNamedPorts(int index)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: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group.
repeated .google.cloud.compute.v1.NamedPort named_ports = 427598732;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
NamedPort | |
getNamedPortsCount()
public int getNamedPortsCount()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: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group.
repeated .google.cloud.compute.v1.NamedPort named_ports = 427598732;
| Returns | |
|---|---|
| Type | Description |
int | |
getNamedPortsList()
public List<NamedPort> getNamedPortsList()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: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group.
repeated .google.cloud.compute.v1.NamedPort named_ports = 427598732;
| Returns | |
|---|---|
| Type | Description |
List<NamedPort> | |
getNamedPortsOrBuilder(int index)
public NamedPortOrBuilder getNamedPortsOrBuilder(int index)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: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group.
repeated .google.cloud.compute.v1.NamedPort named_ports = 427598732;
| Parameter | |
|---|---|
| Name | Description |
index | int |
| Returns | |
|---|---|
| Type | Description |
NamedPortOrBuilder | |
getNamedPortsOrBuilderList()
public List<? extends NamedPortOrBuilder> getNamedPortsOrBuilderList()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: "app1", port: 8080}, {name: "app1", port: 8081}, {name: "app2", port: 8082}] Named ports apply to all instances in this instance group.
repeated .google.cloud.compute.v1.NamedPort named_ports = 427598732;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.compute.v1.NamedPortOrBuilder> | |
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).
optional string network = 232872494;
| Returns | |
|---|---|
| Type | Description |
String | The network. |
getNetworkBytes()
public ByteString getNetworkBytes()[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).
optional string network = 232872494;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for network. |
getParserForType()
public Parser<InstanceGroup> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<InstanceGroup> | |
getRegion()
public String getRegion()[Output Only] The URL of the region where the instance group is located (for regional resources).
optional string region = 138946292;
| Returns | |
|---|---|
| Type | Description |
String | The region. |
getRegionBytes()
public ByteString getRegionBytes()[Output Only] The URL of the region where the instance group is located (for regional resources).
optional string region = 138946292;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for region. |
getSelfLink()
public String getSelfLink()[Output Only] The URL for this instance group. The server generates this URL.
optional string self_link = 456214797;
| Returns | |
|---|---|
| Type | Description |
String | The selfLink. |
getSelfLinkBytes()
public ByteString getSelfLinkBytes()[Output Only] The URL for this instance group. The server generates this URL.
optional string self_link = 456214797;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for selfLink. |
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int | |
getSize()
public int getSize()[Output Only] The total number of instances in the instance group.
optional int32 size = 3530753;
| Returns | |
|---|---|
| Type | Description |
int | The size. |
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).
optional string subnetwork = 307827694;
| Returns | |
|---|---|
| Type | Description |
String | The subnetwork. |
getSubnetworkBytes()
public ByteString getSubnetworkBytes()[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).
optional string subnetwork = 307827694;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for subnetwork. |
getZone()
public String getZone()[Output Only] The URL of the zone where the instance group is located (for zonal resources).
optional string zone = 3744684;
| Returns | |
|---|---|
| Type | Description |
String | The zone. |
getZoneBytes()
public ByteString getZoneBytes()[Output Only] The URL of the zone where the instance group is located (for zonal resources).
optional string zone = 3744684;
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes for zone. |
hasCreationTimestamp()
public boolean hasCreationTimestamp()[Output Only] The creation timestamp for this instance group in RFC3339 text format.
optional string creation_timestamp = 30525366;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the creationTimestamp field is set. |
hasDescription()
public boolean hasDescription()An optional description of this resource. Provide this property when you create the resource.
optional string description = 422937596;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the description field is set. |
hasFingerprint()
public boolean hasFingerprint()[Output Only] The fingerprint of the named ports. The system uses this fingerprint to detect conflicts when multiple users change the named ports concurrently.
optional string fingerprint = 234678500;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the fingerprint field is set. |
hasId()
public boolean hasId()[Output Only] A unique identifier for this instance group, generated by the server.
optional uint64 id = 3355;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the id field is set. |
hasKind()
public boolean hasKind()[Output Only] The resource type, which is always compute#instanceGroup for instance groups.
optional string kind = 3292052;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the kind field is set. |
hasName()
public boolean hasName()The name of the instance group. The name must be 1-63 characters long, and comply with RFC1035.
optional string name = 3373707;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the name field is set. |
hasNetwork()
public boolean hasNetwork()[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).
optional string network = 232872494;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the network field is set. |
hasRegion()
public boolean hasRegion()[Output Only] The URL of the region where the instance group is located (for regional resources).
optional string region = 138946292;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the region field is set. |
hasSelfLink()
public boolean hasSelfLink()[Output Only] The URL for this instance group. The server generates this URL.
optional string self_link = 456214797;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the selfLink field is set. |
hasSize()
public boolean hasSize()[Output Only] The total number of instances in the instance group.
optional int32 size = 3530753;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the size field is set. |
hasSubnetwork()
public boolean hasSubnetwork()[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).
optional string subnetwork = 307827694;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the subnetwork field is set. |
hasZone()
public boolean hasZone()[Output Only] The URL of the zone where the instance group is located (for zonal resources).
optional string zone = 3744684;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the zone field is set. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int | |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
newBuilderForType()
public InstanceGroup.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
InstanceGroup.Builder | |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected InstanceGroup.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent | BuilderParent |
| Returns | |
|---|---|
| Type | Description |
InstanceGroup.Builder | |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Parameter | |
|---|---|
| Name | Description |
unused | UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object | |
toBuilder()
public InstanceGroup.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
InstanceGroup.Builder | |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output | CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |