Class InstanceGroupManager.Builder (1.74.0) 

public static final class InstanceGroupManager.Builder extends GeneratedMessageV3.Builder<InstanceGroupManager.Builder> 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.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > InstanceGroupManager.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllAutoHealingPolicies(Iterable<? extends InstanceGroupManagerAutoHealingPolicy> values)

public InstanceGroupManager.Builder addAllAutoHealingPolicies(Iterable<? extends InstanceGroupManagerAutoHealingPolicy> values)

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
values Iterable<? extends com.google.cloud.compute.v1.InstanceGroupManagerAutoHealingPolicy>
Returns
Type Description
InstanceGroupManager.Builder

addAllNamedPorts(Iterable<? extends NamedPort> values)

public InstanceGroupManager.Builder addAllNamedPorts(Iterable<? extends NamedPort> values)

[Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager.

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.compute.v1.NamedPort>
Returns
Type Description
InstanceGroupManager.Builder

addAllTargetPools(Iterable<String> values)

public InstanceGroupManager.Builder addAllTargetPools(Iterable<String> values)

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
values Iterable<String>

The targetPools to add.
Returns
Type Description
InstanceGroupManager.Builder

This builder for chaining.

addAllVersions(Iterable<? extends InstanceGroupManagerVersion> values)

public InstanceGroupManager.Builder addAllVersions(Iterable<? extends InstanceGroupManagerVersion> values)

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
values Iterable<? extends com.google.cloud.compute.v1.InstanceGroupManagerVersion>
Returns
Type Description
InstanceGroupManager.Builder

addAutoHealingPolicies(InstanceGroupManagerAutoHealingPolicy value)

public InstanceGroupManager.Builder addAutoHealingPolicies(InstanceGroupManagerAutoHealingPolicy value)

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
value InstanceGroupManagerAutoHealingPolicy
Returns
Type Description
InstanceGroupManager.Builder

addAutoHealingPolicies(InstanceGroupManagerAutoHealingPolicy.Builder builderForValue)

public InstanceGroupManager.Builder addAutoHealingPolicies(InstanceGroupManagerAutoHealingPolicy.Builder builderForValue)

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
builderForValue InstanceGroupManagerAutoHealingPolicy.Builder
Returns
Type Description
InstanceGroupManager.Builder

addAutoHealingPolicies(int index, InstanceGroupManagerAutoHealingPolicy value)

public InstanceGroupManager.Builder addAutoHealingPolicies(int index, InstanceGroupManagerAutoHealingPolicy value)

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

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

Parameters
Name Description
index int
value InstanceGroupManagerAutoHealingPolicy
Returns
Type Description
InstanceGroupManager.Builder

addAutoHealingPolicies(int index, InstanceGroupManagerAutoHealingPolicy.Builder builderForValue)

public InstanceGroupManager.Builder addAutoHealingPolicies(int index, InstanceGroupManagerAutoHealingPolicy.Builder builderForValue)

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

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

Parameters
Name Description
index int
builderForValue InstanceGroupManagerAutoHealingPolicy.Builder
Returns
Type Description
InstanceGroupManager.Builder

addAutoHealingPoliciesBuilder()

public InstanceGroupManagerAutoHealingPolicy.Builder addAutoHealingPoliciesBuilder()

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
InstanceGroupManagerAutoHealingPolicy.Builder

addAutoHealingPoliciesBuilder(int index)

public InstanceGroupManagerAutoHealingPolicy.Builder addAutoHealingPoliciesBuilder(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.Builder

addNamedPorts(NamedPort value)

public InstanceGroupManager.Builder addNamedPorts(NamedPort value)

[Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager.

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

Parameter
Name Description
value NamedPort
Returns
Type Description
InstanceGroupManager.Builder

addNamedPorts(NamedPort.Builder builderForValue)

public InstanceGroupManager.Builder addNamedPorts(NamedPort.Builder builderForValue)

[Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager.

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

Parameter
Name Description
builderForValue NamedPort.Builder
Returns
Type Description
InstanceGroupManager.Builder

addNamedPorts(int index, NamedPort value)

public InstanceGroupManager.Builder addNamedPorts(int index, NamedPort value)

[Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager.

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

Parameters
Name Description
index int
value NamedPort
Returns
Type Description
InstanceGroupManager.Builder

addNamedPorts(int index, NamedPort.Builder builderForValue)

public InstanceGroupManager.Builder addNamedPorts(int index, NamedPort.Builder builderForValue)

[Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager.

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

Parameters
Name Description
index int
builderForValue NamedPort.Builder
Returns
Type Description
InstanceGroupManager.Builder

addNamedPortsBuilder()

public NamedPort.Builder addNamedPortsBuilder()

[Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager.

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

Returns
Type Description
NamedPort.Builder

addNamedPortsBuilder(int index)

public NamedPort.Builder addNamedPortsBuilder(int index)

[Output Only] Named ports configured on 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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public InstanceGroupManager.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
InstanceGroupManager.Builder
Overrides

addTargetPools(String value)

public InstanceGroupManager.Builder addTargetPools(String value)

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
value String

The targetPools to add.
Returns
Type Description
InstanceGroupManager.Builder

This builder for chaining.

addTargetPoolsBytes(ByteString value)

public InstanceGroupManager.Builder addTargetPoolsBytes(ByteString value)

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

The bytes of the targetPools to add.
Returns
Type Description
InstanceGroupManager.Builder

This builder for chaining.

addVersions(InstanceGroupManagerVersion value)

public InstanceGroupManager.Builder addVersions(InstanceGroupManagerVersion value)

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
value InstanceGroupManagerVersion
Returns
Type Description
InstanceGroupManager.Builder

addVersions(InstanceGroupManagerVersion.Builder builderForValue)

public InstanceGroupManager.Builder addVersions(InstanceGroupManagerVersion.Builder builderForValue)

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
builderForValue InstanceGroupManagerVersion.Builder
Returns
Type Description
InstanceGroupManager.Builder

addVersions(int index, InstanceGroupManagerVersion value)

public InstanceGroupManager.Builder addVersions(int index, InstanceGroupManagerVersion value)

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;

Parameters
Name Description
index int
value InstanceGroupManagerVersion
Returns
Type Description
InstanceGroupManager.Builder

addVersions(int index, InstanceGroupManagerVersion.Builder builderForValue)

public InstanceGroupManager.Builder addVersions(int index, InstanceGroupManagerVersion.Builder builderForValue)

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;

Parameters
Name Description
index int
builderForValue InstanceGroupManagerVersion.Builder
Returns
Type Description
InstanceGroupManager.Builder

addVersionsBuilder()

public InstanceGroupManagerVersion.Builder addVersionsBuilder()

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
InstanceGroupManagerVersion.Builder

addVersionsBuilder(int index)

public InstanceGroupManagerVersion.Builder addVersionsBuilder(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.Builder

build()

public InstanceGroupManager build()
Returns
Type Description
InstanceGroupManager

buildPartial()

public InstanceGroupManager buildPartial()
Returns
Type Description
InstanceGroupManager

clear()

public InstanceGroupManager.Builder clear()
Returns
Type Description
InstanceGroupManager.Builder
Overrides

clearAllInstancesConfig()

public InstanceGroupManager.Builder clearAllInstancesConfig()

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

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

Returns
Type Description
InstanceGroupManager.Builder

clearAutoHealingPolicies()

public InstanceGroupManager.Builder clearAutoHealingPolicies()

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
InstanceGroupManager.Builder

clearBaseInstanceName()

public InstanceGroupManager.Builder clearBaseInstanceName()

The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern a-z|([-a-z0-9]{0,51}-#{1,10}(\\[[0-9]{1,10}\\])?))

optional string base_instance_name = 389106439;

Returns
Type Description
InstanceGroupManager.Builder

This builder for chaining.

clearCreationTimestamp()

public InstanceGroupManager.Builder clearCreationTimestamp()

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

optional string creation_timestamp = 30525366;

Returns
Type Description
InstanceGroupManager.Builder

This builder for chaining.

clearCurrentActions()

public InstanceGroupManager.Builder clearCurrentActions()

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

clearDescription()

public InstanceGroupManager.Builder clearDescription()

An optional description of this resource.

optional string description = 422937596;

Returns
Type Description
InstanceGroupManager.Builder

This builder for chaining.

clearDistributionPolicy()

public InstanceGroupManager.Builder clearDistributionPolicy()

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
InstanceGroupManager.Builder

clearField(Descriptors.FieldDescriptor field)

public InstanceGroupManager.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
InstanceGroupManager.Builder
Overrides

clearFingerprint()

public InstanceGroupManager.Builder clearFingerprint()

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
InstanceGroupManager.Builder

This builder for chaining.

clearId()

public InstanceGroupManager.Builder clearId()

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

optional uint64 id = 3355;

Returns
Type Description
InstanceGroupManager.Builder

This builder for chaining.

clearInstanceFlexibilityPolicy()

public InstanceGroupManager.Builder clearInstanceFlexibilityPolicy()

Instance flexibility allowing MIG to create VMs from multiple types of machines. Instance flexibility configuration on MIG overrides instance template configuration.

optional .google.cloud.compute.v1.InstanceGroupManagerInstanceFlexibilityPolicy instance_flexibility_policy = 26937090;

Returns
Type Description
InstanceGroupManager.Builder

clearInstanceGroup()

public InstanceGroupManager.Builder clearInstanceGroup()

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

optional string instance_group = 81095253;

Returns
Type Description
InstanceGroupManager.Builder

This builder for chaining.

clearInstanceLifecyclePolicy()

public InstanceGroupManager.Builder clearInstanceLifecyclePolicy()

The repair policy for this managed instance group.

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

Returns
Type Description
InstanceGroupManager.Builder

clearInstanceTemplate()

public InstanceGroupManager.Builder clearInstanceTemplate()

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
InstanceGroupManager.Builder

This builder for chaining.

clearKind()

public InstanceGroupManager.Builder clearKind()

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

optional string kind = 3292052;

Returns
Type Description
InstanceGroupManager.Builder

This builder for chaining.

clearListManagedInstancesResults()

public InstanceGroupManager.Builder clearListManagedInstancesResults()

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
InstanceGroupManager.Builder

This builder for chaining.

clearName()

public InstanceGroupManager.Builder clearName()

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
InstanceGroupManager.Builder

This builder for chaining.

clearNamedPorts()

public InstanceGroupManager.Builder clearNamedPorts()

[Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager.

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

Returns
Type Description
InstanceGroupManager.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public InstanceGroupManager.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
InstanceGroupManager.Builder
Overrides

clearRegion()

public InstanceGroupManager.Builder clearRegion()

[Output Only] The URL of the region where the managed instance group resides (for regional resources).

optional string region = 138946292;

Returns
Type Description
InstanceGroupManager.Builder

This builder for chaining.

clearResourcePolicies()

public InstanceGroupManager.Builder clearResourcePolicies()

Resource policies for this managed instance group.

optional .google.cloud.compute.v1.InstanceGroupManagerResourcePolicies resource_policies = 22220385;

Returns
Type Description
InstanceGroupManager.Builder

clearSatisfiesPzi()

public InstanceGroupManager.Builder clearSatisfiesPzi()

[Output Only] Reserved for future use.

optional bool satisfies_pzi = 480964257;

Returns
Type Description
InstanceGroupManager.Builder

This builder for chaining.

clearSatisfiesPzs()

public InstanceGroupManager.Builder clearSatisfiesPzs()

[Output Only] Reserved for future use.

optional bool satisfies_pzs = 480964267;

Returns
Type Description
InstanceGroupManager.Builder

This builder for chaining.

clearSelfLink()

public InstanceGroupManager.Builder clearSelfLink()

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

optional string self_link = 456214797;

Returns
Type Description
InstanceGroupManager.Builder

This builder for chaining.

clearStandbyPolicy()

public InstanceGroupManager.Builder clearStandbyPolicy()

Standby policy for stopped and suspended instances.

optional .google.cloud.compute.v1.InstanceGroupManagerStandbyPolicy standby_policy = 499352324;

Returns
Type Description
InstanceGroupManager.Builder

clearStatefulPolicy()

public InstanceGroupManager.Builder clearStatefulPolicy()

Stateful configuration for this Instanced Group Manager

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

Returns
Type Description
InstanceGroupManager.Builder

clearStatus()

public InstanceGroupManager.Builder clearStatus()

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

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

Returns
Type Description
InstanceGroupManager.Builder

clearTargetPools()

public InstanceGroupManager.Builder clearTargetPools()

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
InstanceGroupManager.Builder

This builder for chaining.

clearTargetSize()

public InstanceGroupManager.Builder clearTargetSize()

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
InstanceGroupManager.Builder

This builder for chaining.

clearTargetStoppedSize()

public InstanceGroupManager.Builder clearTargetStoppedSize()

The target number of stopped instances for this managed instance group. This number changes when you: - Stop instance using the stopInstances method or start instances using the startInstances method. - Manually change the targetStoppedSize using the update method.

optional int32 target_stopped_size = 2419489;

Returns
Type Description
InstanceGroupManager.Builder

This builder for chaining.

clearTargetSuspendedSize()

public InstanceGroupManager.Builder clearTargetSuspendedSize()

The target number of suspended instances for this managed instance group. This number changes when you: - Suspend instance using the suspendInstances method or resume instances using the resumeInstances method. - Manually change the targetSuspendedSize using the update method.

optional int32 target_suspended_size = 308085843;

Returns
Type Description
InstanceGroupManager.Builder

This builder for chaining.

clearUpdatePolicy()

public InstanceGroupManager.Builder clearUpdatePolicy()

The update policy for this managed instance group.

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

Returns
Type Description
InstanceGroupManager.Builder

clearVersions()

public InstanceGroupManager.Builder clearVersions()

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
InstanceGroupManager.Builder

clearZone()

public InstanceGroupManager.Builder clearZone()

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

optional string zone = 3744684;

Returns
Type Description
InstanceGroupManager.Builder

This builder for chaining.

clone()

public InstanceGroupManager.Builder clone()
Returns
Type Description
InstanceGroupManager.Builder
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
Type Description
InstanceGroupManagerAllInstancesConfig

The allInstancesConfig.

getAllInstancesConfigBuilder()

public InstanceGroupManagerAllInstancesConfig.Builder getAllInstancesConfigBuilder()

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

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

Returns
Type Description
InstanceGroupManagerAllInstancesConfig.Builder

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
Type Description
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
Name Description
index int
Returns
Type Description
InstanceGroupManagerAutoHealingPolicy

getAutoHealingPoliciesBuilder(int index)

public InstanceGroupManagerAutoHealingPolicy.Builder getAutoHealingPoliciesBuilder(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.Builder

getAutoHealingPoliciesBuilderList()

public List<InstanceGroupManagerAutoHealingPolicy.Builder> getAutoHealingPoliciesBuilderList()

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<Builder>

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 is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern a-z|([-a-z0-9]{0,51}-#{1,10}(\\[[0-9]{1,10}\\])?))

optional string base_instance_name = 389106439;

Returns
Type Description
String

The baseInstanceName.

getBaseInstanceNameBytes()

public ByteString getBaseInstanceNameBytes()

The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern a-z|([-a-z0-9]{0,51}-#{1,10}(\\[[0-9]{1,10}\\])?))

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.

getCurrentActionsBuilder()

public InstanceGroupManagerActionsSummary.Builder getCurrentActionsBuilder()

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

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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

getDistributionPolicyBuilder()

public DistributionPolicy.Builder getDistributionPolicyBuilder()

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

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.

getInstanceFlexibilityPolicy()

public InstanceGroupManagerInstanceFlexibilityPolicy getInstanceFlexibilityPolicy()

Instance flexibility allowing MIG to create VMs from multiple types of machines. Instance flexibility configuration on MIG overrides instance template configuration.

optional .google.cloud.compute.v1.InstanceGroupManagerInstanceFlexibilityPolicy instance_flexibility_policy = 26937090;

Returns
Type Description
InstanceGroupManagerInstanceFlexibilityPolicy

The instanceFlexibilityPolicy.

getInstanceFlexibilityPolicyBuilder()

public InstanceGroupManagerInstanceFlexibilityPolicy.Builder getInstanceFlexibilityPolicyBuilder()

Instance flexibility allowing MIG to create VMs from multiple types of machines. Instance flexibility configuration on MIG overrides instance template configuration.

optional .google.cloud.compute.v1.InstanceGroupManagerInstanceFlexibilityPolicy instance_flexibility_policy = 26937090;

Returns
Type Description
InstanceGroupManagerInstanceFlexibilityPolicy.Builder

getInstanceFlexibilityPolicyOrBuilder()

public InstanceGroupManagerInstanceFlexibilityPolicyOrBuilder getInstanceFlexibilityPolicyOrBuilder()

Instance flexibility allowing MIG to create VMs from multiple types of machines. Instance flexibility configuration on MIG overrides instance template configuration.

optional .google.cloud.compute.v1.InstanceGroupManagerInstanceFlexibilityPolicy instance_flexibility_policy = 26937090;

Returns
Type Description
InstanceGroupManagerInstanceFlexibilityPolicyOrBuilder

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.

getInstanceLifecyclePolicy()

public InstanceGroupManagerInstanceLifecyclePolicy getInstanceLifecyclePolicy()

The repair policy for this managed instance group.

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

Returns
Type Description
InstanceGroupManagerInstanceLifecyclePolicy

The instanceLifecyclePolicy.

getInstanceLifecyclePolicyBuilder()

public InstanceGroupManagerInstanceLifecyclePolicy.Builder getInstanceLifecyclePolicyBuilder()

The repair policy for this managed instance group.

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

Returns
Type Description
InstanceGroupManagerInstanceLifecyclePolicy.Builder

getInstanceLifecyclePolicyOrBuilder()

public InstanceGroupManagerInstanceLifecyclePolicyOrBuilder getInstanceLifecyclePolicyOrBuilder()

The repair policy for this managed instance group.

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

Returns
Type Description
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
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)

[Output Only] Named ports configured on 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

getNamedPortsBuilder(int index)

public NamedPort.Builder getNamedPortsBuilder(int index)

[Output Only] Named ports configured on 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.Builder

getNamedPortsBuilderList()

public List<NamedPort.Builder> getNamedPortsBuilderList()

[Output Only] Named ports configured on the Instance Groups complementary to this Instance Group Manager.

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

Returns
Type Description
List<Builder>

getNamedPortsCount()

public int getNamedPortsCount()

[Output Only] Named ports configured on 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()

[Output Only] Named ports configured on 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)

[Output Only] Named ports configured on 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()

[Output Only] Named ports configured on 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>

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.

getResourcePolicies()

public InstanceGroupManagerResourcePolicies getResourcePolicies()

Resource policies for this managed instance group.

optional .google.cloud.compute.v1.InstanceGroupManagerResourcePolicies resource_policies = 22220385;

Returns
Type Description
InstanceGroupManagerResourcePolicies

The resourcePolicies.

getResourcePoliciesBuilder()

public InstanceGroupManagerResourcePolicies.Builder getResourcePoliciesBuilder()

Resource policies for this managed instance group.

optional .google.cloud.compute.v1.InstanceGroupManagerResourcePolicies resource_policies = 22220385;

Returns
Type Description
InstanceGroupManagerResourcePolicies.Builder

getResourcePoliciesOrBuilder()

public InstanceGroupManagerResourcePoliciesOrBuilder getResourcePoliciesOrBuilder()

Resource policies for this managed instance group.

optional .google.cloud.compute.v1.InstanceGroupManagerResourcePolicies resource_policies = 22220385;

Returns
Type Description
InstanceGroupManagerResourcePoliciesOrBuilder

getSatisfiesPzi()

public boolean getSatisfiesPzi()

[Output Only] Reserved for future use.

optional bool satisfies_pzi = 480964257;

Returns
Type Description
boolean

The satisfiesPzi.

getSatisfiesPzs()

public boolean getSatisfiesPzs()

[Output Only] Reserved for future use.

optional bool satisfies_pzs = 480964267;

Returns
Type Description
boolean

The satisfiesPzs.

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.

getStandbyPolicy()

public InstanceGroupManagerStandbyPolicy getStandbyPolicy()

Standby policy for stopped and suspended instances.

optional .google.cloud.compute.v1.InstanceGroupManagerStandbyPolicy standby_policy = 499352324;

Returns
Type Description
InstanceGroupManagerStandbyPolicy

The standbyPolicy.

getStandbyPolicyBuilder()

public InstanceGroupManagerStandbyPolicy.Builder getStandbyPolicyBuilder()

Standby policy for stopped and suspended instances.

optional .google.cloud.compute.v1.InstanceGroupManagerStandbyPolicy standby_policy = 499352324;

Returns
Type Description
InstanceGroupManagerStandbyPolicy.Builder

getStandbyPolicyOrBuilder()

public InstanceGroupManagerStandbyPolicyOrBuilder getStandbyPolicyOrBuilder()

Standby policy for stopped and suspended instances.

optional .google.cloud.compute.v1.InstanceGroupManagerStandbyPolicy standby_policy = 499352324;

Returns
Type Description
InstanceGroupManagerStandbyPolicyOrBuilder

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.

getStatefulPolicyBuilder()

public StatefulPolicy.Builder getStatefulPolicyBuilder()

Stateful configuration for this Instanced Group Manager

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

Returns
Type Description
StatefulPolicy.Builder

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.

getStatusBuilder()

public InstanceGroupManagerStatus.Builder getStatusBuilder()

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

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

Returns
Type Description
InstanceGroupManagerStatus.Builder

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()