Class InstanceGroupManager (1.16.0)

Version 1.16.0

• 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 InstanceGroupManager extends GeneratedMessageV3 implements InstanceGroupManagerOrBuilder

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.

Protobuf type google.cloud.compute.v1.InstanceGroupManager

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > InstanceGroupManager

Implements

InstanceGroupManagerOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

AUTO_HEALING_POLICIES_FIELD_NUMBER

public static final int AUTO_HEALING_POLICIES_FIELD_NUMBER

Field Value

Type	Description
int

BASE_INSTANCE_NAME_FIELD_NUMBER

public static final int BASE_INSTANCE_NAME_FIELD_NUMBER

Field Value

Type	Description
int

CREATION_TIMESTAMP_FIELD_NUMBER

public static final int CREATION_TIMESTAMP_FIELD_NUMBER

Field Value

Type	Description
int

CURRENT_ACTIONS_FIELD_NUMBER

public static final int CURRENT_ACTIONS_FIELD_NUMBER

Field Value

Type	Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER

Field Value

Type	Description
int

DISTRIBUTION_POLICY_FIELD_NUMBER

public static final int DISTRIBUTION_POLICY_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

INSTANCE_GROUP_FIELD_NUMBER

public static final int INSTANCE_GROUP_FIELD_NUMBER

Field Value

Type	Description
int

INSTANCE_TEMPLATE_FIELD_NUMBER

public static final int INSTANCE_TEMPLATE_FIELD_NUMBER

Field Value

Type	Description
int

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER

Field Value

Type	Description
int

LIST_MANAGED_INSTANCES_RESULTS_FIELD_NUMBER

public static final int LIST_MANAGED_INSTANCES_RESULTS_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

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

STATEFUL_POLICY_FIELD_NUMBER

public static final int STATEFUL_POLICY_FIELD_NUMBER

Field Value

Type	Description
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER

Field Value

Type	Description
int

TARGET_POOLS_FIELD_NUMBER

public static final int TARGET_POOLS_FIELD_NUMBER

Field Value

Type	Description
int

TARGET_SIZE_FIELD_NUMBER

public static final int TARGET_SIZE_FIELD_NUMBER

Field Value

Type	Description
int

UPDATE_POLICY_FIELD_NUMBER

public static final int UPDATE_POLICY_FIELD_NUMBER

Field Value

Type	Description
int

VERSIONS_FIELD_NUMBER

public static final int VERSIONS_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 InstanceGroupManager getDefaultInstance()

Returns

Type	Description
InstanceGroupManager

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

newBuilder()

public static InstanceGroupManager.Builder newBuilder()

Returns

Type	Description
InstanceGroupManager.Builder

newBuilder(InstanceGroupManager prototype)

public static InstanceGroupManager.Builder newBuilder(InstanceGroupManager prototype)

Parameter

Name	Description
prototype	InstanceGroupManager

Returns

Type	Description
InstanceGroupManager.Builder

parseDelimitedFrom(InputStream input)

public static InstanceGroupManager parseDelimitedFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
InstanceGroupManager

Exceptions

Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static InstanceGroupManager parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
InstanceGroupManager

Exceptions

Type	Description
IOException

parseFrom(byte[] data)

public static InstanceGroupManager parseFrom(byte[] data)

Parameter

Name	Description
data	byte[]

Returns

Type	Description
InstanceGroupManager

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static InstanceGroupManager parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
InstanceGroupManager

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static InstanceGroupManager parseFrom(ByteString data)

Parameter

Name	Description
data	ByteString

Returns

Type	Description
InstanceGroupManager

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static InstanceGroupManager parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
InstanceGroupManager

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static InstanceGroupManager parseFrom(CodedInputStream input)

Parameter

Name	Description
input	CodedInputStream

Returns

Type	Description
InstanceGroupManager

Exceptions

Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static InstanceGroupManager parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
InstanceGroupManager

Exceptions

Type	Description
IOException

parseFrom(InputStream input)

public static InstanceGroupManager parseFrom(InputStream input)

Parameter

Name	Description
input	InputStream

Returns

Type	Description
InstanceGroupManager

Exceptions

Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static InstanceGroupManager parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
InstanceGroupManager

Exceptions

Type	Description
IOException

parseFrom(ByteBuffer data)

public static InstanceGroupManager parseFrom(ByteBuffer data)

Parameter

Name	Description
data	ByteBuffer

Returns

Type	Description
InstanceGroupManager

Exceptions

Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static InstanceGroupManager parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns

Type	Description
InstanceGroupManager

Exceptions

Type	Description
InvalidProtocolBufferException

parser()

public static Parser<InstanceGroupManager> parser()

Returns

Type	Description
Parser<InstanceGroupManager>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter

Name	Description
obj	Object

Returns

Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getAutoHealingPolicies(int index)

public InstanceGroupManagerAutoHealingPolicy getAutoHealingPolicies(int index)

The autohealing policy for this managed instance group. You can specify only one value.

repeated .google.cloud.compute.v1.InstanceGroupManagerAutoHealingPolicy auto_healing_policies = 456799109;

Parameter

Name	Description
index	int

Returns

Type	Description
InstanceGroupManagerAutoHealingPolicy

getAutoHealingPoliciesCount()

public int getAutoHealingPoliciesCount()

The autohealing policy for this managed instance group. You can specify only one value.

repeated .google.cloud.compute.v1.InstanceGroupManagerAutoHealingPolicy auto_healing_policies = 456799109;

Returns

Type	Description
int

getAutoHealingPoliciesList()

public List<InstanceGroupManagerAutoHealingPolicy> getAutoHealingPoliciesList()

The autohealing policy for this managed instance group. You can specify only one value.

repeated .google.cloud.compute.v1.InstanceGroupManagerAutoHealingPolicy auto_healing_policies = 456799109;

Returns

Type	Description
List<InstanceGroupManagerAutoHealingPolicy>

getAutoHealingPoliciesOrBuilder(int index)

public InstanceGroupManagerAutoHealingPolicyOrBuilder getAutoHealingPoliciesOrBuilder(int index)

The autohealing policy for this managed instance group. You can specify only one value.

repeated .google.cloud.compute.v1.InstanceGroupManagerAutoHealingPolicy auto_healing_policies = 456799109;

Parameter

Name	Description
index	int

Returns

Type	Description
InstanceGroupManagerAutoHealingPolicyOrBuilder

getAutoHealingPoliciesOrBuilderList()

public List<? extends InstanceGroupManagerAutoHealingPolicyOrBuilder> getAutoHealingPoliciesOrBuilderList()

The autohealing policy for this managed instance group. You can specify only one value.

repeated .google.cloud.compute.v1.InstanceGroupManagerAutoHealingPolicy auto_healing_policies = 456799109;

Returns

Type	Description
List<? extends com.google.cloud.compute.v1.InstanceGroupManagerAutoHealingPolicyOrBuilder>

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.

optional string base_instance_name = 389106439;

Returns

Type	Description
String	The baseInstanceName.

getBaseInstanceNameBytes()

public ByteString getBaseInstanceNameBytes()

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.

optional string base_instance_name = 389106439;

Returns

Type	Description
ByteString	The bytes for baseInstanceName.

getCreationTimestamp()

public String getCreationTimestamp()

[Output Only] The creation timestamp for this managed 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 managed instance group in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns

Type	Description
ByteString	The bytes for creationTimestamp.

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.

optional .google.cloud.compute.v1.InstanceGroupManagerActionsSummary current_actions = 164045879;

Returns

Type	Description
InstanceGroupManagerActionsSummary	The currentActions.

getCurrentActionsOrBuilder()

public InstanceGroupManagerActionsSummaryOrBuilder getCurrentActionsOrBuilder()

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

optional .google.cloud.compute.v1.InstanceGroupManagerActionsSummary current_actions = 164045879;

Returns

Type	Description
InstanceGroupManagerActionsSummaryOrBuilder

getDefaultInstanceForType()

public InstanceGroupManager getDefaultInstanceForType()

Returns

Type	Description
InstanceGroupManager

getDescription()

public String getDescription()

An optional description of this resource.

optional string description = 422937596;

Returns

Type	Description
String	The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

An optional description of this resource.

optional string description = 422937596;

Returns

Type	Description
ByteString	The bytes for description.

getDistributionPolicy()

public DistributionPolicy getDistributionPolicy()

Policy specifying the intended distribution of managed instances across zones in a regional managed instance group.

optional .google.cloud.compute.v1.DistributionPolicy distribution_policy = 534558541;

Returns

Type	Description
DistributionPolicy	The distributionPolicy.

getDistributionPolicyOrBuilder()

public DistributionPolicyOrBuilder getDistributionPolicyOrBuilder()

Policy specifying the intended distribution of managed instances across zones in a regional managed instance group.

optional .google.cloud.compute.v1.DistributionPolicy distribution_policy = 534558541;

Returns

Type	Description
DistributionPolicyOrBuilder

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.

optional string fingerprint = 234678500;

Returns

Type	Description
String	The fingerprint.

getFingerprintBytes()

public ByteString getFingerprintBytes()

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.

optional string fingerprint = 234678500;

Returns

Type	Description
ByteString	The bytes for fingerprint.

getId()

public long getId()

[Output Only] A unique identifier for this resource type. The server generates this identifier.

optional uint64 id = 3355;

Returns

Type	Description
long	The id.

getInstanceGroup()

public String getInstanceGroup()

[Output Only] The URL of the Instance Group resource.

optional string instance_group = 81095253;

Returns

Type	Description
String	The instanceGroup.

getInstanceGroupBytes()

public ByteString getInstanceGroupBytes()

[Output Only] The URL of the Instance Group resource.

optional string instance_group = 81095253;

Returns

Type	Description
ByteString	The bytes for instanceGroup.

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. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.

optional string instance_template = 309248228;

Returns

Type	Description
String	The instanceTemplate.

getInstanceTemplateBytes()

public ByteString getInstanceTemplateBytes()

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. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.

optional string instance_template = 309248228;

Returns

Type	Description
ByteString	The bytes for instanceTemplate.

getKind()

public String getKind()

[Output Only] The resource type, which is always compute#instanceGroupManager for managed 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#instanceGroupManager for managed instance groups.

optional string kind = 3292052;

Returns

Type	Description
ByteString	The bytes for kind.

getListManagedInstancesResults()

public String getListManagedInstancesResults()

Pagination behavior of the listManagedInstances API method for this managed instance group. Check the ListManagedInstancesResults enum for the list of possible values.

optional string list_managed_instances_results = 296047156;

Returns

Type	Description
String	The listManagedInstancesResults.

getListManagedInstancesResultsBytes()

public ByteString getListManagedInstancesResultsBytes()

Pagination behavior of the listManagedInstances API method for this managed instance group. Check the ListManagedInstancesResults enum for the list of possible values.

optional string list_managed_instances_results = 296047156;

Returns

Type	Description
ByteString	The bytes for listManagedInstancesResults.

getName()

public String getName()

The name of the managed 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 managed 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)

Named ports configured for the Instance Groups complementary to this Instance Group Manager.

repeated .google.cloud.compute.v1.NamedPort named_ports = 427598732;

Parameter

Name	Description
index	int

Returns

Type	Description
NamedPort

getNamedPortsCount()

public int getNamedPortsCount()

Named ports configured for the Instance Groups complementary to this Instance Group Manager.

repeated .google.cloud.compute.v1.NamedPort named_ports = 427598732;

Returns

Type	Description
int

getNamedPortsList()

public List<NamedPort> getNamedPortsList()

Named ports configured for the Instance Groups complementary to this Instance Group Manager.

repeated .google.cloud.compute.v1.NamedPort named_ports = 427598732;

Returns

Type	Description
List<NamedPort>

getNamedPortsOrBuilder(int index)

public NamedPortOrBuilder getNamedPortsOrBuilder(int index)

Named ports configured for the Instance Groups complementary to this Instance Group Manager.

repeated .google.cloud.compute.v1.NamedPort named_ports = 427598732;

Parameter

Name	Description
index	int

Returns

Type	Description
NamedPortOrBuilder

getNamedPortsOrBuilderList()

public List<? extends NamedPortOrBuilder> getNamedPortsOrBuilderList()

Named ports configured for the Instance Groups complementary to this Instance Group Manager.

repeated .google.cloud.compute.v1.NamedPort named_ports = 427598732;

Returns

Type	Description
List<? extends com.google.cloud.compute.v1.NamedPortOrBuilder>

getParserForType()

public Parser<InstanceGroupManager> getParserForType()

Returns

Type	Description
Parser<InstanceGroupManager>

Overrides

GeneratedMessageV3.getParserForType()

getRegion()

public String getRegion()

[Output Only] The URL of the region where the managed instance group resides (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 managed instance group resides (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 managed instance group. The server defines this URL.

optional string self_link = 456214797;

Returns

Type	Description
String	The selfLink.

getSelfLinkBytes()

public ByteString getSelfLinkBytes()

[Output Only] The URL for this managed instance group. The server defines this URL.

optional string self_link = 456214797;

Returns

Type	Description
ByteString	The bytes for selfLink.

getSerializedSize()

public int getSerializedSize()

Returns

Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getStatefulPolicy()

public StatefulPolicy getStatefulPolicy()

Stateful configuration for this Instanced Group Manager

optional .google.cloud.compute.v1.StatefulPolicy stateful_policy = 47538565;

Returns

Type	Description
StatefulPolicy	The statefulPolicy.

getStatefulPolicyOrBuilder()

public StatefulPolicyOrBuilder getStatefulPolicyOrBuilder()

Stateful configuration for this Instanced Group Manager

optional .google.cloud.compute.v1.StatefulPolicy stateful_policy = 47538565;

Returns

Type	Description
StatefulPolicyOrBuilder

getStatus()

public InstanceGroupManagerStatus getStatus()

[Output Only] The status of this managed instance group.

optional .google.cloud.compute.v1.InstanceGroupManagerStatus status = 181260274;

Returns

Type	Description
InstanceGroupManagerStatus	The status.

getStatusOrBuilder()

public InstanceGroupManagerStatusOrBuilder getStatusOrBuilder()

[Output Only] The status of this managed instance group.

optional .google.cloud.compute.v1.InstanceGroupManagerStatus status = 181260274;

Returns

Type	Description
InstanceGroupManagerStatusOrBuilder

getTargetPools(int index)

public String getTargetPools(int index)

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.

repeated string target_pools = 336072617;

Parameter

Name	Description
index	int The index of the element to return.

Returns

Type	Description
String	The targetPools at the given index.

getTargetPoolsBytes(int index)

public ByteString getTargetPoolsBytes(int index)

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.

repeated string target_pools = 336072617;

Parameter

Name	Description
index	int The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the targetPools at the given index.

getTargetPoolsCount()

public int getTargetPoolsCount()

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.

repeated string target_pools = 336072617;

Returns

Type	Description
int	The count of targetPools.

getTargetPoolsList()

public ProtocolStringList getTargetPoolsList()

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.

repeated string target_pools = 336072617;

Returns

Type	Description
ProtocolStringList	A list containing the targetPools.

getTargetSize()

public int 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.

optional int32 target_size = 62880239;

Returns

Type	Description
int	The targetSize.

getUnknownFields()

public final UnknownFieldSet getUnknownFields()

Returns

Type	Description
UnknownFieldSet

Overrides

GeneratedMessageV3.getUnknownFields()

getUpdatePolicy()

public InstanceGroupManagerUpdatePolicy getUpdatePolicy()

The update policy for this managed instance group.

optional .google.cloud.compute.v1.InstanceGroupManagerUpdatePolicy update_policy = 175809896;

Returns

Type	Description
InstanceGroupManagerUpdatePolicy	The updatePolicy.

getUpdatePolicyOrBuilder()

public InstanceGroupManagerUpdatePolicyOrBuilder getUpdatePolicyOrBuilder()

The update policy for this managed instance group.

optional .google.cloud.compute.v1.InstanceGroupManagerUpdatePolicy update_policy = 175809896;

Returns

Type	Description
InstanceGroupManagerUpdatePolicyOrBuilder

getVersions(int index)

public InstanceGroupManagerVersion getVersions(int index)

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.

repeated .google.cloud.compute.v1.InstanceGroupManagerVersion versions = 162430619;

Parameter

Name	Description
index	int

Returns

Type	Description
InstanceGroupManagerVersion

getVersionsCount()

public int getVersionsCount()

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.

repeated .google.cloud.compute.v1.InstanceGroupManagerVersion versions = 162430619;

Returns

Type	Description
int

getVersionsList()

public List<InstanceGroupManagerVersion> getVersionsList()

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.

repeated .google.cloud.compute.v1.InstanceGroupManagerVersion versions = 162430619;

Returns

Type	Description
List<InstanceGroupManagerVersion>

getVersionsOrBuilder(int index)

public InstanceGroupManagerVersionOrBuilder getVersionsOrBuilder(int index)

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.

repeated .google.cloud.compute.v1.InstanceGroupManagerVersion versions = 162430619;

Parameter

Name	Description
index	int

Returns

Type	Description
InstanceGroupManagerVersionOrBuilder

getVersionsOrBuilderList()

public List<? extends InstanceGroupManagerVersionOrBuilder> getVersionsOrBuilderList()

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.

repeated .google.cloud.compute.v1.InstanceGroupManagerVersion versions = 162430619;

Returns

Type	Description
List<? extends com.google.cloud.compute.v1.InstanceGroupManagerVersionOrBuilder>

getZone()

public String getZone()

[Output Only] The URL of a zone where the managed 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 a zone where the managed instance group is located (for zonal resources).

optional string zone = 3744684;

Returns

Type	Description
ByteString	The bytes for zone.

hasBaseInstanceName()

public boolean hasBaseInstanceName()

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.

optional string base_instance_name = 389106439;

Returns

Type	Description
boolean	Whether the baseInstanceName field is set.

hasCreationTimestamp()

public boolean hasCreationTimestamp()

[Output Only] The creation timestamp for this managed instance group in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns

Type	Description
boolean	Whether the creationTimestamp field is set.

hasCurrentActions()

public boolean hasCurrentActions()

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

optional .google.cloud.compute.v1.InstanceGroupManagerActionsSummary current_actions = 164045879;

Returns

Type	Description
boolean	Whether the currentActions field is set.

hasDescription()

public boolean hasDescription()

An optional description of this resource.

optional string description = 422937596;

Returns

Type	Description
boolean	Whether the description field is set.

hasDistributionPolicy()

public boolean hasDistributionPolicy()

Policy specifying the intended distribution of managed instances across zones in a regional managed instance group.

optional .google.cloud.compute.v1.DistributionPolicy distribution_policy = 534558541;

Returns

Type	Description
boolean	Whether the distributionPolicy field is set.

hasFingerprint()

public boolean hasFingerprint()

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.

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 resource type. The server generates this identifier.

optional uint64 id = 3355;

Returns

Type	Description
boolean	Whether the id field is set.

hasInstanceGroup()

public boolean hasInstanceGroup()

[Output Only] The URL of the Instance Group resource.

optional string instance_group = 81095253;

Returns

Type	Description
boolean	Whether the instanceGroup field is set.

hasInstanceTemplate()

public boolean hasInstanceTemplate()

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. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE.

optional string instance_template = 309248228;

Returns

Type	Description
boolean	Whether the instanceTemplate field is set.

hasKind()

public boolean hasKind()

[Output Only] The resource type, which is always compute#instanceGroupManager for managed instance groups.

optional string kind = 3292052;

Returns

Type	Description
boolean	Whether the kind field is set.

hasListManagedInstancesResults()

public boolean hasListManagedInstancesResults()

Pagination behavior of the listManagedInstances API method for this managed instance group. Check the ListManagedInstancesResults enum for the list of possible values.

optional string list_managed_instances_results = 296047156;

Returns

Type	Description
boolean	Whether the listManagedInstancesResults field is set.

hasName()

public boolean hasName()

The name of the managed 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.

hasRegion()

public boolean hasRegion()

[Output Only] The URL of the region where the managed instance group resides (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 managed instance group. The server defines this URL.

optional string self_link = 456214797;

Returns

Type	Description
boolean	Whether the selfLink field is set.

hasStatefulPolicy()

public boolean hasStatefulPolicy()

Stateful configuration for this Instanced Group Manager

optional .google.cloud.compute.v1.StatefulPolicy stateful_policy = 47538565;

Returns

Type	Description
boolean	Whether the statefulPolicy field is set.

hasStatus()

public boolean hasStatus()

[Output Only] The status of this managed instance group.

optional .google.cloud.compute.v1.InstanceGroupManagerStatus status = 181260274;

Returns

Type	Description
boolean	Whether the status field is set.

hasTargetSize()

public boolean hasTargetSize()

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.

optional int32 target_size = 62880239;

Returns

Type	Description
boolean	Whether the targetSize field is set.

hasUpdatePolicy()

public boolean hasUpdatePolicy()

The update policy for this managed instance group.

optional .google.cloud.compute.v1.InstanceGroupManagerUpdatePolicy update_policy = 175809896;

Returns

Type	Description
boolean	Whether the updatePolicy field is set.

hasZone()

public boolean hasZone()

[Output Only] The URL of a zone where the managed 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

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public InstanceGroupManager.Builder newBuilderForType()

Returns

Type	Description
InstanceGroupManager.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected InstanceGroupManager.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter

Name	Description
parent	BuilderParent

Returns

Type	Description
InstanceGroupManager.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter

Name	Description
unused	UnusedPrivateParameter

Returns

Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public InstanceGroupManager.Builder toBuilder()

Returns

Type	Description
InstanceGroupManager.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter

Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions

Type	Description
IOException