Class InstanceGroupManager (1.47.0)

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

Static Fields

ALL_INSTANCES_CONFIG_FIELD_NUMBER

public static final int ALL_INSTANCES_CONFIG_FIELD_NUMBER
Field Value
TypeDescription
int

AUTO_HEALING_POLICIES_FIELD_NUMBER

public static final int AUTO_HEALING_POLICIES_FIELD_NUMBER
Field Value
TypeDescription
int

BASE_INSTANCE_NAME_FIELD_NUMBER

public static final int BASE_INSTANCE_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

CREATION_TIMESTAMP_FIELD_NUMBER

public static final int CREATION_TIMESTAMP_FIELD_NUMBER
Field Value
TypeDescription
int

CURRENT_ACTIONS_FIELD_NUMBER

public static final int CURRENT_ACTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
TypeDescription
int

DISTRIBUTION_POLICY_FIELD_NUMBER

public static final int DISTRIBUTION_POLICY_FIELD_NUMBER
Field Value
TypeDescription
int

FINGERPRINT_FIELD_NUMBER

public static final int FINGERPRINT_FIELD_NUMBER
Field Value
TypeDescription
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
TypeDescription
int

INSTANCE_GROUP_FIELD_NUMBER

public static final int INSTANCE_GROUP_FIELD_NUMBER
Field Value
TypeDescription
int

INSTANCE_LIFECYCLE_POLICY_FIELD_NUMBER

public static final int INSTANCE_LIFECYCLE_POLICY_FIELD_NUMBER
Field Value
TypeDescription
int

INSTANCE_TEMPLATE_FIELD_NUMBER

public static final int INSTANCE_TEMPLATE_FIELD_NUMBER
Field Value
TypeDescription
int

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER
Field Value
TypeDescription
int

LIST_MANAGED_INSTANCES_RESULTS_FIELD_NUMBER

public static final int LIST_MANAGED_INSTANCES_RESULTS_FIELD_NUMBER
Field Value
TypeDescription
int

NAMED_PORTS_FIELD_NUMBER

public static final int NAMED_PORTS_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

REGION_FIELD_NUMBER

public static final int REGION_FIELD_NUMBER
Field Value
TypeDescription
int
public static final int SELF_LINK_FIELD_NUMBER
Field Value
TypeDescription
int

STATEFUL_POLICY_FIELD_NUMBER

public static final int STATEFUL_POLICY_FIELD_NUMBER
Field Value
TypeDescription
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
TypeDescription
int

TARGET_POOLS_FIELD_NUMBER

public static final int TARGET_POOLS_FIELD_NUMBER
Field Value
TypeDescription
int

TARGET_SIZE_FIELD_NUMBER

public static final int TARGET_SIZE_FIELD_NUMBER
Field Value
TypeDescription
int

UPDATE_POLICY_FIELD_NUMBER

public static final int UPDATE_POLICY_FIELD_NUMBER
Field Value
TypeDescription
int

VERSIONS_FIELD_NUMBER

public static final int VERSIONS_FIELD_NUMBER
Field Value
TypeDescription
int

ZONE_FIELD_NUMBER

public static final int ZONE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static InstanceGroupManager getDefaultInstance()
Returns
TypeDescription
InstanceGroupManager

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static InstanceGroupManager.Builder newBuilder()
Returns
TypeDescription
InstanceGroupManager.Builder

newBuilder(InstanceGroupManager prototype)

public static InstanceGroupManager.Builder newBuilder(InstanceGroupManager prototype)
Parameter
NameDescription
prototypeInstanceGroupManager
Returns
TypeDescription
InstanceGroupManager.Builder

parseDelimitedFrom(InputStream input)

public static InstanceGroupManager parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
InstanceGroupManager
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static InstanceGroupManager parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InstanceGroupManager
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static InstanceGroupManager parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
InstanceGroupManager
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static InstanceGroupManager parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InstanceGroupManager
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static InstanceGroupManager parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
InstanceGroupManager
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static InstanceGroupManager parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InstanceGroupManager
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static InstanceGroupManager parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
InstanceGroupManager
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static InstanceGroupManager parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InstanceGroupManager
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static InstanceGroupManager parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
InstanceGroupManager
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static InstanceGroupManager parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InstanceGroupManager
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static InstanceGroupManager parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
InstanceGroupManager
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static InstanceGroupManager parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
InstanceGroupManager
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<InstanceGroupManager> parser()
Returns
TypeDescription
Parser<InstanceGroupManager>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAllInstancesConfig()

public InstanceGroupManagerAllInstancesConfig getAllInstancesConfig()

Specifies configuration that overrides the instance template configuration for the group.

optional .google.cloud.compute.v1.InstanceGroupManagerAllInstancesConfig all_instances_config = 112596737;

Returns
TypeDescription
InstanceGroupManagerAllInstancesConfig

The allInstancesConfig.

getAllInstancesConfigOrBuilder()

public InstanceGroupManagerAllInstancesConfigOrBuilder getAllInstancesConfigOrBuilder()

Specifies configuration that overrides the instance template configuration for the group.

optional .google.cloud.compute.v1.InstanceGroupManagerAllInstancesConfig all_instances_config = 112596737;

Returns
TypeDescription
InstanceGroupManagerAllInstancesConfigOrBuilder

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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
InstanceGroupManagerActionsSummaryOrBuilder

getDefaultInstanceForType()

public InstanceGroupManager getDefaultInstanceForType()
Returns
TypeDescription
InstanceGroupManager

getDescription()

public String getDescription()

An optional description of this resource.

optional string description = 422937596;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

An optional description of this resource.

optional string description = 422937596;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
long

The id.

getInstanceGroup()

public String getInstanceGroup()

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

optional string instance_group = 81095253;

Returns
TypeDescription
String

The instanceGroup.

getInstanceGroupBytes()

public ByteString getInstanceGroupBytes()

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

optional string instance_group = 81095253;

Returns
TypeDescription
ByteString

The bytes for instanceGroup.

getInstanceLifecyclePolicy()

public InstanceGroupManagerInstanceLifecyclePolicy getInstanceLifecyclePolicy()

The repair policy for this managed instance group.

optional .google.cloud.compute.v1.InstanceGroupManagerInstanceLifecyclePolicy instance_lifecycle_policy = 447961617;

Returns
TypeDescription
InstanceGroupManagerInstanceLifecyclePolicy

The instanceLifecyclePolicy.

getInstanceLifecyclePolicyOrBuilder()

public InstanceGroupManagerInstanceLifecyclePolicyOrBuilder getInstanceLifecyclePolicyOrBuilder()

The repair policy for this managed instance group.

optional .google.cloud.compute.v1.InstanceGroupManagerInstanceLifecyclePolicy instance_lifecycle_policy = 447961617;

Returns
TypeDescription
InstanceGroupManagerInstanceLifecyclePolicyOrBuilder

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
List<? extends com.google.cloud.compute.v1.NamedPortOrBuilder>

getParserForType()

public Parser<InstanceGroupManager> getParserForType()
Returns
TypeDescription
Parser<InstanceGroupManager>
Overrides

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
TypeDescription
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
TypeDescription
ByteString

The bytes for region.

public String getSelfLink()

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

optional string self_link = 456214797;

Returns
TypeDescription
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
TypeDescription
ByteString

The bytes for selfLink.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getStatefulPolicy()

public StatefulPolicy getStatefulPolicy()

Stateful configuration for this Instanced Group Manager

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

Returns
TypeDescription
StatefulPolicy

The statefulPolicy.

getStatefulPolicyOrBuilder()

public StatefulPolicyOrBuilder getStatefulPolicyOrBuilder()

Stateful configuration for this Instanced Group Manager

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

Returns
TypeDescription
StatefulPolicyOrBuilder

getStatus()

public InstanceGroupManagerStatus getStatus()

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

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

Returns
TypeDescription
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
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
int

The targetSize.

getUpdatePolicy()

public InstanceGroupManagerUpdatePolicy getUpdatePolicy()

The update policy for this managed instance group.

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

Returns
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for zone.

hasAllInstancesConfig()

public boolean hasAllInstancesConfig()

Specifies configuration that overrides the instance template configuration for the group.

optional .google.cloud.compute.v1.InstanceGroupManagerAllInstancesConfig all_instances_config = 112596737;

Returns
TypeDescription
boolean

Whether the allInstancesConfig field is set.

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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the currentActions field is set.

hasDescription()

public boolean hasDescription()

An optional description of this resource.

optional string description = 422937596;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the instanceGroup field is set.

hasInstanceLifecyclePolicy()

public boolean hasInstanceLifecyclePolicy()

The repair policy for this managed instance group.

optional .google.cloud.compute.v1.InstanceGroupManagerInstanceLifecyclePolicy instance_lifecycle_policy = 447961617;

Returns
TypeDescription
boolean

Whether the instanceLifecyclePolicy 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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the region field is set.

public boolean hasSelfLink()

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

optional string self_link = 456214797;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the zone field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public InstanceGroupManager.Builder newBuilderForType()
Returns
TypeDescription
InstanceGroupManager.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected InstanceGroupManager.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
InstanceGroupManager.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public InstanceGroupManager.Builder toBuilder()
Returns
TypeDescription
InstanceGroupManager.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException