Compute Engine v1 API - Class InstanceGroups.InstanceGroupsBase (2.15.0)

Version 2.15.0

• 2.17.0 (latest)
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

[BindServiceMethod(typeof(InstanceGroups), "BindService")]
public abstract class InstanceGroups.InstanceGroupsBase

Reference documentation and code samples for the Compute Engine v1 API class InstanceGroups.InstanceGroupsBase.

Base class for server-side implementations of InstanceGroups

Inheritance

object > InstanceGroups.InstanceGroupsBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Methods

AddInstances(AddInstancesInstanceGroupRequest, ServerCallContext)

public virtual Task<Operation> AddInstances(AddInstancesInstanceGroupRequest request, ServerCallContext context)

Adds a list of instances to the specified instance group. All of the instances in the instance group must be in the same network/subnetwork. Read Adding instances for more information.

Parameters
Name	Description
request	AddInstancesInstanceGroupRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

AggregatedList(AggregatedListInstanceGroupsRequest, ServerCallContext)

public virtual Task<InstanceGroupAggregatedList> AggregatedList(AggregatedListInstanceGroupsRequest request, ServerCallContext context)

Retrieves the list of instance groups and sorts them by zone. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

Parameters
Name	Description
request	AggregatedListInstanceGroupsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskInstanceGroupAggregatedList	The response to send back to the client (wrapped by a task).

Delete(DeleteInstanceGroupRequest, ServerCallContext)

public virtual Task<Operation> Delete(DeleteInstanceGroupRequest request, ServerCallContext context)

Deletes the specified instance group. The instances in the group are not deleted. Note that instance group must not belong to a backend service. Read Deleting an instance group for more information.

Parameters
Name	Description
request	DeleteInstanceGroupRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

Get(GetInstanceGroupRequest, ServerCallContext)

public virtual Task<InstanceGroup> Get(GetInstanceGroupRequest request, ServerCallContext context)

Returns the specified zonal instance group. Get a list of available zonal instance groups by making a list() request. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.

Parameters
Name	Description
request	GetInstanceGroupRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskInstanceGroup	The response to send back to the client (wrapped by a task).

Insert(InsertInstanceGroupRequest, ServerCallContext)

public virtual Task<Operation> Insert(InsertInstanceGroupRequest request, ServerCallContext context)

Creates an instance group in the specified project using the parameters that are included in the request.

Parameters
Name	Description
request	InsertInstanceGroupRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

List(ListInstanceGroupsRequest, ServerCallContext)

public virtual Task<InstanceGroupList> List(ListInstanceGroupsRequest request, ServerCallContext context)

Retrieves the list of zonal instance group resources contained within the specified zone. For managed instance groups, use the instanceGroupManagers or regionInstanceGroupManagers methods instead.

Parameters
Name	Description
request	ListInstanceGroupsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskInstanceGroupList	The response to send back to the client (wrapped by a task).

ListInstances(ListInstancesInstanceGroupsRequest, ServerCallContext)

public virtual Task<InstanceGroupsListInstances> ListInstances(ListInstancesInstanceGroupsRequest request, ServerCallContext context)

Lists the instances in the specified instance group. The orderBy query parameter is not supported. The filter query parameter is supported, but only for expressions that use eq (equal) or ne (not equal) operators.

Parameters
Name	Description
request	ListInstancesInstanceGroupsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskInstanceGroupsListInstances	The response to send back to the client (wrapped by a task).

RemoveInstances(RemoveInstancesInstanceGroupRequest, ServerCallContext)

public virtual Task<Operation> RemoveInstances(RemoveInstancesInstanceGroupRequest request, ServerCallContext context)

Removes one or more instances from the specified instance group, but does not delete those instances. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration before the VM instance is removed or deleted.

Parameters
Name	Description
request	RemoveInstancesInstanceGroupRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

SetNamedPorts(SetNamedPortsInstanceGroupRequest, ServerCallContext)

public virtual Task<Operation> SetNamedPorts(SetNamedPortsInstanceGroupRequest request, ServerCallContext context)

Sets the named ports for the specified instance group.

Parameters
Name	Description
request	SetNamedPortsInstanceGroupRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).