Compute Engine v1 API - Class InstanceGroupsClientImpl (3.1.0)

public sealed class InstanceGroupsClientImpl : InstanceGroupsClient

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

InstanceGroups client wrapper implementation, for convenient use.

Inheritance

object > InstanceGroupsClient > InstanceGroupsClientImpl

Inherited Members

InstanceGroupsClient.DefaultEndpoint

InstanceGroupsClient.DefaultScopes

InstanceGroupsClient.ServiceMetadata

InstanceGroupsClient.CreateAsync(CancellationToken)

InstanceGroupsClient.Create()

InstanceGroupsClient.ShutdownDefaultChannelsAsync()

InstanceGroupsClient.AddInstancesAsync(AddInstancesInstanceGroupRequest, CancellationToken)

InstanceGroupsClient.PollOnceAddInstances(string, CallSettings)

InstanceGroupsClient.PollOnceAddInstancesAsync(string, CallSettings)

InstanceGroupsClient.AddInstances(string, string, string, InstanceGroupsAddInstancesRequest, CallSettings)

InstanceGroupsClient.AddInstancesAsync(string, string, string, InstanceGroupsAddInstancesRequest, CallSettings)

InstanceGroupsClient.AddInstancesAsync(string, string, string, InstanceGroupsAddInstancesRequest, CancellationToken)

InstanceGroupsClient.AggregatedList(string, string, int?, CallSettings)

InstanceGroupsClient.AggregatedListAsync(string, string, int?, CallSettings)

InstanceGroupsClient.DeleteAsync(DeleteInstanceGroupRequest, CancellationToken)

InstanceGroupsClient.PollOnceDelete(string, CallSettings)

InstanceGroupsClient.PollOnceDeleteAsync(string, CallSettings)

InstanceGroupsClient.Delete(string, string, string, CallSettings)

InstanceGroupsClient.DeleteAsync(string, string, string, CallSettings)

InstanceGroupsClient.DeleteAsync(string, string, string, CancellationToken)

InstanceGroupsClient.GetAsync(GetInstanceGroupRequest, CancellationToken)

InstanceGroupsClient.Get(string, string, string, CallSettings)

InstanceGroupsClient.GetAsync(string, string, string, CallSettings)

InstanceGroupsClient.GetAsync(string, string, string, CancellationToken)

InstanceGroupsClient.InsertAsync(InsertInstanceGroupRequest, CancellationToken)

InstanceGroupsClient.PollOnceInsert(string, CallSettings)

InstanceGroupsClient.PollOnceInsertAsync(string, CallSettings)

InstanceGroupsClient.Insert(string, string, InstanceGroup, CallSettings)

InstanceGroupsClient.InsertAsync(string, string, InstanceGroup, CallSettings)

InstanceGroupsClient.InsertAsync(string, string, InstanceGroup, CancellationToken)

InstanceGroupsClient.List(string, string, string, int?, CallSettings)

InstanceGroupsClient.ListAsync(string, string, string, int?, CallSettings)

InstanceGroupsClient.ListInstances(string, string, string, InstanceGroupsListInstancesRequest, string, int?, CallSettings)

InstanceGroupsClient.ListInstancesAsync(string, string, string, InstanceGroupsListInstancesRequest, string, int?, CallSettings)

InstanceGroupsClient.RemoveInstancesAsync(RemoveInstancesInstanceGroupRequest, CancellationToken)

InstanceGroupsClient.PollOnceRemoveInstances(string, CallSettings)

InstanceGroupsClient.PollOnceRemoveInstancesAsync(string, CallSettings)

InstanceGroupsClient.RemoveInstances(string, string, string, InstanceGroupsRemoveInstancesRequest, CallSettings)

InstanceGroupsClient.RemoveInstancesAsync(string, string, string, InstanceGroupsRemoveInstancesRequest, CallSettings)

InstanceGroupsClient.RemoveInstancesAsync(string, string, string, InstanceGroupsRemoveInstancesRequest, CancellationToken)

InstanceGroupsClient.SetNamedPortsAsync(SetNamedPortsInstanceGroupRequest, CancellationToken)

InstanceGroupsClient.PollOnceSetNamedPorts(string, CallSettings)

InstanceGroupsClient.PollOnceSetNamedPortsAsync(string, CallSettings)

InstanceGroupsClient.SetNamedPorts(string, string, string, InstanceGroupsSetNamedPortsRequest, CallSettings)

InstanceGroupsClient.SetNamedPortsAsync(string, string, string, InstanceGroupsSetNamedPortsRequest, CallSettings)

InstanceGroupsClient.SetNamedPortsAsync(string, string, string, InstanceGroupsSetNamedPortsRequest, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Remarks

The InstanceGroups API.

Constructors

InstanceGroupsClientImpl(InstanceGroupsClient, InstanceGroupsSettings, ILogger)

public InstanceGroupsClientImpl(InstanceGroups.InstanceGroupsClient grpcClient, InstanceGroupsSettings settings, ILogger logger)

Constructs a client wrapper for the InstanceGroups service, with the specified gRPC client and settings.

Parameters
Name	Description
`grpcClient`	`InstanceGroupsInstanceGroupsClient` The underlying gRPC client.
`settings`	`InstanceGroupsSettings` The base InstanceGroupsSettings used within this client.
`logger`	`ILogger` Optional ILogger to use within this client.

Properties

AddInstancesOperationsClient

public override OperationsClient AddInstancesOperationsClient { get; }

The long-running operations client for AddInstances.

Property Value
Type	Description
`OperationsClient`

Overrides

InstanceGroupsClient.AddInstancesOperationsClient

DeleteOperationsClient

public override OperationsClient DeleteOperationsClient { get; }

The long-running operations client for Delete.

Property Value
Type	Description
`OperationsClient`

Overrides

InstanceGroupsClient.DeleteOperationsClient

GrpcClient

public override InstanceGroups.InstanceGroupsClient GrpcClient { get; }

The underlying gRPC InstanceGroups client

Property Value
Type	Description
`InstanceGroupsInstanceGroupsClient`

Overrides

InstanceGroupsClient.GrpcClient

InsertOperationsClient

public override OperationsClient InsertOperationsClient { get; }

The long-running operations client for Insert.

Property Value
Type	Description
`OperationsClient`

Overrides

InstanceGroupsClient.InsertOperationsClient

RemoveInstancesOperationsClient

public override OperationsClient RemoveInstancesOperationsClient { get; }

The long-running operations client for RemoveInstances.

Property Value
Type	Description
`OperationsClient`

Overrides

InstanceGroupsClient.RemoveInstancesOperationsClient

SetNamedPortsOperationsClient

public override OperationsClient SetNamedPortsOperationsClient { get; }

The long-running operations client for SetNamedPorts.

Property Value
Type	Description
`OperationsClient`

Overrides

InstanceGroupsClient.SetNamedPortsOperationsClient

Methods

AddInstances(AddInstancesInstanceGroupRequest, CallSettings)

public override Operation<Operation, Operation> AddInstances(AddInstancesInstanceGroupRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationOperationOperation`	The RPC response.

Overrides

InstanceGroupsClient.AddInstances(AddInstancesInstanceGroupRequest, CallSettings)

AddInstancesAsync(AddInstancesInstanceGroupRequest, CallSettings)

public override Task<Operation<Operation, Operation>> AddInstancesAsync(AddInstancesInstanceGroupRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskOperationOperationOperation`	A Task containing the RPC response.

Overrides

InstanceGroupsClient.AddInstancesAsync(AddInstancesInstanceGroupRequest, CallSettings)

AggregatedList(AggregatedListInstanceGroupsRequest, CallSettings)

public override PagedEnumerable<InstanceGroupAggregatedList, KeyValuePair<string, InstanceGroupsScopedList>> AggregatedList(AggregatedListInstanceGroupsRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerableInstanceGroupAggregatedListKeyValuePairstringInstanceGroupsScopedList`	A pageable sequence of KeyValuePair<TKey, TValue> resources.

Overrides

InstanceGroupsClient.AggregatedList(AggregatedListInstanceGroupsRequest, CallSettings)

AggregatedListAsync(AggregatedListInstanceGroupsRequest, CallSettings)

public override PagedAsyncEnumerable<InstanceGroupAggregatedList, KeyValuePair<string, InstanceGroupsScopedList>> AggregatedListAsync(AggregatedListInstanceGroupsRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerableInstanceGroupAggregatedListKeyValuePairstringInstanceGroupsScopedList`	A pageable asynchronous sequence of KeyValuePair<TKey, TValue> resources.

Overrides

InstanceGroupsClient.AggregatedListAsync(AggregatedListInstanceGroupsRequest, CallSettings)

Delete(DeleteInstanceGroupRequest, CallSettings)

public override Operation<Operation, Operation> Delete(DeleteInstanceGroupRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationOperationOperation`	The RPC response.

Overrides

InstanceGroupsClient.Delete(DeleteInstanceGroupRequest, CallSettings)

DeleteAsync(DeleteInstanceGroupRequest, CallSettings)

public override Task<Operation<Operation, Operation>> DeleteAsync(DeleteInstanceGroupRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskOperationOperationOperation`	A Task containing the RPC response.

Overrides

InstanceGroupsClient.DeleteAsync(DeleteInstanceGroupRequest, CallSettings)

Get(GetInstanceGroupRequest, CallSettings)

public override InstanceGroup Get(GetInstanceGroupRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`InstanceGroup`	The RPC response.

Overrides

InstanceGroupsClient.Get(GetInstanceGroupRequest, CallSettings)

GetAsync(GetInstanceGroupRequest, CallSettings)

public override Task<InstanceGroup> GetAsync(GetInstanceGroupRequest request, CallSettings callSettings = null)

Parameters
Name	Description
`request`	`GetInstanceGroupRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskInstanceGroup`	A Task containing the RPC response.

Overrides

InstanceGroupsClient.GetAsync(GetInstanceGroupRequest, CallSettings)

Insert(InsertInstanceGroupRequest, CallSettings)

public override Operation<Operation, Operation> Insert(InsertInstanceGroupRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
`request`	`InsertInstanceGroupRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationOperationOperation`	The RPC response.

Overrides

InstanceGroupsClient.Insert(InsertInstanceGroupRequest, CallSettings)

InsertAsync(InsertInstanceGroupRequest, CallSettings)

public override Task<Operation<Operation, Operation>> InsertAsync(InsertInstanceGroupRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
`request`	`InsertInstanceGroupRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskOperationOperationOperation`	A Task containing the RPC response.

Overrides

InstanceGroupsClient.InsertAsync(InsertInstanceGroupRequest, CallSettings)

List(ListInstanceGroupsRequest, CallSettings)

public override PagedEnumerable<InstanceGroupList, InstanceGroup> List(ListInstanceGroupsRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerableInstanceGroupListInstanceGroup`	A pageable sequence of InstanceGroup resources.

Overrides

InstanceGroupsClient.List(ListInstanceGroupsRequest, CallSettings)

ListAsync(ListInstanceGroupsRequest, CallSettings)

public override PagedAsyncEnumerable<InstanceGroupList, InstanceGroup> ListAsync(ListInstanceGroupsRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerableInstanceGroupListInstanceGroup`	A pageable asynchronous sequence of InstanceGroup resources.

Overrides

InstanceGroupsClient.ListAsync(ListInstanceGroupsRequest, CallSettings)

ListInstances(ListInstancesInstanceGroupsRequest, CallSettings)

public override PagedEnumerable<InstanceGroupsListInstances, InstanceWithNamedPorts> ListInstances(ListInstancesInstanceGroupsRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerableInstanceGroupsListInstancesInstanceWithNamedPorts`	A pageable sequence of InstanceWithNamedPorts resources.

Overrides

InstanceGroupsClient.ListInstances(ListInstancesInstanceGroupsRequest, CallSettings)

ListInstancesAsync(ListInstancesInstanceGroupsRequest, CallSettings)

public override PagedAsyncEnumerable<InstanceGroupsListInstances, InstanceWithNamedPorts> ListInstancesAsync(ListInstancesInstanceGroupsRequest request, CallSettings callSettings = null)

Parameters
Name	Description
`request`	`ListInstancesInstanceGroupsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerableInstanceGroupsListInstancesInstanceWithNamedPorts`	A pageable asynchronous sequence of InstanceWithNamedPorts resources.

Overrides

InstanceGroupsClient.ListInstancesAsync(ListInstancesInstanceGroupsRequest, CallSettings)

RemoveInstances(RemoveInstancesInstanceGroupRequest, CallSettings)

public override Operation<Operation, Operation> RemoveInstances(RemoveInstancesInstanceGroupRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationOperationOperation`	The RPC response.

Overrides

InstanceGroupsClient.RemoveInstances(RemoveInstancesInstanceGroupRequest, CallSettings)

RemoveInstancesAsync(RemoveInstancesInstanceGroupRequest, CallSettings)

public override Task<Operation<Operation, Operation>> RemoveInstancesAsync(RemoveInstancesInstanceGroupRequest request, CallSettings callSettings = null)

Parameters
Name	Description
`request`	`RemoveInstancesInstanceGroupRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskOperationOperationOperation`	A Task containing the RPC response.

Overrides

InstanceGroupsClient.RemoveInstancesAsync(RemoveInstancesInstanceGroupRequest, CallSettings)

SetNamedPorts(SetNamedPortsInstanceGroupRequest, CallSettings)

public override Operation<Operation, Operation> SetNamedPorts(SetNamedPortsInstanceGroupRequest request, CallSettings callSettings = null)

Sets the named ports for the specified instance group.

Parameters
Name	Description
`request`	`SetNamedPortsInstanceGroupRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`OperationOperationOperation`	The RPC response.

Overrides

InstanceGroupsClient.SetNamedPorts(SetNamedPortsInstanceGroupRequest, CallSettings)

SetNamedPortsAsync(SetNamedPortsInstanceGroupRequest, CallSettings)

public override Task<Operation<Operation, Operation>> SetNamedPortsAsync(SetNamedPortsInstanceGroupRequest request, CallSettings callSettings = null)

Sets the named ports for the specified instance group.

Parameters
Name	Description
`request`	`SetNamedPortsInstanceGroupRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`TaskOperationOperationOperation`	A Task containing the RPC response.

Overrides

InstanceGroupsClient.SetNamedPortsAsync(SetNamedPortsInstanceGroupRequest, CallSettings)