Interface InstanceGroupManagerOrBuilder (1.21.0)

Version 1.21.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 interface InstanceGroupManagerOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAutoHealingPolicies(int index)

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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

getDescription()

public abstract String getDescription()

An optional description of this resource.

optional string description = 422937596;

Returns

Type	Description
String	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

An optional description of this resource.

optional string description = 422937596;

Returns

Type	Description
ByteString	The bytes for description.

getDistributionPolicy()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract String getInstanceGroup()

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

optional string instance_group = 81095253;

Returns

Type	Description
String	The instanceGroup.

getInstanceGroupBytes()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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>

getRegion()

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

getStatefulPolicy()

public abstract 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 abstract StatefulPolicyOrBuilder getStatefulPolicyOrBuilder()

Stateful configuration for this Instanced Group Manager

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

Returns

Type	Description
StatefulPolicyOrBuilder

getStatus()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract List<String> 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
List<String>	A list containing the targetPools.

getTargetSize()

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

getUpdatePolicy()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract boolean hasDescription()

An optional description of this resource.

optional string description = 422937596;

Returns

Type	Description
boolean	Whether the description field is set.

hasDistributionPolicy()

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